For the complete documentation index, see llms.txt. This page is also available as Markdown.

Common Object

Enrollment / Lookup / Reading Flow

Data (attribute "data" in JWS)

Attribute
Description

documents

verifications

nonce

Nonce provided by the customer mobile application when the SDK is initiated. It is useful to make sure the process has been initiated by the customer mobile application. It should be generated server side.

backgroundCheck

Contains the background check result. See the "Background check" in the API documentation for details

deviceAttestation

Contains the Device Attestation result.

Document object

Attribute
Description

scan

See the details here Scan object

reading

See the details here Read object (Mobile SDK only)

face

See the details here Face object

lookup

See the details here Lookup object

Face Session Flow

Data (attribute "data" in JWS)

Attribute
Description

nonce

Nonce provided by the customer mobile application when the SDK is initiated. It is useful to make sure the process has been initiated by the customer mobile application. It should be generated server side.

sessionId

Session ID returned by the Face API when uploading the image used to perform the face match against the selfie captured during the facial recognition step. This ensures that the result is linked to the correct session and should be verified in your backend.

face

Contains the Facial Recognition result

deviceAttestation

Contains the Device Attestation result.

Last updated

Was this helpful?