Batch Uploads

To upload a batch and initiate the transaction processing:

Connect to the SFTP server for your tenant from your SFTP Client. See SFTP Client.
Create a folder with a UUID for the name. See Create Folder with UUID Name.
Upload a CSV file with the transaction data. See CSV File Format.
If the transactions require ID, Selfie, and/or Document images upload the archive file. See Images.
Upload a file named DONE to initiate processing.

Monitor the status of the batch job in the Jumio Portal / Settings / Identity Verification / Batch Uploads page. See Batch Status and Locating Processed Transactions.

SFTP Client

In your SFTP client connect to the server for your tenant using the SFTP URL shown in the Jumio Portal / Settings / Identity Verification / Batch Uploads / Batch Credentials tab:

Use the generated SSH Key for the connection. You will log into a home folder dedicated to your organization.

Disable the resume transfer and timestamp preservation features if they are supported by your SFTP client.

Create Folder with UUID Name

After connecting to the server create a folder on the server, using a UUID as the folder name. For example:

096c7aef-c3dd-4427-9f93-f64295b8f2d6

UUID generators are available in most programming languages.

Examples: UUID Generators

Python

import uuid
random_uuid = uuid.uuid4()


NodeJS

import crypto from 'crypto';

function uuidv4() {
  return ([1e7]+-1e3+-4e3+-8e3+-1e11).replace(/[018]/g, c =>
    (c ^ crypto.getRandomValues(new Uint8Array(1))[0] & 15 >> c / 4).toString(16)
  );
}

const randomUUID = uuidv4();



Java

import java.util.UUID;
UUID randomUUID = UUID.randomUUID();


.NET

Guid randomUUID = Guid.NewGuid();

If you are creating a folder manually, you can also search and utilize one of “UUID Generator” websites available online

CSV File Format

Create a CSV (comma separated values) file with one header row and a row for each transaction in the batch.

Example Batch CSV File

workflowDefinitionKey,customerInternalReference,backImage,frontImage,faceImage,userConsentUserIp,userConsentUserLocationCountry,userConsentUserLocationState,userConsentConsentObtained,userConsentConsentObtainedAt,preparedData.firstName,preparedData.lastName,preparedData.phoneNumber,preparedData.email,preparedData.address.line1,preparedData.address.postalCode,preparedData.address.city,preparedData.address.subdivision,preparedData.address.country
10015,myOrganization,0_200014954151.back.png,0_200014954151.front.png,0_200014954151.face.png,226.80.211.232,USA,IL,yes,2022-07-20T17:20:35.000Z,John,Smith,15031234567,email1@gmail.com,12345 SW Address Ln,12345,Any Town,OR,USA
10015,myOrganization,1_200014954152.back.png,1_200014954152.front.png,1_200014954152.face.png,226.80.211.232,USA,IL,yes,2022-07-20T17:20:35.000Z,John,Smith,15031234567,email2@gmail.com,6789 NE Address Ln,56789,Other Town,NY,USA

Please be cautious while using MS-Excel for CSV file handling as it tends to change formatting for certain fields when saved, which may make the CSV file invalid

There must be no more than 10,000 rows in the CSV file.

If there is any field which has comma (,) included, it needs to be put within double quotes (“”) to ensure file format remains valid.

The csv filename needs to be "input.csv". Any other filename will not be accepted

Field	Required	Description
workflowDefinitionKey	yes	The workflow key. Default is 10015.
customerInternalReference	yes	Customer internal reference for a request to link it in the customer backend (must not contain any PII). Must not contain any of the following characters: <>"/;`%{}\|
frontImage	no	File name of the front image, including path relative to the CSV file, if it is present in a subdirectory within the UUID directory. The file must be in the uploaded images.
backImage	no	File name of the back image, including path relative to the CSV file, if it is present in a subdirectory within the UUID directory. The file must be in the uploaded images.
faceImage	no	File name of the face (selfie) image, including path relative to the CSV file, if it is present in a subdirectory within the UUID directory. The file must be in the uploaded images.
userConsentUserIp	no*	If applicable, Consent is required similar to API channel.
userConsentUserLocationCountry	no*	If applicable, Consent is required similar to API channel.
userConsentUserLocationState	no*	If applicable, Consent is required similar to API channel.
userConsentConsentObtained	no*	If applicable, Consent is required similar to API channel.
userConsentConsentObtainedAt	no*	If applicable, Consent is required similar to API channel.
preparedData.firstName	no**	May be required if you are Uploading Supporting Data.
preparedData.lastName	no**	May be required if you are Uploading Supporting Data.
preparedData.phoneNumber	no**	May be required if you are Uploading Supporting Data.
preparedData.email	no**	May be required if you are Uploading Supporting Data.
preparedData.dateOfBirth	no**	May be required if you are Uploading Supporting Data.
preparedData.address.line1	no**	May be required if you are Uploading Supporting Data.
preparedData.address.postalCode	no**	May be required if you are Uploading Supporting Data.
preparedData.address.city	no**	May be required if you are Uploading Supporting Data.
preparedData.address.subdivision	no**	May be required if you are Uploading Supporting Data.
preparedData.address.country	no**	May be required if you are Uploading Supporting Data.

* Populating the userConsent fields conforms to the requirements described in End-User Consent to Collect Personal Data.

** Any prepared data fields required by the workflow can be uploaded through the csv. Use the preparedData.<field_name> format in the header row. Some prepared data fields are required if you are Uploading Supporting Data

Images

Upload all images referenced in the CSV file to the folder created with the UUID name. See also Uploading Credentials for additional information on image requirements.