Downloading verified documents with information

When an applicant has been verified, you can download and retrieve the document images.

Once an applicant has finished processing, you can use this endpoint to download the verified documents and images that were submitted by the applicant.

Document images are provided in base64 encoded format.

NOTE: A Driver's License will appears as only 1 set of document details, but will include both sides as uploaded images.

NOTE: The Liveness Evidence is not available from this endpoint.

Download verified documents information

POST /api-document-download-information

Once the applicant has finished processing, you can download their verified document images.

Name

Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name

Type

Description

applicantId

string

Unique applicantId generated on applicant creation (required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-document-download' \
--form 'applicantId="4242424242424x424242424242424242"'

var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('applicantId', '4242424242424x424242424242424242');

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://enterprise.personr.co/api/1.1/wf/api-document-download',
  headers: { 
    ...data.getHeaders()
  },
  data : data
};

axios(config)
.then(function (response) {
  console.log(JSON.stringify(response.data));
})
.catch(function (error) {
  console.log(error);
});

var form = new FormData();
form.append("applicantId", "4242424242424x424242424242424242");

var settings = {
  "url": "https://enterprise.personr.co/api/1.1/wf/api-document-download",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};

$.ajax(settings).done(function (response) {
  console.log(response);
});

require "uri"
require "net/http"

url = URI("https://enterprise.personr.co/api/1.1/wf/api-document-download")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
form_data = [['applicantId', '4242424242424x424242424242424242']]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

import requests

url = "https://enterprise.personr.co/api/1.1/wf/api-document-download"

payload={'applicantId': '4242424242424x424242424242424242'}
files=[

]
headers = {

}

response = requests.request("POST", url, headers=headers, data=payload, files=files)

print(response.text)

Response

{
  "status": "success",
  "response": {
    "IdDocType": [
      "DRIVERS",
      "PASSPORT"
    ],
    "docExpiries": [
      "DRIVERS",
      "PASSPORT"
    ],
    "docNumbers": [
      "DRIVERS",
      "PASSPORT"
    ],
    "base64": [
      "/9j/44AQS...",
      "/9j/45AQS...",
      "/9j/46AQS..."
    ]
  }
}

PreviousDownloading verified documents NextCheck types and coverage

Last updated 2 months ago

Was this helpful?

hashtagDownload verified documents information

hashtagRequest

Download verified documents information

Request