CheckID
CustomersPartners
VIEN
Contact
Home/Developers/API Explorer
DEVELOPERS · CHECKID

API Explorer — OpenAPI/Swagger-grade offline workbench

Developer Console for OAuth2, Subjects, Processes, Identification Groups and transaction tracing; deterministic offline fixtures send no production requests.

Quick startRequest sandbox
DEVELOPER CONSOLE

Discover → Authenticate → Build → Test → Inspect → Trace

Every operation is tied to API version, auth, request/response fixture, source status and evidence/trace context.

OFFLINE MOCKSANDBOX · credential requiredPRODUCTION DOCS · no embedded secret
V1.2.260123SourcePUBLIC
GET/

Endpoint

AUTH
TRACEx-billcode-id
LOCALEvi / en
RESPONSESANITIZED

                     

                  

               

            

         

         

            

               

                  

                     
CONTRACT AS CODE

                     
OpenAPI is a technical artifact, not a screenshot

                  

                  
Versioned local OpenAPI assets and keeps sandbox/mock separate from production.

               

               

                  

                     
                     
OpenAPI JSON

                     
Machine-readable contract snapshot.

                     
v1.2.260123Local

                  

                  

                     
                     
OpenAPI YAML

                     
Portable specification for tooling.

                     
DownloadSource version

                  

                  

                     
                     
API publication classification

                     
Public · Partner · Administrative · Requires approval

                     
Scope boundary

                  

               

            

         

         

            

               

                  

                     
DEVELOPER WORKBENCH

                     
An endpoint must explain what to call, send, receive and trace

                  

                  

                     Standardize the published endpoint specification structure as: Purpose → Authentication → Schema →
                     Request → Response → Result → Evidence → Source.
                  

               

               

                  

                     
Operation model

                     

                        

                           
                              

                                 Layer
                                 Requirement
                              

                           
                           
                              

                                 Auth
                                 OAuth2 client credentials / Bearer per contract
                              

                              

                                 Headers
                                 M/O/RC/A + format + example
                              

                              

                                 Request
                                 Schema + enum + sanitised example
                              

                              

                                 Response
                                 HTTP + response schema + business result
                              

                              

                                 Evidence
                                 Process/transaction/billcode references when defined
                              

                              

                                 Source
                                 API version + source section + publication status
                              

                           
                        

                     

                  

                  

                     
Test environment status

                     
ENVIRONMENT = OFFLINE_MOCK
NETWORK_REQUEST = false
DATA = SYNTHETIC
SANDBOX = remote service testing (credentials required)
PRODUCTION = separate onboarding / approval

                     
No offline action may automatically call a live environment.

                  

               

            

         

         

            

               

                  

                     
OPENAPI-STANDARD EXPERIENCE

                     
Endpoint completeness checklist

                  

                  

                     Every operation must have enough information before it can be treated as “Documentation complete”.
                  

               

               

                  

                     

                        
                              
                        

                           
api

                           
Specification

                        

                     

                     
Method, path, auth, headers and source version.

                     

                        
InputSource API

                        
OutputOperation identity

                     

                     
MethodPathAuth

                  

                  

                     

                        
                              
                              
                        

                           
source

                           
Schema

                        

                     

                     

                        Request/response field models with type, enum and mandatory/optional M/O/RC/A.
                     

                     

                        
InputField specification

                        
OutputValidated schema

                     

                     
JSON SchemaOpenAPI

                  

                  

                     

                        
                              
                              
                        

                           
verify

                           
Runnable examples

                        

                     

                     

                        Sanitised request/response plus offline simulation with deterministic results.
                     

                     

                        
InputSimulated request

                        
OutputMock result

                     

                     
No personal dataNo secrets

                  

                  

                     

                        
                              
                              
                        

                           
evidence

                           
Traceability

                        

                     

                     

                        Result codes, evidence references, related process/SDK/device context.
                     

                     

                        
InputResponse

                        
OutputIntegration diagnostics

                     

                     
Result codeEvidence

                  

               

               

                  Technical basisSOURCED
                  

                     
SourceCheckID API source + generated OpenAPI

                     
StandardsOAuth2 / OpenAPI

                     
VersionPrimary reference source V1.2.260123

                     

                        Applicable scopePublic/partner publication classification
                     

                     

                        EvidenceTraceability source + audit with sensitive data redacted