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
- JSON
- cURL
- Python
- Java
- PHP
- TypeScript
{
"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"]
}
}
]
}
curl --location 'YOUR_API_ENDPOINT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
"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"]
}
}
]
}'
import requests
url = "YOUR_API_ENDPOINT"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
payload = {
"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"]
}
}
]
}
response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String json = """
{
"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"]
}
}
]
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("YOUR_API_ENDPOINT"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
<?php
$url = "YOUR_API_ENDPOINT";
$payload = [
"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"]
]
]
]
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN"
],
CURLOPT_POSTFIELDS => json_encode($payload)
]);
$response = curl_exec($ch);
echo $response;
curl_close($ch);
?>
import axios from 'axios';
const url = 'YOUR_API_ENDPOINT';
const payload = {
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']
}
}
]
};
const headers = {
'Content-Type': 'application/json',
Authorization: 'Bearer YOUR_ACCESS_TOKEN'
};
async function sendRequest() {
try {
const response = await axios.post(url, payload, {headers});
console.log(response.status);
console.log(response.data);
} catch (error) {
console.error(error);
}
}
sendRequest();
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
- JSON
- cURL
- Python
- Java
- PHP
- TypeScript
{
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["<COUNTRY_CODE>"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_IDENTITY"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["<SUB_TYPE>"]
}
}
]
}
curl --location 'YOUR_API_ENDPOINT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["<COUNTRY_CODE>"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_IDENTITY"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["<SUB_TYPE>"]
}
}
]
}'
import requests
url = "YOUR_API_ENDPOINT"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
payload = {
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["<COUNTRY_CODE>"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_IDENTITY"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["<SUB_TYPE>"]
}
}
]
}
response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String json = """
{
"credentials": [
{
"category": "ID",
"country": {
"predefinedType": "DEFINED",
"values": ["<COUNTRY_CODE>"]
},
"type": {
"predefinedType": "DEFINED",
"values": ["DIGITAL_IDENTITY"]
},
"subType": {
"predefinedType": "DEFINED",
"values": ["<SUB_TYPE>"]
}
}
]
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("YOUR_API_ENDPOINT"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
<?php
$url = "YOUR_API_ENDPOINT";
$payload = [
"credentials" => [
[
"category" => "ID",
"country" => [
"predefinedType" => "DEFINED",
"values" => ["<COUNTRY_CODE>"]
],
"type" => [
"predefinedType" => "DEFINED",
"values" => ["DIGITAL_IDENTITY"]
],
"subType" => [
"predefinedType" => "DEFINED",
"values" => ["<SUB_TYPE>"]
]
]
]
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN"
],
CURLOPT_POSTFIELDS => json_encode($payload)
]);
$response = curl_exec($ch);
echo $response;
curl_close($ch);
?>
import axios from 'axios';
const url = 'YOUR_API_ENDPOINT';
const payload = {
credentials: [
{
category: 'ID',
country: {
predefinedType: 'DEFINED',
values: ['<COUNTRY_CODE>']
},
type: {
predefinedType: 'DEFINED',
values: ['DIGITAL_IDENTITY']
},
subType: {
predefinedType: 'DEFINED',
values: ['<SUB_TYPE>']
}
}
]
};
const headers = {
'Content-Type': 'application/json',
Authorization: 'Bearer YOUR_ACCESS_TOKEN'
};
async function sendRequest() {
try {
const response = await axios.post(url, payload, {headers});
console.log(response.status);
console.log(response.data);
} catch (error) {
console.error(error);
}
}
sendRequest();
-
Select the country code from ISO-3166-1 Alpha-3 Code.
-
The
subTypefield is only available for Web integrations and supports the following values:DIGITAL_DRIVING_LICENSE_PDF- This option requirescountry: "BRA"andtype: "DRIVING_LICENSE".EIDAS (EU Digital Identity Framework)- This option requirescountry: <any supported EU country>andtype: "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 a400error:"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 Provider | subType |
|---|---|
| Austrian Handy-signatur | HANDY_SIGNATUR_AUSTRIA |
| Belgium ID card | ITSME_BELGIUM |
| CA DMV Wallet | DMV_CALIFORNIA_USA |
| DigiLocker Match (Preview) | DIGILOCKER_INDIA |
| Italy’s national digital identity | SPID_ITALY |
| Digital National ID | NATIONAL_ID_DIGITAL_PHILIPPINES |
| EU Digital Identity Framework | EIDAS |
| eDO App login | EDOAPP_POLAND |
| eParaksts Mobile | EPARAKSTS_MOBILE_LATVIA |
| eParaksts Smart Card | EPARAKSTS_ID_LATVIA |
| Estonian ID card | WEB_EID_ESTONIA |
| Finnish Henkilökortti | ID_FINLAND |
| France Identité | IDENTITY_FRANCE |
| IDIN | IDIN_NETHERLANDS |
| Indonesia NIK | NIK_INDONESIA |
| LA Wallet | WALLET_LOUISIANA_USA |
| Lithuanian ID Card | ID_LITHUANIA |
| Mexico CURP | CURP_MEXICO |
| Mobile-ID | MOBILE_ID |
| MojeID Czech | MOJEID_CZECH_REPUBLIC |
| Philippines National ID | NATIONAL_ID_PHYSICAL_PHILIPPINES |
| PhilSys Biometric Verification | PHILSYS_PHILIPPINES |
| Portugese Cartão de Cidadão | ID_PORTUGAL |
| Samsung Wallet | SAMSUNG_WALLET |
| Serbian ID Card | ID_SERBIA |
| Smart-ID | SMART_ID |
| Ukraine's Diia state app | DIIA_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.
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.
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
- JSON
- cURL
- Python
- Java
- PHP
- TypeScript
{
"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"
}
curl --location 'YOUR_API_ENDPOINT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
"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"
}'
import requests
url = "YOUR_API_ENDPOINT"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
payload = {
"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"
}
response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String json = """
{
"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"
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("YOUR_API_ENDPOINT"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
<?php
$url = "YOUR_API_ENDPOINT";
$payload = [
"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"
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN"
],
CURLOPT_POSTFIELDS => json_encode($payload)
]);
$response = curl_exec($ch);
echo $response;
curl_close($ch);
?>
import axios from 'axios';
const url = 'YOUR_API_ENDPOINT';
const payload = {
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'
};
const headers = {
'Content-Type': 'application/json',
Authorization: 'Bearer YOUR_ACCESS_TOKEN'
};
async function sendRequest() {
try {
const response = await axios.post(url, payload, {headers});
console.log(response.status);
console.log(response.data);
} catch (error) {
console.error(error);
}
}
sendRequest();
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.
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:
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:
- JSON
- cURL
- Python
- Java
- PHP
- TypeScript
{
"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"
}
}
curl --location 'YOUR_API_ENDPOINT' \
--header 'Content-Type: application/json' \
--header 'Authorization: Bearer YOUR_ACCESS_TOKEN' \
--data '{
"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"
}
}'
import requests
url = "YOUR_API_ENDPOINT"
headers = {
"Content-Type": "application/json",
"Authorization": "Bearer YOUR_ACCESS_TOKEN"
}
payload = {
"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"
}
}
response = requests.post(url, json=payload, headers=headers)
print(response.status_code)
print(response.json())
import java.net.URI;
import java.net.http.HttpClient;
import java.net.http.HttpRequest;
import java.net.http.HttpResponse;
public class Main {
public static void main(String[] args) throws Exception {
String json = """
{
"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"
}
}
""";
HttpRequest request = HttpRequest.newBuilder()
.uri(URI.create("YOUR_API_ENDPOINT"))
.header("Content-Type", "application/json")
.header("Authorization", "Bearer YOUR_ACCESS_TOKEN")
.POST(HttpRequest.BodyPublishers.ofString(json))
.build();
HttpClient client = HttpClient.newHttpClient();
HttpResponse<String> response = client.send(
request,
HttpResponse.BodyHandlers.ofString()
);
System.out.println(response.statusCode());
System.out.println(response.body());
}
}
<?php
$url = "YOUR_API_ENDPOINT";
$payload = [
"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"
]
];
$ch = curl_init($url);
curl_setopt_array($ch, [
CURLOPT_RETURNTRANSFER => true,
CURLOPT_POST => true,
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"Authorization: Bearer YOUR_ACCESS_TOKEN"
],
CURLOPT_POSTFIELDS => json_encode($payload)
]);
$response = curl_exec($ch);
echo $response;
curl_close($ch);
?>
import axios from 'axios';
const url = 'YOUR_API_ENDPOINT';
const payload = {
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'
}
};
const headers = {
'Content-Type': 'application/json',
Authorization: 'Bearer YOUR_ACCESS_TOKEN'
};
async function sendRequest() {
try {
const response = await axios.post(url, payload, {headers});
console.log(response.status);
console.log(response.data);
} catch (error) {
console.error(error);
}
}
sendRequest();
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
| Field | Type | Example | Description |
|---|---|---|---|
suffix | string | Mr, Mrs, Ms | Title or suffix of the subject. |
firstName | string | John | First name of the subject. |
middleName | string | Percival | Middle name of the subject. |
lastName | string | Smith | Last name of the subject. |
sex | string | M | Gender of ID subject. M for male and F for female. |
dateOfBirth | string($date) | 1972-11-16 | Date of birth in ISO 8601 date format. |
socialSecurityNumber | string | 123456789 | USA SSN of the subject. |
nationality | string | USA | Nationality of the subject. |
email | string($email) | john.smith@mymail.com | Primary email address of the subject. |
phoneNumber | string | +2134445678 | Primary phone number of the subject in E.164 format. |
phoneNumber2 | string | +3109992939 | Alternate phone number of the subject in E.164 format. |
personalNumber | string | For Brazil, this will be the CPF number. | |
address | Object | Primary address for the subject. | |
address.line1 | string | 12345 SW Address Ln | Line 1 of the address. |
address.line2 | string | Suite 707 | Line 2 of the address. |
address.city | string | Portland | City of residence as it appears on the ID. |
address.postalCode | string | 97201 | Postal or zip code. |
address.subdivision | string | OR | City subdivision of residence as it appears on the ID. |
address.country | string | USA | Country in ISO-3166-1 Alpha-3 or Alpha-2 Code format. |
id | Object | Document data. | |
id.idNumber | string | 057033812 | Primary ID number on the identity document. |
id.Type | string | DRIVING_LICENSE | Type of identity document. |
id.subType | string | Sub-type of identity document. | |
id.issuingDate | string | 2021-01-22 | Date the document was issued. |
id.expiryDate | string | 2026-01-22 | Date the document will expire. |