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)
givenNamesLocalized	String	Given names in the local language (optional)
surname	String	Surnames (separated with whitespace)
surnameLocalized	String	Surname in the local language (optional)
surnameAndGivenNames	String	Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
surnameAndGivenNamesLocalized	String	Surnames and Given Name(s) in the local language (optional)
placeOfBirth	String	Place of birth
placeOfBirthLocalized	String	Place of birth localized (optional)
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
issuingAuthority	String	Issuing authority name
issuingAuthorityLocalized	String	Issuing authority name in the local language (optional)
documentNumber	String	Id document number
personalNumber	String	Personal number of the document owner
address	String	Place of residence
addressLocalized	String	Place of residence in the local language (optional)
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)
givenNamesLocalized	String	Given names in the local language (optional)
surname	String	Surnames (separated with whitespace)
surnameLocalized	String	Surnames in the local language (optional)
surnameAndGiveNames	String	Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
surnameAndGiveNamesLocalized	String	Surnames and Given Name(s) in the local language (optional)
placeOfBirth	String	Place of birth
placeOfBirthLocalized	String	Place of birth in the local language (optional)
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
issuingAuthority	String	Issuing authority name
issuingAuthorityLocalized	String	Issuing authority name in the local language (optional)
documentNumber	String	Id document number
personalNumber	String	Personal number of the document owner
address	String	Place of residence
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)
givenNamesLocalized	String	Given names in the local language (optional)
surname	String	Surnames (separated with whitespace)
surnameLocalized	String	Surnames in the local language (optional)
surnameAndGivenNames	String	Surnames and Given Name(s) (separated with whitespace) - For use when givenNames and surname are not available as separate fields
surnameAndGivenNamesLocalized	String	Surnames and Given Name(s) in the local language (optional)
placeOfBirth	String	Place of birth
placeOfBirthLocalized	String	Place of birth in the local language (optional)
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
issuingAuthority	String	Issuing authority name
issuingAuthorityLocalized	String	Issuing authority name in the local language (optional)
documentNumber	String	ID document number
personalNumber	String	Personal number of the document owner
sex	String	Possible values are: M (male) F (female) X (unspecified)
address	String	Place of residence
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