Downloading verified documents

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 document and selfie images that were submitted by the applicant.

Document images are provided in base64 encoded format.

---

Download verified documents

POST /api-document-download

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

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

Node.js

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);
});

Javascript

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);
});

Ruby

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

Python

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

200

{
  "status": "success",
  "response": {
    "IdDocType": [
      "DRIVERS",
      "DRIVERS",
      "SELFIE"
    ],
    "base64": [
      "/9j/44AQS...",
      "/9j/45AQS...",
      "/9j/49AQS..."
    ]
  }
}

400

{
    "statusCode": 400,
    "message": "Error: incorrect applicantId provided"
}