Extraction

Extracts data values from the ID image(s) or DOCUMENT images. Extraction can be fully automated, handled manually by humans, or may be a hybrid of automated and manual processes, depending on the document type and the Jumio products you have purchased. For example, if you have purchased Jumio GO, the process is completely automated.

The Extraction capability automatically rotates and crops the ID image(s) to improve data extraction accuracy. Multiple methods of data extraction are utilized including barcode scanning, reading the MRZ, and OCR.

The data fields that are extracted vary by document type, country, and configuration options.

Dependency

• Usability

Supported Credentials

• ID see Data Extracted from ID Types
• Document see Data Extracted from DOCUMENT Types

note

If an eIDAS digital ID is used instead of a physical ID, the system does not have access to the ID face, meaning a face comparison cannot be performed. Additionally, the data points returned may differ when using an eIDAS digital ID.

nfcValidationResult Label

note

NFC Read-Only scanning is disabled per default. Please contact the Jumio Support if you would like to change this setting.

nfcValidationResult, indicates the detailed validation result of NFC data received from the Mobile SDK. For documents where NFC extraction is possible, the parameter nfcValidationResult is returned. Possible values include:

Status	Description
READ_VALIDATED	NFC data was successfully read and validated.
READ_ONLY	NFC data was read, but validation was not possible.
VALIDATION_FAILED	NFC data was read, but validation failed.
SKIPPED	The user intentionally skipped the NFC process.
SKIPPED_MAX_RETRIES	The NFC process was skipped after reaching the maximum retry limit.
TECHNICAL_ERROR	An unrecoverable error occurred, such as an authentication failure.
READER_UNAVAILABLE	The device does not support NFC scanning.
COUNTRY_UNAVAILABLE	NFC data could not be validated because no certificates are available for the document’s issuing country (applies only if READ_ONLY is disabled).

Decision Details Labels

Decision Type	Label	Description
NOT_EXECUTED	PRECONDITION_NOT_FULFILLED	Required data from another capability is not available.
NOT_EXECUTED	TECHNICAL_ERROR	An error prevented execution.
PASSED	OK	All required data values were successfully extracted from the image of the ID.

tip

For an overview of how Jumio handles PASSED, WARNING, and REJECTED across all capabilities, see How Jumio Handles Results.

Data Extracted from ID Types

For almost all government-issued ID document types a successful extraction must include:

• first name

• last name

• date of birth

• document number

• expiry date

Other values may be extracted, depending on the type and country of the ID. The following table shows some common values. Consult with your Jumio Account Representative to verify that the IDs and fields for your use case are supported.

Table

Key	Type	Description
firstName	string	ID holder's first name.
lastName	string	ID holder's last name.
dateOfBirth	string($date)	The ID holder's date of birth.
documentNumber	string	The value that identifies the document.
expiryDate	string($date)	Date the ID expires.

Additional Fields

Key	Type	Description
address	object (see Address)	The ID holder's address.
additionalLanguage	object (see Additional Language)	If enabled for your tenant, additional fields may be extracted and returned in the native language of the ID.
company	string	The company the card holder is working at.
cpf	string	The Cadastro de Pessoas Fisicas (CPF) number extracted from the ID document (Brazilian IDs only).
curp	string	The Clave Única de Registro de Población (CURP) identity code for Mexican documents.
currentAge	string	Current age, calculated based on the date of birth or the date of birth parts field (if currentAge calculation is enabled).
dlCategories	array of objects (see Driving License Category)	Data points used to determine whether the holder of the license is allowed to drive a specific vehicle.
dni	string	DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID.
dueDate	string	Due date in YYYY-MM-DD format.
durationOfStay	string	Duration of stay if idType = VISA and additional extraction for Visa enabled.
gender	string	The ID holder's gender: M or F.
issuingAuthority	string	Issuing authority of the document.
issuingCountry	string	The country that issued the document (ISO 3166-1 alpha-3 country code, e.g., USA, AUT, DEU).
issuingDate	string($date)	Date the ID was issued.
issuingNumber	string	"Numero de emission" number for idCountry = MEX (if extraction is enabled).
issuingPlace	string	Issuing place of the document.
mrz	object (see MRZ)	Lines from the MRZ (machine readable zone).
nationality	string	Nationality of the document holder (ISO 3166-1 alpha-3 country code).
occupation	string	The occupation of the card holder.
optionalMrzField1	string	Optional field of MRZ line 1.
optionalMrzField2	string	Optional field of MRZ line 2.
passportNumber	string	Passport number if idType = VISA and additional extraction for Visa enabled.
personalIdentificationNumber	string
personalNumber	string
pesel	string	The ID holder's PESEL number (Polish IDs only).
placeOfBirth	string	The ID holder's place of birth (city, town, region, or country).
registrationNumber	string
rgNumber	string
signatureAvailable	boolean	Whether a signature is present for the ID type (true or false).
state	string	State/country information (ISO 3166 or free text).
streetNumber	string	Part of Arabic addresses, represents the number of a street as part of the address.
subType	string	Possible subtypes based on type (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). Possible values if type = DRIVING_LICENSE include: REGULAR_DRIVING_LICENSE LEARNING_DRIVING_LICENSE DIGITAL_DRIVING_LICENSE_PDF.
type	string	Possible values: PASSPORT, DRIVING_LICENSE, ID_CARD, VISA, UNSUPPORTED, DIGITAL_IDENTITY.
visaCategory	string	Visa category if idType = VISA and additional extraction for Visa enabled.

