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

Generic ID

All Countries

We do support eID cards (ID-1 format) issued by countries that include a Machine Readable Zone (MRZ) on the back, comply with ICAO Doc 9303, and contain a contactless chip (ISO/IEC 14443 / NFC). This feature is available in the "Enrollment Flow" and "NFC / Reading Flow" using the document type GENERIC_ID or MRZ (when scanning only the back side). If a country is not supported, the NFC reading step is skipped according to the SDK's default configuration. If you believe an eID card complies with the standard but the SDK still skips the NFC reading step, please contact us.

The validity section below includes security-related data. Consumers should evaluate this data using the verification.reading object, which provides the canonical source for implementing business-specific validation and verification logic.

Attribute Level 1
Attribute Level 2
Description

photo

Base64 encoded picture of the user.

photoMimeType

image/jp2 or image/jpeg

signature

Base64 encoded signature (Only if available)

signatureMimeType

image/jp2 or image/jpeg (Only if available)

mrz

{} MRZ object

documentCode

Document code as per MRZ standard

dateOfExpiry

Date of expire as per MRZ standard

optionalData2

Optional field 2 as per MRZ standard

gender

Gender as per MRZ standard

nationality

Nationality as per MRZ standard

documentNumber

Document number as per MRZ standard

dateOfBirth

Date of Birth as per MRZ standard

issuingState

Document issuer as per MRZ standard

secondaryIdentifier

First name as per MRZ standard

primaryIdentifier

Surname as per MRZ standard

optionalData1

Optional Data 1 as per MRZ standard

personalDetails

{} Additional personal details

nameOfHolder

Type string, null if not available

otherNames

Type array of strings, null or empty if not available

personalNumber

Type string, null if not available

fullDateOfBirth

Type string, null if not available

placeOfBirth

Type array of strings, null or empty if not available

permanentAddress

Type array of strings, null or empty if not available

telephone

Type string, null if not available

profession

Type string, null if not available

title

Type string, null if not available

personalSummary

Type string, null if not available

proofOfCitizenship

Type string, null if not available

otherValidTDNumbers

Type array of strings, null or empty if not available

custodyInformation

Type string, null if not available

documentDetails

{} Additional document details

issuingAuthority

Type string, null if not available

dateOfIssue

Type string, null if not available

namesOfOtherPersons

Type array of strings, null or empty if not available

endorsementsAndObservations

Type string, null if not available

taxOrExitRequirements

Type string, null if not available

imageOfFront

Type string, null if not available

imageOfRear

Type string, null if not available

dateAndTimeOfPersonalization

Type string, null if not available

personalizationSystemSerialNumber

Type string, null if not available

countrySigningCertificate

{} Available only if CSCA (Country Signing Certificate Authority) is available for the issuing document

serialNumber

publicKeyAlgorithm

subject

certificateThumbprint

validFrom

signatureAlgorithm

issuer

validTo

documentSigningCertificate

{}

serialNumber

publicKeyAlgorithm

subject

certificateThumbprint

validFrom

signatureAlgorithm

issuer

validTo

dataGroupHashes

[{}] Array of objects. DG1, DG2, DG7, DG11 and DG12 hashes, stored and computed (Only DGs that are available)

computedHash

dataGroupNumber

storedHash

match

If computedHash and storedHash match

validity

{}

dataGroupHashesSucceeded

True if all data group hashes, computed and stored, match

documentSignerSucceeded

Available only if CSCA (Country Signing Certificate Authority) is available for the issuing document and the digital signature of the data in the chip was successfully verified. Otherwise absent. If digital signature verification fails we reject the reading during the enrollment flow at SDK level dropping the session with a specific error code.

sodSignatureSucceeded

True if the signature of the SOD object has been successfully validated against the document signing certificate. For a completed session this value can only be true.

activeAuthenticationPerformed

True if active authentication was performed, otherwise absent. Please note that if active authentication is supported and it fails we reject the reading during the enrollment flow at SDK level dropping the session with a specific error code.

chipAuthenticationPerformed

True if chip authentication was performed, otherwise absent. Please note that if chip authentication is supported and it fails we reject the reading during the enrollment flow at SDK level dropping the session with a specific error code.

Last updated

Was this helpful?