ID scanning, validation, liveness and face matching
Scan Identity Document
Extract data from identity documents (Omang, Passport, Drivers Licence) using OCR and MRZ reading.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceValidate ID Data
Validate extracted identity data — format, dates, checksums and field integrity.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceVerify Identity
Verify extracted data against national database (Omang, Passport, Drivers Licence).
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceCreate Liveness Session
Create an anti-spoofing liveness detection session. Returns a sessionId for tracking.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceVerify Liveness Session
Verify a liveness session against confidence threshold.
path Parameters
sessionIdHeaders
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instanceFace Match
Compare a selfie photo against an identity document photo.
Headers
AuthorizationThe Authorization header is used to authenticate with the API using your API key. Value is of the format Bearer YOUR_KEY_HERE.
Responses
Rate Limiting Response
typeA URI reference that identifies the problem.
titleA short, human-readable summary of the problem.
statusThe HTTP status code.
instance