Downloading a proof of verification report

When an applicant has been verified, you can download a proof of verification PDF report.

Once an applicant has finished processing, you can use this endpoint to download a certified proof of verification PDF report, containing extracted data, document images, and timestamps.

The report is generated in real-time and provided to you in base64 encoded format.

Example Verification Report

Verification reports can be used as proof of verification, and contain verification information, anything we find on an individual, and more.

---

Download proof of verification

POST /api-summary-download

Once the applicant has finished processing, you can download a proof of verification report

Name	Value
Content-Type	multipart/form-data
Authorization	Bearer YOUR_TOKEN

Body

Name	Type	Description
applicantId	string	Unique applicantId generated on applicant creation (required)
redacted	yes/no	Remove sensitive/personal information from the report (required)

Reports can be generated as redacted or non-redacted.

Non-redacted reports contain sensitive information, like extracted document numbers, expiry dates, document images, and more.

Request

cURL

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

Node.js

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

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://enterprise.personr.co/api/1.1/wf/api-summary-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");
form.append("redacted", "no");

var settings = {
  "url": "https://enterprise.personr.co/api/1.1/wf/api-summary-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-summary-download")

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

request = Net::HTTP::Post.new(url)
form_data = [['applicantId', '4242424242424x424242424242424242'] ['redacted', 'no']]
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-summary-download"

payload = {
    'applicantId': '4242424242424x424242424242424242',
    'redacted': 'no'
}
files = []
headers = {}

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

print(response.text)

Response

200

{
  "status": "success",
  "response": {
    "base64": [
      "/9j/JVBERi0..."
    ]
  }
}

400

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

Calling this endpoint may take longer than usual, as we generate PDF reports in real time.