Document Identification Result
DocumentIdentificationResult can be returned as one of the following derived classes:
PassportIdentificationResultIdCardIdentificationResultDriversLicenseIdentificationResult
Description of DocumentIdentificationResult base class:
DocumentIdentificationResult base class:Getter
Type
Description
getDocumentType()
enum
Id document type. Possible values:
PASSPORT- passportNATIONAL_ID- national ID cardDRIVERS_LICENSE- driver's license
Description of PassportIdentificationResult base class:
PassportIdentificationResult base class:Getter
Type
Description
getGivenNames()
String
Given names (separated with whitespace)
getGivenNamesLocalized()
String
Given names in the local language (optional)
getSurname()
String
Surnames (separated with whitespace)
getSurnameLocalized()
String
Surnames in the local language (optional)
getSurnameAndGivenNames()
String
Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
getSurnameAndGivenNamesLocalized()
String
Surnames and Given Name(s) in the local language (optional)
getPlaceOfBirth()
String
Place of birth
getPlaceOfBirthLocalized()
String
Place of birth in the local language (optional)
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
getIssuingCountry()
String
getIssuingAuthority()
String
Issuing authority name
getIssuingAuthorityLocalized()
String
Issuing authority name in the local language (optional)
getDocumentNumber()
String
Document number
getPersonalNumber()
String
Personal number of the document owner
getAddress()
String
Place of residence
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:
IdCardIdentificationResult base class:Getter
Type
Description
getGivenNames()
String
Given names (separated with whitespace)
getGivenNamesLocalized()
String
Given names in the local language (optional)
getSurname()
String
Surnames (separated with whitespace)
getSurnameLocalized()
String
Surnames in the local language (optional)
getSurnameAndGivenNames()
String
Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
getSurnameAndGivenNamesLocalized()
String
Surnames and Given Name(s) in the local language (optional)
getPlaceOfBirth()
String
Place of birth
getPlaceOfBirthLocalized()
String
Place of birth in the local language (optional)
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
getIssuingCountry()
String
getIssuingAuthority()
String
Issuing authority name
getDocumentNumber()
String
Document number
getPersonalNumber()
String
Personal number of the document owner
getAddress()
String
Place of residence
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:
DriversLicenseIdentificationResult base class:Getter
Type
Description
getGivenNames()
String
Given names (separated with whitespace)
getGivenNamesLocalized()
String
Given names in the local language (optional)
getSurname()
String
Surnames (separated with whitespace)
getSurnameLocalized()
String
Surnames in the local language (optional)
getSurnameAndGivenNames()
String
Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
getSurnameAndGivenNamesLocalized()
String
Surnames and Given Name(s) in the local language
getPlaceOfBirth()
String
Place of birth
getPlaceOfBirthLocalized()
String
Place of birth in the local language (optional)
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
getIssuingAuthority()
String
Issuing authority name
getIssuingAuthorityLocalized()
String
Issuing authority name in the local language (optional)
getDocumentNumber()
String
Document number
getPersonalNumber()
String
Personal number of the document owner
getAddress()
String
Place of residence
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 dategetTo()[LocalDate] Validity end dategetNotes()[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()
Last updated