Document Identification Result

DocumentIdentificationResult can be returned as one of the following derived classes:

  • PassportIdentificationResult

  • IdCardIdentificationResult

  • DriversLicenseIdentificationResult

Description of DocumentIdentificationResult base class:

Property

Type

Description

documentType

String

Id document type. Possible values:

  • PP - passport

  • NID - national ID card

  • DL - driver's license

Description of PassportIdentificationResult class:

Property

Type

Description

givenNames

String

Given names (separated with whitespace)

surname

String

Surnames (separated with whitespace)

surnameAndGivenNames

String

Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields

dateOfBirth

Date

Date of birth

dateOfExpiry

Date

Date of expiration of the document

dateOfIssue

Date

Date of issue of the document

sex

String

Possible values are:

  • M (male)

  • F (female)

  • X (unspecified)

nationality

String

Country code of user's nationality in ISO 3166-1 alpha-3 format

issuingCountry

String

Country code of document's issuing country in ISO 3166-1 alpha-3 format

documentNumber

String

Id document number

isSixteenPlus

NSNumber

Is person's age over 16 years. Possible values:

  • 0 - false

  • 1 - true

isEighteenPlus

NSNumber

Is person's age over 18 years. Possible values:

  • 0 - false

  • 1 - true

isTwentyOnePlus

NSNumber

Is person's age over 21 years. Possible values:

  • 0 - false

  • 1 - true

documentImageFilePath

String

File path to the image of passport front page

Description of IdCardIdentificationResult class:

Property

Type

Description

givenNames

String

Given names (separated with whitespace)

surname

String

Surnames (separated with whitespace)

surnameAndGiveNames

String

Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields

dateOfBirth

Date

Date of birth

dateOfExpiry

Date

Date of expiration of the document

dateOfIssue

Date

Date of issue of the document

sex

String

Possible values are:

  • M (male)

  • F (female)

  • X (unspecified)

nationality

String

Country code of user's nationality in ISO 3166-1 alpha-3 format

issuingCountry

String

Country code of document's issuing country in ISO 3166-1 alpha-3 format

documentNumber

String

Id document number

isSixteenPlus

NSNumber

Is person's age over 16 years. Possible values:

  • 0 - false

  • 1 - true

isEighteenPlus

NSNumber

Is person's age over 18 years. Possible values:

  • 0 - false

  • 1 - true

isTwentyOnePlus

NSNumber

Is person's age over 21 years. Possible values:

  • 0 - false

  • 1 - true

documentFrontImageFilePath

String

File path to the image of ID document front page

documentBackImageFilePath

String

File path to the image of ID document back page

Description of DriversLicenseIdentificationResult class:

Property

Type

Description

givenNames

String

Given names (separated with whitespace)

surname

String

Surnames (separated with whitespace)

surnameAndGivenNames

String

Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields

dateOfBirth

Date

Date of birth

dateOfExpiry

Date

Date of expiration of the document

dateOfIssue

Date

Date of issue of the document

issuingCountry

String

Country code of document's issuing country in ISO 3166-1 alpha-3 format

documentNumber

String

ID document number

sex

String

Possible values are:

  • M (male)

  • F (female)

  • X (unspecified)

jurisdiction

String

Area where the document got issued. E.g.: USA State or Canada Province.

licenseClass

String

Driver's License Classes

licenseClassDetails

Dictionary

Driver's License Class details. Dictionary Key is the Class name (i.e. A, B, B1, C, etc.) and Value is a DriversLicenseClassDetailResult class containing the following properties:

  • from [Date] Validity start date

  • to [Date] Validity end date

  • notes [String] Additional notes

isSixteenPlus

NSNumber

Is person's age over 16 years. Possible values:

  • 0 - false

  • 1 - true

isEighteenPlus

NSNumber

Is person's age over 18 years. Possible values:

  • 0 - false

  • 1 - true

isTwentyOnePlus

NSNumber

Is person's age over 21 years. Possible values:

  • 0 - false

  • 1 - true

documentFrontImageFilePath

String

File path to the image of ID document front page

documentBackImageFilePath

String

File path to the image of ID document back page