Classification
The classification capability provides details about the document type identified during the classification process. Additional information stored about the document, such as the first issue date, material type, or whether the document is handwritten, can be accessed via the Retrieval API.
This allows businesses to streamline their operations, for example, by filtering out specific types of documents from their workflows, resulting in more efficient document processing.
Data
| Key | Type | Description |
|---|---|---|
country | string | The country that issued the document. Can be any ISO 3166-1 alpha-3 country code, and XKX for Kosovo. Examples: USA, AUT, DEU, FRA |
state | string | Possible values: Last two characters of ISO 3166-2:US state code, Last 2-3 characters of ISO 3166-2:AU state code, Last two characters of ISO 3166-2:CA state code, ISO 3166-1 country name, XKX (Kosovo), Free text if it can't be mapped to a state/country code |
type | string | Possible values include: PASSPORT, DRIVING_LICENSE, ID_CARD, VISA, UNSUPPORTED |
subType | string | Possible values if type = ID_Card: NATIONAL_ID, CONSULAR_ID, ELECTORAL_ID, RESIDENT_PERMIT_ID, TAX_ID, STUDENT_ID, PASSPORT_CARD_ID, MILITARY_ID, PUBLIC_SAFETY_ID, HEALTH_ID, OTHER_ID, VISA, UNKNOWN, MULTI_PURPOSE_ID, PROFESSIONAL_ID, PUBLIC_SAFETY_ID, CITIZENSHIP_ID, SERVICES_ID, SOCIAL_SECURITY_ID |
printedDocumentName | string | Name as printed on the ID document |
firstIssueDate | string | Date when the ID was initially issued in YYYY-MM-DD format |
lastIssueDate | string | The most recent date the ID was reissued in YYYY-MM-DD format |
notValidAfterDate | string | The expiration date after which the ID is no longer valid in YYYY-MM-DD format |
hasCryptoChip | boolean | If the document has a crypto chip available |
isFoldable | boolean | If the document is foldable |
isHandwritten | boolean | If the document is handwritten |
layout | string | Layout of the ID document |
material | string | Material of the ID document |
Decision Details Labels
| Decision Type | Label | Description |
|---|---|---|
| PASSED | OK | The document metadata for classification was successfully identified. |
| NOT_EXECUTED | PRECONDITION_NOT_FULFILLED | Required data from another capability is not available. |
tip
For an overview of how Jumio handles PASSED, WARNING, and REJECTED across all capabilities, see How Jumio Handles Results.