Skip to main content

Credential and Types

The documents, scanned images, or prepared data that are evaluated by a Jumio workflow are called Credentials. Each Jumio capability specifies the credentials it can evaluate. Before initiating a workflow, you must upload all credentials required by the capabilities included in that workflow to the end-user account.

The following sections describe the credential types currently supported by Jumio:

Credential Type
ID
Selfie
FaceMap
Document
Data

ID​

An ID is a government-issued identification document, such as a passport, identity card, or a driver's license.

You can view the ID types supported by your integration and the IDs supported by Jumio in the Jumio Portal. Log in as an Administrator and navigate to:

  • Settings > Identity Verification > Accepted IDs – View the ID types enabled for your integration.

  • Settings > Identity Verification > Supported IDs – View the ID types supported by Jumio.

For more information see Accepted IDs and Supported IDs.

Depending on the ID type, you may need to provide only the front image or both the front and back images. If your integration uses the Web Client or Mobile SDKs, the customer journey guides end users through submitting the required images.

Enable Brazilian Digital Driver’s License Support​

To process Brazilian driver's license PDFs through the API channel, contact the Jumio Support team to enable the Brazilian PDF driver's license functionality. Once enabled, you can initiate the account using the specified process.

If you upload credentials through REST API calls, the workflow requires the credentials array. You can also use this array to define the credential types supported by your workflow, as shown in the following example:

Example Request​

{
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["USA", "CAN", "BRA"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DRIVING_LICENSE", "ID_CARD"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_DRIVING_LICENSE_PDF"]
}
}
]
}
note

The Brazilian Digital Driving License is an official, government-issued document used to verify a driver’s identity and driving eligibility in Brazil. It is available in a digital format, which includes a QR code for easy verification and enhanced security.

Example Request​

{
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["<COUNTRY_CODE>"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_IDENTITY"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["<SUB_TYPE>"]
}
}
]
}
info
  • Select the country code from ISO-3166-1 Alpha-3 Code.

  • The subType field is only available for Web integrations and supports the following values:

    • DIGITAL_DRIVING_LICENSE_PDF- This option requires country: "BRA" and type: "DRIVING_LICENSE".
    • EIDAS (EU Digital Identity Framework)- This option requires country: <any supported EU country> and type: "DIGITAL_IDENTITY".
    • Use the predefined values listed in the table below.

  • Only a single value is permitted in subType.values. Providing multiple values will result in a 400 error: "SubTypes can only contain one value".

  • In the Web Client, if exactly one country + document type combination is preconfigured in the credentials array, the document-type selection screen will be skipped, and the user will proceed directly to uploading that document.

  • If multiple country and/or document type options are preconfigured, then the Web Client will show a limited selection screen, displaying only those predefined countries and document types to the end user.

Digital Identity Providers​

Expand the list to view the Digital Identity Providers
Name of the ProvidersubType
Austrian Handy-signaturHANDY_SIGNATUR_AUSTRIA
Belgium ID cardITSME_BELGIUM
CA DMV WalletDMV_CALIFORNIA_USA
DigiLocker Match (Preview)DIGILOCKER_INDIA
Italy’s national digital identitySPID_ITALY
Digital National IDNATIONAL_ID_DIGITAL_PHILIPPINES
EU Digital Identity FrameworkEIDAS
eDO App loginEDOAPP_POLAND
eParaksts MobileEPARAKSTS_MOBILE_LATVIA
eParaksts Smart CardEPARAKSTS_ID_LATVIA
Estonian ID cardWEB_EID_ESTONIA
Finnish HenkilökorttiID_FINLAND
France IdentitéIDENTITY_FRANCE
IDINIDIN_NETHERLANDS
Indonesia NIKNIK_INDONESIA
LA WalletWALLET_LOUISIANA_USA
Lithuanian ID CardID_LITHUANIA
Mexico CURPCURP_MEXICO
Mobile-IDMOBILE_ID
MojeID CzechMOJEID_CZECH_REPUBLIC
Philippines National IDNATIONAL_ID_PHYSICAL_PHILIPPINES
PhilSys Biometric VerificationPHILSYS_PHILIPPINES
Portugese Cartão de CidadãoID_PORTUGAL
Samsung WalletSAMSUNG_WALLET
Serbian ID CardID_SERBIA
Smart-IDSMART_ID
Ukraine's Diia state appDIIA_UKRAINE

