/realms/{realm}/protocol/openid-connect/token
Retrieve Token
OAuth2 Client Credentials token retrieval.
DEVELOPERS · CheckID · API 1.2.260123
REST API
REST API rebuilt from CheckID API contract V1.2.260123, replacing the legacy OAuth2 Client Credentials contract.
SOURCE-DRIVEN REST API
Current integration contract
V1.2.260123 · OAuth2 · Bearer · WSO2 · x-billcode-id.
/v1/get/system/info
Get System Information
Discover service versions, languages, methods and runtime configuration.
/identification/v1/initialize/group
Initialize Identification Group
Initialize subjects for 1:N face, fingerprint or iris identification.
/v1/create/subject
Create Subject
Create a PERSONAL or ENTERPRISE subject before checks are initiated.
/v1/get/subjects
Get List of Subjects
List subjects using paging and identity/contact filters.
/v1/get/subject/details
Get Subject Detail
Retrieve subject information and optional DG/bind method details.
/v1/update/subject
Update Subject
Update authenticated subject information and claim-source context.
/v1/create/process
Create Process
Create one verification process inside one subject; a subject may contain many processes.
/v1/get/process/detail
Get Process Detail
Retrieve process status and source-defined result context.
/v1/perform/process
Perform Process
Execute the process with conditional evidence according to process type.
/v1/get/management/transactions
Get List of Transactions
Retrieve transaction records for authorized management use.
TECHNICAL CONTENT
REST API: contract-first publication
Source → Scope → Implementation → Evidence → Limitation
API version source
takes public examples from CheckID API & Kafka Specifications V1.2.260123 and the corresponding OpenAPI. Each operation retains its PUBLIC/PARTNER/CUSTOMER-PARTNER classification to avoid exposing schema beyond publication scope.
Resource model
The current contract groups Authentication, System, Identification Groups, Subjects, Processes and Management. A Subject provides identity/business-entity context; a Process represents a verification action/purpose; transaction/management views support authorized traceability.
Identifiers
Public-catalog identifiers include `x-subject-id`, `x-process-id`, `x-billcode-id` and `x-group-id` in relevant operations. does not rename raw contract fields for aesthetics.
Conditional schema
Request/response content depends on `process_type` and operation. Required/optional/conditional rules are sourced from OpenAPI/specification and not inferred from one example.
Errors
HTTP status and application result/error codes are documented with raw message, meaning and recommended action. Historical typos in raw literals remain source-traceable until the API owner confirms a correction.
Compatibility
API publication records source version, deprecation/errata when available, environment boundary, and never embeds real secrets or PII.