Address

Key	Type	Description
buildingNumber	string	Part of Arabic addresses (on KWT IDs), represents the building number as part of the address
city	string	City
country	string	Possible values: - ISO 3166-1 alpha-3 country code - XKK (Kosovo)
districtNumber	string	Part of Arabic addresses, represents the number of a district as part of the address
floorNumber	string	Part of Arabic addresses (on KWT IDs), represents the floor number as part of the address
formattedAddress	string	Complete address in a formatted way
line1	string	Line item 1
line2	string	Line item 2
line3	string	Line item 3
line4	string	Line item 4
line5	string	Line item 5
postalCode	string	Postal code
subdivision	string	Subdivision (Region, State, Province, Emirate, Department, …)
unit	string	Part of Arabic addresses (on KWT IDs), represents the unit as part of the address

Additional Language

The additionalLanguage fields returned will vary by country, ID type, and subtype. Contact Jumio Support if you require additional information.

Key	Type	Description
firstName	string	ID holder's first name as displayed on the ID.
lastName	string	ID holder's last name as displayed on the ID.
address	object	Contains the same fields as Address; values are as displayed on the ID.
dateOfBirth	string	ID holder's date of birth as displayed on the ID. The value is a string, not a formatted date.
documentNumber	string	ID document number as displayed on the ID.
employer	string	ID holder's employer as displayed on the ID.
expiryDate	string	ID expiration date as displayed on the ID. The value is a string, not a formatted date.
fathersName	string	ID holder's father's name as displayed on the ID.
gender	string	ID holder's gender as displayed on the ID.
issuingDate	string	Date the ID was issued, as displayed on the ID. The value is a string, not a formatted date.
issuingPlace	string	Place the ID was issued, as displayed on the ID.
language	string	The ISO 639-1 code for the ID language.
maritalStatus	string	ID holder's marital status as displayed on the ID.
nationality	string	ID holder's nationality as displayed on the ID.
placeOfBirth	string	ID holder's place of birth as displayed on the ID.
profession	string	ID holder's profession as displayed on the ID.
religion	string	ID holder's religion as displayed on the ID.

Driving License Category

Key	Type	Description
category	string
issueDate	string	Date in YYYY-MM-DD format
expiryDate	string	Date in YYYY-MM-DD format
isReadable	string	A TRUE or FALSE value indicating whether the license was readable or not.
availability	string

MRZ Lines

Key	Type	Description
line1	string	First line in the MRZ.
line2	string	Second line in the MRZ.
line3	string	Third line in the MRZ, if available.

Data Extracted from DOCUMENT Types

Work with your Jumio Account Representative to identify and configure the DOCUMENT types you intend to support, and the fields you expect to be extracted.

A successful extraction requires at least one of the attributes being extracted, with the exception of credit cards (where the PAN number and expiry date are mandatory) and USA Social Security Card (where all attributes are mandatory).

For the following specific document types, additional data will be extracted:

Document Type	Extracted Data
BS (Bank Statement)	lastName*, issuingDate, address, accountNumber, swiftCode
CC (Credit Card)	lastName*, panNumber, monthYearExpiry
UB (Utility Bill)	lastName*, issuingDate, address, dueDate
CCS (Credit Card Statement)	lastName*, issuingDate, address, cardNumberLastFourDigits
SSC (Social Security Card, USA)	firstName, lastName, socialSecurityNumber, signatureAvailable
BC (Birth Certificate)	lastName*, issuingDate, address, dateOfBirth
All other document types	lastName*, issuingDate, address

note

*The complete name will be retrieved within this attribute.