Selfie​

A Selfie is an image of the end user’s face, uploaded and stored as a single FACE part.

If your integration uses the Web Client or Mobile SDKs, the customer journey guides the end user through capturing and submitting a Selfie. Alternatively, you can upload the image directly through the API.

Facemap​

A FaceMap is a unique Credential consisting of several images of the end user captured in rapid succession. Unlike other Credentials, a FaceMap cannot be uploaded directly through the API.

If your integration uses the Jumio Web Client or SDKs with a workflow that evaluates a FaceMap, it is automatically created and uploaded along with the Selfie as the end user completes the customer journey.

The Liveness capability evaluates the FaceMap to verify that the end user completing the customer journey is a real, live person.

tip

If for any reason the FACEMAP cannot be created, the Liveness capability will evaluate the SELFIE instead.

Although you cannot upload a FaceMap through the APIs, you can retrieve and download the individual images that make up the FaceMap using the Retrieval APIs. For more information, see Workflow Credentials.

tip

The Authentication On-Premises service supports downloading and uploading a binary version of a Facemap. Using it requires additional configuration for your tenant. The binary format is not supported for other uses.

Document​

Images or PDF copies of documents, such as bank statements, utility bills, and insurance cards, can be used to verify an end user's identity.

Workflows that support a Document Credential pass the uploaded document to the Extraction capability to extract relevant information. For a successful extraction, at least one of the following fields must be identified:

  • Name
  • Issue Date
  • Address

Work with your Jumio Account Representative to identify the DOCUMENT types you want to support and configure the fields to be extracted for each type.

Upload Requirements​

  • Supported file formats: JPEG, PNG, and PDF.
  • Maximum total file size: 15 MB.
  • Credit card documents: Up to 2 images or PDF pages.
  • All other document types: Up to 30 images or PDF pages.

Specifying the DOCUMENT in the Account Request​

When using a workflow that requires a Document credential, the request body to the Account API must include a credential node with DOCUMENT as the category value. It must have also include country and type fields, each with exactly one value in it. If any of these conditions are not met, the request will result in validation errors.

For example, to request the standalone Doc Proof workflow (10026) with a bank statement (code: BS):

Example Request​

