# 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 | <p>Id document type. Possible values:</p><ul><li><code>PP</code> - passport</li><li><code>NID</code> - national ID card</li><li><code>DL</code> - driver's license</li></ul> |

#### Description of `PassportIdentificationResult` class: <a href="#passportidentificationresult" id="passportidentificationresult"></a>

<table data-header-hidden><thead><tr><th width="302.74023560749447">Property</th><th width="219.38790099783898">Type</th><th>Description</th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><code>givenNames</code></td><td>String</td><td>Given names (separated with whitespace)</td></tr><tr><td><code>givenNamesLocalized</code></td><td>String</td><td>Given names in the local language (optional)</td></tr><tr><td><code>surname</code></td><td>String</td><td>Surnames (separated with whitespace)</td></tr><tr><td>surnameLocalized</td><td>String</td><td>Surname in the local language (optional)</td></tr><tr><td><code>surnameAndGivenNames</code></td><td>String</td><td>Surnames and Given Name(s)  (separated with whitespace) - For use when <code>givenNames</code> and <code>surname</code> are not available as separate fields</td></tr><tr><td><code>surnameAndGivenNamesLocalized</code></td><td>String</td><td>Surnames and Given Name(s) in the local language (optional)</td></tr><tr><td><code>placeOfBirth</code></td><td>String</td><td>Place of birth</td></tr><tr><td><code>placeOfBirthLocalized</code></td><td>String</td><td>Place of birth localized (optional)</td></tr><tr><td><code>dateOfBirth</code></td><td>Date</td><td>Date of birth</td></tr><tr><td><code>dateOfExpiry</code></td><td>Date</td><td>Date of expiration of the document</td></tr><tr><td><code>dateOfIssue</code></td><td>Date</td><td>Date of issue of the document</td></tr><tr><td><code>sex</code></td><td>String</td><td><p>Possible values are:</p><ul><li><code>M</code> (male)</li><li><code>F</code> (female)</li><li><code>X</code> (unspecified)</li></ul></td></tr><tr><td><code>nationality</code></td><td>String</td><td>Country code of user's nationality in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"><strong>ISO 3166-1 alpha-3</strong></a> format</td></tr><tr><td><code>issuingCountry</code></td><td>String</td><td>Country code of document's issuing country in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"><strong>ISO 3166-1 alpha-3</strong></a> format</td></tr><tr><td><code>issuingAuthority</code></td><td>String</td><td>Issuing authority name</td></tr><tr><td><code>issuingAuthorityLocalized</code></td><td>String</td><td>Issuing authority name in the local language (optional)</td></tr><tr><td><code>documentNumber</code></td><td>String</td><td>Id document number</td></tr><tr><td><code>personalNumber</code></td><td>String</td><td>Personal number of the document owner</td></tr><tr><td><code>address</code></td><td>String</td><td>Place of residence</td></tr><tr><td><code>addressLocalized</code></td><td>String</td><td>Place of residence in the local language (optional)</td></tr><tr><td><code>isSixteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 16 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isEighteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 18 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isTwentyOnePlus</code></td><td>NSNumber</td><td><p>Is person's age over 21 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>documentImageFilePath</code></td><td>String</td><td>File path to the image of passport front page</td></tr></tbody></table>

#### Description of `IdCardIdentificationResult` class:

<table data-header-hidden><thead><tr><th width="316.46136840768673">Property</th><th width="207.17255096966684">Type</th><th>Description</th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><code>givenNames</code></td><td>String</td><td>Given names (separated with whitespace)</td></tr><tr><td><code>givenNamesLocalized</code></td><td>String</td><td>Given names in the local language (optional)</td></tr><tr><td><code>surname</code></td><td>String</td><td>Surnames (separated with whitespace)</td></tr><tr><td><code>surnameLocalized</code></td><td>String</td><td>Surnames in the local language (optional)</td></tr><tr><td><code>surnameAndGiveNames</code></td><td>String</td><td>Surnames and Given Name(s)  (separated with whitespace) - For use when <code>givenNames</code> and <code>surname</code> are not available as separate fields</td></tr><tr><td><code>surnameAndGiveNamesLocalized</code></td><td>String</td><td>Surnames and Given Name(s) in the local language (optional)</td></tr><tr><td><code>placeOfBirth</code></td><td>String</td><td>Place of birth</td></tr><tr><td><code>placeOfBirthLocalized</code></td><td>String</td><td>Place of birth in the local language (optional)</td></tr><tr><td><code>dateOfBirth</code></td><td>Date</td><td>Date of birth</td></tr><tr><td><code>dateOfExpiry</code></td><td>Date</td><td>Date of expiration of the document</td></tr><tr><td><code>dateOfIssue</code></td><td>Date</td><td>Date of issue of the document</td></tr><tr><td><code>sex</code></td><td>String</td><td><p>Possible values are:</p><ul><li><code>M</code> (male)</li><li><code>F</code> (female)</li><li><code>X</code> (unspecified)</li></ul></td></tr><tr><td><code>nationality</code></td><td>String</td><td>Country code of user's nationality in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"><strong>ISO 3166-1 alpha-3</strong></a> format</td></tr><tr><td><code>issuingCountry</code></td><td>String</td><td>Country code of document's issuing country in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"><strong>ISO 3166-1 alpha-3</strong></a> format</td></tr><tr><td><code>issuingAuthority</code></td><td>String</td><td>Issuing authority name</td></tr><tr><td><code>issuingAuthorityLocalized</code></td><td>String</td><td>Issuing authority name in the local language (optional)</td></tr><tr><td><code>documentNumber</code></td><td>String</td><td>Id document number</td></tr><tr><td><code>personalNumber</code></td><td>String</td><td>Personal number of the document owner</td></tr><tr><td><code>address</code></td><td>String</td><td>Place of residence</td></tr><tr><td><code>isSixteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 16 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isEighteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 18 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isTwentyOnePlus</code></td><td>NSNumber</td><td><p>Is person's age over 21 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>documentFrontImageFilePath</code></td><td>String</td><td>File path to the image of ID document front page</td></tr><tr><td><code>documentBackImageFilePath</code></td><td>String</td><td>File path to the image of ID document back page</td></tr></tbody></table>

