Supported Documents and Types

A list of supported documents, and their subtypes.

Below are are list of the most popular document types (docType) available to use with theUploading documents to an applicant endpoint.

If you don't see the document you wish to verify, reach out to your account manager for assistance.

If a document has no back side to verify, default side should be FRONT_SIDE

Supported file extensions include .jpg, .jpeg, .png, and .pdf

Selfie Images

Value	Type of document
SELFIE	Selfie of an individual clearly in frame

When uploading a selfie image, be sure to remove/null docSubType.

Your call to the endpoint should look something like the below.

cURL

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-document-upload' \
--data '{
	"applicantId": "4242424242424x424242424242424242",
	"docType": "SELFIE",
	"docCountryISO": "AUS",
	"docFile": {
        "filename": "selfie.jpg",
        "contents": "/9j/4AAQSkZJRgABAQAAAQABAAD..."
    }
}'

Node.js

const axios = require('axios');

axios.post('https://enterprise.personr.co/api/1.1/wf/api-document-upload', {
    applicantId: '4242424242424x424242424242424242',
    docType: 'SELFIE',
    docCountryISO: 'AUS',
    docFile: {
        filename: 'selfie.jpg',
        contents: '/9j/4AAQSkZJRgABAQAAAQABAAD...'
    }
})
.then(response => {
    console.log(response.data);
})
.catch(error => {
    console.error(error);
});

JavaScript

$.ajax({
    url: 'https://enterprise.personr.co/api/1.1/wf/api-document-upload',
    type: 'POST',
    contentType: 'application/json',
    data: JSON.stringify({
        applicantId: '4242424242424x424242424242424242',
        docType: 'SELFIE',
        docCountryISO: 'AUS',
        docFile: {
            filename: 'selfie.jpg',
            contents: '/9j/4AAQSkZJRgABAQAAAQABAAD...'
        }
    }),
    success: function(response) {
        console.log(response);
    },
    error: function(xhr, status, error) {
        console.error(error);
    }
});

Ruby

require 'rest-client'
require 'json'

payload = {
    applicantId: '4242424242424x424242424242424242',
    docType: 'SELFIE',
    docCountryISO: 'AUS',
    docFile: {
        filename: 'selfie.jpg',
        contents: '/9j/4AAQSkZJRgABAQAAAQABAAD...'
    }
}

response = RestClient.post('https://enterprise.personr.co/api/1.1/wf/api-document-upload', payload.to_json, {content_type: :json, accept: :json})
puts response

Python

import requests
import json

url = 'https://enterprise.personr.co/api/1.1/wf/api-document-upload'

payload = {
    'applicantId': '4242424242424x424242424242424242',
    'docType': 'SELFIE',
    'docCountryISO': 'AUS',
    'docFile': {
        'filename': 'selfie.jpg',
        'contents': '/9j/4AAQSkZJRgABAQAAAQABAAD...'
    }
}

headers = {
    'Content-Type': 'application/json'
}

response = requests.post(url, data=json.dumps(payload), headers=headers)
print(response.text)

ID Cards

Value	Type of document
ID_CARD	Proof of Age card
ID_CARD	Working with children's card
ID_CARD	Photo card
ID_CARD	High risk work license
ID_CARD	Keypass ID
ID_CARD	Diplomatic ID
ID_CARD	Firearms license
ID_CARD	Electoral ID
ID_CARD	Citizen, Totum or Young Scot card
ID_CARD	Shotgun certificate
ID_CARD	Home team national service card
ID_CARD	Use this for other identity cards

Drivers Licenses

Value	Type of document
DRIVERS	Drivers license

Passports

Value	Type of document
PASSPORT	Passport

Residence Permits

Value	Type of document
RESIDENCE_PERMIT	Visa
RESIDENCE_PERMIT	Residence or citizenship certificate
RESIDENCE_PERMIT	Employment pass
RESIDENCE_PERMIT	Work permit
RESIDENCE_PERMIT	Student pass
RESIDENCE_PERMIT	Dependant pass
RESIDENCE_PERMIT	Entrepass
RESIDENCE_PERMIT	Green card
RESIDENCE_PERMIT	Nexus card
RESIDENCE_PERMIT	Border crossing card
RESIDENCE_PERMIT	Global entry customs card

Utility Bills

Value	Type of document
UTILITY_BILL	Telecommunications bill
UTILITY_BILL	Electricity, gas or water bill
UTILITY_BILL	Bank statement
UTILITY_BILL	Credit card statement
UTILITY_BILL	Proof of balance or transaction
UTILITY_BILL	Mortgage statement
UTILITY_BILL	Lease agreement, signed by tenant and landlord
UTILITY_BILL	Tax Return or Bill
UTILITY_BILL	Vehicle registration