{
"customerInternalReference": "postman-tomg-call2",
"callbackUrl": "https://enxduej0n1fgwkv.m.pipedream.net",
"workflowDefinition": {
"key": 10026,
"credentials": [
{
"category": "DOCUMENT",
"country": {
"predefinedType": "DEFINED",
"values": ["USA"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["BS"]
},
"options": {
"skipResistantAiFraudCheck": false
}
}
]
},
"userReference": "postman-tomg",
"tokenLifetime": "10m"
}

Supported Documents​

These document types are supported for upload and data extraction. Other document types may be available, and custom documents may be added. Consult your Jumio SE for details about specific document types.

tip

Custom codes you have added must be unique, and must not be the reserved keywords CUSTOM or OTHER.

Expand the list to view Supported Documents
  • BC (Birth certificate)
  • HCC (Health care card)
  • IC (Insurance card)
  • MEDC (Medicare card)
  • SEL (School enrolment letter)
  • SENC (Seniors card)
  • SSC (Social security card)
  • STUC (Student card)
  • WWCC (Working with children check)
  • BS (Bank statement)
  • CCS (Credit card statement)
  • CRC (Corporate resolution certificate)
  • LAG (Lease agreement)
  • LOAP (Loan application)
  • MOAP (Mortgage application)
  • SS (Superannuation statement)
  • TAC (Trade association card)
  • TR (Tax return)
  • VC (Voided check)
  • CB (Council bill)
  • PB (Phone bill)
  • UB (Utility bill)
  • VT (Vehicle title)

Data​

Data is used to upload values for data fields that are required by a capability or risk signal in a workflow, but are not extracted from another Credential such as an ID or Document. For example, many Risk Signals may be called using standalone workflows that do not include other capabilities such as Extraction, and do not require any other credentials. In these cases, the data required by the risk signal is first uploaded as prepared data, using the REST API. Using prepared data is only supported by the REST APIs for Credential Acquisition integration channel.

When your API request to create or update an account specifies a workflow that supports uploading prepared data the response body will include a Credential object with a category value of DATA and a api.parts.prepared_data URL to the parametrized endpoint for uploading the data. The object also includes the api.token value for authorizing the upload request.

{
"credentials": [
...
{
"id": "<CREDENTIAL_UUID>",
"category": "DATA",
"label": "DATA",
"allowedChannels": [
"API"
],
"api": {
"token": "<YOUR_TOKEN>",
"parts": {
"prepared_data": "https://api.amer-1.jumio.ai/api/v1/accounts/{accountId}/workflow-executions/{workflowExecutionId}/credentials/{credentialId}/parts/PREPARED_DATA"
},
"workflowExecution": "https://api.amer-1.jumio.ai/api/v1/accounts/{accountId}/workflow-executions/{workflowExecutionId}"
}
}
...
]
}

Also checkout:

tip

Depending on the workflow, uploading prepared data may be either optional or mandatory. Also, specific fields and values may be either optional or mandatory.

Example Data Upload Request Body​

Data is uploaded by making a POST request to the prepared_data URL from the account response. The request uses Bearer Token authentication with the token from the account response.

The body of the request is a JSON object with the desired or required values. For example:

{
"firstName": "John",
"middleName": "",
"lastName": "Smith",
"dateOfBirth": "1972-11-16",
"socialSecurityNumber": "123456789",
"email": "email@gmail.com",
"phoneNumber": "+15031234567",
"personalNumber": "",
"address": {
"line1": "12345 SW Address Ln",
"postalCode": "97201",
"city": "Portland",
"subdivision": "OR",
"country": "USA"
},
"id": {
"idNumber": "057033812",
"type": "DRIVING_LICENSE",
"issuingDate": "2021-01-22",
"expiryDate": "2026-01-22"
}
}
info

To prevent SQL/XML injection threats the character set [^<>"/;%|] ` is not allowed in the prepared data body values for these keys: firstName, lastName, middleName, paternalSurname , maternalSurname ,email, phoneNumber.

Supported Fields​

Not all values are required for all requests. Refer the documentation for specific risk signals for details on required values and formats.

Field Details Table​

Details
FieldTypeExampleDescription
suffixstringMr, Mrs, MsTitle or suffix of the subject.
firstNamestringJohnFirst name of the subject.
middleNamestringPercivalMiddle name of the subject.
lastNamestringSmithLast name of the subject.
sexstringMGender of ID subject. M for male and F for female.
dateOfBirthstring($date)1972-11-16Date of birth in ISO 8601 date format.
socialSecurityNumberstring123456789USA SSN of the subject.
nationalitystringUSANationality of the subject.
emailstring($email)john.smith@mymail.comPrimary email address of the subject.
phoneNumberstring+2134445678Primary phone number of the subject in E.164 format.
phoneNumber2string+3109992939Alternate phone number of the subject in E.164 format.
personalNumberstringFor Brazil, this will be the CPF number.
addressObjectPrimary address for the subject.
address.line1string12345 SW Address LnLine 1 of the address.
address.line2stringSuite 707Line 2 of the address.
address.citystringPortlandCity of residence as it appears on the ID.
address.postalCodestring97201Postal or zip code.
address.subdivisionstringORCity subdivision of residence as it appears on the ID.
address.countrystringUSACountry in ISO-3166-1 Alpha-3 or Alpha-2 Code format.
idObjectDocument data.
id.idNumberstring057033812Primary ID number on the identity document.
id.TypestringDRIVING_LICENSEType of identity document.
id.subTypestringSub-type of identity document.
id.issuingDatestring2021-01-22Date the document was issued.
id.expiryDatestring2026-01-22Date the document will expire.