Docs › API reference
Identity verification
These APIs cover identity document authentication, face match and biometric liveness checks.
The general flow is:
- Capture the end user's ID with the phone camera.
- Request a selfie from the end user's phone camera.
- Process the results through the API.
For a working example of this flow, see the SDK.
Call order#
To extract OCR and MRZ data, validate the ID, perform a face match, run a biometric liveness check and get the trust score, call these APIs in this order:
- Create instance returns a correlation ID.
- Create document session returns an identity document session ID and an access token.
- Enrol document submits the ID document for processing and returns the document type.
- Document image list lists the images extracted from the ID, such as the headshot and signature.
- Document image download downloads the headshot for the face match.
- Liveness check runs a biometric liveness check on the selfie.
- Face match compares the selfie with the headshot from step 5.
- Complete enrolment closes the session at the end of your onboarding flow.
- Get OCR data retrieves the OCR and MRZ data if you need to store it.
- Get decision results retrieves the decision score. Store it, use it to decide on onboarding, or review it in the dashboard.
Tip
If you do not need face match or liveness checks, omit those calls and you will not be charged for them. All results are also visible in the ScreenlyyID dashboard.