Description of `DriversLicenseIdentificationResult` class:

<table data-header-hidden><thead><tr><th width="336.3333333333333">Property</th><th>Type</th><th>Description</th></tr></thead><tbody><tr><td>Property</td><td>Type</td><td>Description</td></tr><tr><td><code>givenNames</code></td><td>String</td><td>Given names (separated with whitespace)</td></tr><tr><td><code>givenNamesLocalized</code></td><td>String</td><td>Given names in the local language (optional)</td></tr><tr><td></td><td></td><td></td></tr><tr><td><code>surname</code></td><td>String</td><td>Surnames (separated with whitespace)</td></tr><tr><td><code>surnameLocalized</code></td><td>String</td><td>Surnames in the local language (optional)</td></tr><tr><td><code>surnameAndGivenNames</code></td><td>String</td><td>Surnames and Given Name(s)  (separated with whitespace) - For use when <code>givenNames</code> and <code>surname</code> are not available as separate fields</td></tr><tr><td><code>surnameAndGivenNamesLocalized</code></td><td>String</td><td>Surnames and Given Name(s)  in the local language (optional)</td></tr><tr><td><code>placeOfBirth</code></td><td>String</td><td>Place of birth</td></tr><tr><td><code>placeOfBirthLocalized</code></td><td>String</td><td>Place of birth in the local language (optional)</td></tr><tr><td><code>dateOfBirth</code></td><td>Date</td><td>Date of birth</td></tr><tr><td><code>dateOfExpiry</code></td><td>Date</td><td>Date of expiration of the document</td></tr><tr><td><code>dateOfIssue</code></td><td>Date</td><td>Date of issue of the document</td></tr><tr><td><code>issuingCountry</code></td><td>String</td><td>Country code of document's issuing country in <a href="https://en.wikipedia.org/wiki/ISO_3166-1_alpha-3"><strong>ISO 3166-1 alpha-3</strong></a> format</td></tr><tr><td><code>issuingAuthority</code></td><td>String</td><td>Issuing authority name</td></tr><tr><td><code>issuingAuthorityLocalized</code></td><td>String</td><td>Issuing authority name in the local language (optional)</td></tr><tr><td><code>documentNumber</code></td><td>String</td><td>ID document number</td></tr><tr><td><code>personalNumber</code></td><td>String</td><td>Personal number of the document owner</td></tr><tr><td><code>sex</code></td><td>String</td><td><p>Possible values are:</p><ul><li><code>M</code> (male)</li><li><code>F</code> (female)</li><li><code>X</code> (unspecified)</li></ul></td></tr><tr><td><code>address</code></td><td>String</td><td>Place of residence</td></tr><tr><td><code>jurisdiction</code></td><td>String</td><td>Area where the document got issued. E.g.: USA State or Canada Province.</td></tr><tr><td><code>licenseClass</code></td><td>String</td><td>Driver's License Classes</td></tr><tr><td><code>licenseClassDetails</code></td><td>Dictionary</td><td><p>Driver's License Class details. Dictionary Key is the Class name (i.e. <strong>A</strong>, <strong>B</strong>, <strong>B1, C</strong>, etc.) and Value is a <code>DriversLicenseClassDetailResult</code> class containing the following properties:</p><ul><li><code>from</code> [Date] Validity start date</li><li><code>to</code> [Date] Validity end date</li><li><code>notes</code> [String] Additional notes</li></ul></td></tr><tr><td><code>isSixteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 16 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isEighteenPlus</code></td><td>NSNumber</td><td><p>Is person's age over 18 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>isTwentyOnePlus</code></td><td>NSNumber</td><td><p>Is person's age over 21 years. Possible values:</p><ul><li><code>0</code> - false</li><li><code>1</code> - true</li></ul></td></tr><tr><td><code>documentFrontImageFilePath</code></td><td>String</td><td>File path to the image of ID document front page</td></tr><tr><td><code>documentBackImageFilePath</code></td><td>String</td><td>File path to the image of ID document back page</td></tr></tbody></table>