Document Identification Result

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

  • PassportIdentificationResult

  • IdCardIdentificationResult

  • DriversLicenseIdentificationResult

Description of DocumentIdentificationResult base class:

Getter

Type

Description

getDocumentType()

enum

Id document type. Possible values:

  • PASSPORT - passport

  • NATIONAL_ID - national ID card

  • DRIVERS_LICENSE - driver's license

Description of PassportIdentificationResult base class:

Getter

Type

Description

getGivenNames()

String

Given names (separated with whitespace)

getSurname()

String

Surnames (separated with whitespace)

getSurnameAndGivenNames()

String

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

getDateOfBirth()

LocalDate

Date of birth

getDateOfExpiry()

LocalDate

Date of expiration of the document

getDateOfIssue()

LocalDate

Date of issue of the document

getSex()

enum

Enum with user's gender. Possible values: MALE, FEMALE, UNKNOWN

getNationality()

String

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

getIssuingCountry()

String

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

getDocumentNumber()

String

Document number

isSixteenPlus()

Bool

Person age is over 16 years

isEighteenPlus()

Bool

Person age is over 18 years

isTwentyOnePlus()

Bool

Person age is over 18 years

getDocumentImageFilePath()

String

File path to the image of passport front page

Deprecated methods:

getImageFile() is now deprecated and replaced with getDocumentImageFilePath()

Description of IdCardIdentificationResult base class:

Getter

Type

Description

getGivenNames()

String

Given names (separated with whitespace)

getSurname()

String

Surnames (separated with whitespace)

getSurnameAndGivenNames()

String

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

getDateOfBirth()

LocalDate

Date of birth

getDateOfExpiry()

LocalDate

Date of expiration of the document

getDateOfIssue()

LocalDate

Date of issue of the document

getSex()

enum

Enum with user's gender. Possible values: MALE, FEMALE, UNKNOWN

getNationality()

String

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

getIssuingCountry()

String

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

getDocumentNumber()

String

Document number

isSixteenPlus()

Bool

Person age is over 16 years

isEighteenPlus()

Bool

Person age is over 18 years

isTwentyOnePlus()

Bool

Person age is over 18 years

getDocumentFrontImageFilePath()

String

File path to the image of id card front page

getDocumentBackImageFilePath()

String

File path to the image of id card back page

Deprecated methods:

getImageFrontFile() is now deprecated and replaced with getDocumentFrontImageFilePath()

getImageBackFile() is now deprecated and replaced with getDocumentBackImageFilePath()

Description of DriversLicenseIdentificationResult base class:

Getter

Type

Description

getGivenNames()

String

Given names (separated with whitespace)

getSurname()

String

Surnames (separated with whitespace)

getSurnameAndGivenNames()

String

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

getDateOfBirth()

LocalDate

Date of birth

getDateOfExpiry()

LocalDate

Date of expiration of the document

getDateOfIssue()

LocalDate

Date of issue of the document

getSex()

enum

Enum with user's gender. Possible values: MALE, FEMALE, UNKNOWN

getIssuingCountry()

String

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

getDocumentNumber()

String

Document number

getJuristidction()

String

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

getLicenseClass()

String

Driver's License Classes

getLicenseClassDetails()

Map

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

  • getFrom() [LocalDate] Validity start date

  • getTo() [LocalDate] Validity end date

  • getNotes() [String] Additional notes

isSixteenPlus()

Bool

Person age is over 16 years

isEighteenPlus()

Bool

Person age is over 18 years

isTwentyOnePlus()

Bool

Person age is over 18 years

getDocumentFrontImageFilePath()

String

File path to the image of the document front page

getDocumentBackImageFilePath()

String

File path to the image of the document back page

Deprecated methods:

getImageFrontFile() is now deprecated and replaced with getDocumentFrontImageFilePath()

getImageBackFile() is now deprecated and replaced with getDocumentBackImageFilePath()