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.

Dependencies

Supported Credentials

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.

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.

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.

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.

dateOfBirth

string($date)

The ID holder's date of birth.

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, such as the issuing date and expiry date. The information extracted varies by country.

dni

string

DNI as available on the ID if idCountry = ESP and idSubtype = NATIONAL_ID

documentNumber

string

The value that identifies the document.

dueDate

string

Due date in yyyy-MM-dd format. 

durationOfStay

string

Duration of stay if idType = VISA and additional extraction for Visa enabled.

expiryDate

string($date)

Date the ID expires.

firstName

string

ID holder's first name.

gender

string

The ID holder's gender, which can be either of the following:

  • M

  • F

issuingAuthority

string

Issuing authority of the document.

issuingCountry

string

The country that issued the document. Can be any ISO 3166-1 alpha-3 country code, and XKX for Kosovo.

Examples: USA, AUT, GER, FRA

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.

lastName

string

ID holder's last name.

mrz

object (see MRZ)

Lines from the MRZ (machine readable zone)

nationality

string

Nationality of the document holder in ISO 3166-1 alpha-3 country code.

Examples: USA, AUT, GER, FRA

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 Powszechny Elektroniczny System Ewidencji Ludności (PESEL) number (Polish IDs only).

placeOfBirth

string

The ID holder's place of birth. Depending on the document type, this could be a city, town, region, or country.

registrationNumber

string

 

rgNumber

string

 

signatureAvailable

boolean

If your tenant is configured to check for a signature, the values will be:

  • true if the signature is expected for the ID type and a signature is present.

  • false if the signature is expected for the ID type and a signature is not present.

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 include:

  • 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

visaCategory

string

Visa category if idType = VISA and additional extraction for Visa enabled

Address

Key

Type

Description

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

country

string

Possible values:

postalCode

string

Postal code

subdivision

string

Subdivision (Region, State, Province, Emirate, Department, ...)

city

string

City

formattedAddress

string

Complete address in a formatted way

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 first name as displayed on the ID.

lastName

string

ID holder last name as displayed on the ID.

dateOfBirth

string

ID holder date of birth as displayed on the ID. The value is a string, not a formatted date.

expiryDate

string

ID expiration date as displayed on the ID. The value is a string, not a formatted date.

issuingDate

string

Date the ID was issued, as displayed on the ID. The value is a string, not a formatted date.

gender

string

ID holder gender as displayed on the ID.

address

object

The additionalLanguage.address object contain the same fields as Address. However, the values are as displayed on the ID.

documentNumber

string

ID document number as displayed on the ID.

language

string

The ISO 639-1 code for the ID language.

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

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:

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 only)

firstName, lastName, socialSecurityNumber, signatureAvailable

BC (birth certificate)

lastName*, issuingDate, address, dateOfBirth

All other document types

lastName*, issuingDate, address

* The complete name will be retrieved within this attribute.