DEVELOPERS · CheckID · API 1.2.260123

Quick Start

Integrate CheckID/CheckID from the V1.2.260123 contract: OAuth2 → Subject → Process → Perform → Result.

Talk to an expert Start integrating

API contract sourceDigital Trusted Identity Service API And Kafka SpecificationsV1.2.260123

INTEGRATION FLOW

From OAuth2 to evidence

The latest source replaces the OAuth2 Client Credentials journey.

01OAuth2Client Credentials

02SubjectPERSONAL / ENTERPRISE

03Processtype · purpose · provider

04PerformConditional evidence

05ResultStatus · claims · verification

06Tracex-billcode-id · audit

DEVELOPER ONBOARDING

From sandbox request to the first traceable result

Turns Quick Start into an end-to-end integration journey.

Request Sandbox

Create API Client

Receive test tenant/client and permissions.

Get Access Token

OAuth2 client credentials → bearer access token.

Discover capabilities

Read runtime-supported versions, methods and configuration.

Create Subject

Create PERSONAL or ENTERPRISE subject.

Create / Perform Process

Choose method, supply evidence/input and inspect state/result.

Inspect & Trace

Read result codes and transaction/evidence references.

Go Live

Separate production credentials, readiness and support.

TECHNICAL REFERENCE

Quickstart against CheckID API contract V1.2.260123

Token → subject → process → perform → status/result → transaction correlation

1 · Token

Call `POST /realms/{realm}/protocol/openid-connect/token` using OAuth2 Client Credentials. The source example returns `access_token`, `expires_in`, `token_type=Bearer` and scope. AWS Signature is not current authentication guidance.

2 · Create subject

`POST /v1/create/subject` creates a PERSONAL or ENTERPRISE subject before checks. The source example returns `x-subject-id`, `x-billcode-id` and HTTP 201.

3 · Create process

`POST /v1/create/process` creates a verification process with `process_type`, `purpose` and identity-document context where applicable. The example returns `process_status`, `x-process-id` and `x-billcode-id`.

4 · Perform

`PUT /v1/perform/process` submits payload/evidence according to process type. The PASSIVE_AUTHENTICATION example returns `process_status=ACCEPTED` and `perform_result.passive_authentication_status=PARTIAL_VALID`.

5 · Read status

`GET /v1/get/process/detail` returns source-defined process status/type/purpose context. Clients should not invent a local state model from a single HTTP success response.

6 · Correlation and errors

Persist subject/process/billcode identifiers as defined by contract and preserve raw error literals. Retry/idempotency/webhook semantics lack an authoritative source and remain partner-contract concerns.

IMPLEMENTATION-GRADE JOURNEY

Developer path: OAuth2 token → subject → process → result → evidence

The Quickstart uses only operations and fields from CheckID API contract V1.2.260123. Webhook and SDK method-level behavior is not presented as a production contract without source evidence.

Step	Source-backed operation	Concern
1. Authenticate	POST /realms/{realm}/protocol/openid-connect/token	OAuth2 Client Credentials; Bearer
2. Create subject	POST /v1/create/subject	Owner/identity context; exact fields/enums
3. Create process	POST /v1/create/process	process_type, purpose, document context
4. Perform	PUT /v1/perform/process	Evidence/payload depends on process type
5. Inspect	GET /v1/get/process/detail	Status/result context; no invented state transition
6. Reconcile	Management transactions when authorized	Billcode/process correlation from source

Authentication migration

The current source uses OAuth2 Client Credentials plus Bearer. AWS Signature V4 is legacy documentation, not current integration guidance.

Error handling

Raw API codes/messages remain exact contract literals; human explanations sit outside the literal. Retryability is documented only when sourced.

Async integration

The package lacks an authoritative webhook signing/retry/replay/order/ack contract; standalone Webhook/Callback feature docs are consolidated.

SDK

MOBILE_SDK_ARCHITECTURE.md confirms architecture pattern but not class/method/min-OS contracts; SDK child routes are consolidated.