DEVELOPERS · CHECKID

Data Models

Identity document, process, final result, certificates, payload and transaction details.

Talk to an expert Developer quick start

CONTRACTVersioned API / SDK

AUTHOAuth2 / environment

OUTPUTResponse · result code · evidence

APPENDIX A / OBJECTS

Data model map

Each object maps to the source contract; code identifiers remain in English.

Source contractAppendix A · Object Description + Section 7 · Objects

identity_document

type · value

Document types include PASSPORT, DRIVER_LICENSE, IDENTITY_CARD, CITIZEN_CARD, FACE_SCAN, FACE_FRAME.

process

process_id · status · provider · process_type · result

Verification resource and state.

document_verification

name · expiry · consistency · document · DOB · issuer · result

Document verification result fields.

facial_similarity

similarity_score · visual_authenticity · face_comparison · image_integrity · result

Face comparison result fields.

final_result

identity attributes · similarity_score · claim_sources

Final verified result / signed claim source.

certificates

certificate · subject · issuer · thumbprint · serial · key_hash · validity

Certificate metadata object.

payload

subject_id · process_id · conditional process fields

Process Perform payload.

transaction_details

type-specific result/evidence

Transaction detail structures vary by transaction type.

TECHNICAL CONTENT

Data models: field semantics remain contract-bound

Source → Scope → Implementation → Evidence → Limitation

Subject

Public examples show subjects with owner/subject type, identity-document context and contact/identity fields depending on operation. does not mark every example field mandatory without schema evidence.

Process

A Process carries `process_type`, `purpose`, status and conditional evidence/result. A subject can contain multiple processes, so a process is not the same as the subject lifecycle.

Result

`perform_result` contains process-type-specific results; the PASSIVE_AUTHENTICATION example exposes `passive_authentication_status`. does not generalize one process-specific field to every process.

Management/transaction

Management transaction views expose identifiers such as billcode/process under authorized classification. Restricted or PII fields are not published beyond source classification.

Schema table rule

Each public field records type, required/optional/conditional state, enum when known, source version and description. Insufficient source is marked SOURCE REQUIRED rather than guessed.

Examples

Examples use consistent placeholders; raw keys, enums and error literals are not translated.