Uploading encoded documents to an entity

Instead of using a verification link, use this endpoint to upload documents directly via API.

This endpoint allows you to upload base64 encoded entity documents directly via API, instead of using a URL. You may want to do this to fully customise the look and feel of the verification process within your website or application.

Note: You don't need to use this endpoint if you're verifying entities using a verification link.

Each call can only receive one document. Make sure to send the necessary data in the docSubType parameter.

Upload documents to your applicant

POST /api-entity-document-upload-encoded

Upload a base64 encoded document to an entity, ready for processing.

Name

Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name

Type

Description

applicantId

string

Unique applicantId generated on applicant creation (required)

docSubType

string

The corporate document type - see next page for the different types.(optional)

fileName

string

The name of the file, including the extension (.jpg, .jpeg, .png, and .pdf) (required)

docFile

string

File content in base64 encoded format (required)

Request

curl -X POST https://enterprise.personr.co/api/1.1/wf/api-entity-document-upload-encoded \
    -H "Content-Type: multipart/form-data" \
    -H "Authorization: Bearer YOUR_ACCESS_TOKEN" \
    -F "applicantId=4242424242424x424242424242424242" \
    -F "docSubType=Certificate of incorporation" \
    -F "fileName=document.pdf" \
    -F "docFile=/9j/4AAQSkZJRgABAQAAAQABAAD..." \

const axios = require('axios');
const FormData = require('form-data');

const formData = new FormData();

const base64FileContent = '/9j/4AAQSkZJRgABAQAAAQABAAD...';

formData.append('applicantId', '4242424242424x424242424242424242');
formData.append('docSubType', 'Certificate of incorporation');
formData.append('fileName', 'document.pdf');
formData.append('docFile', base64FileContent);

const config = {
  method: 'post',
  url: 'https://enterprise.personr.co/api/1.1/wf/api-entity-document-upload-encoded',
  headers: { 
    'Authorization': 'Bearer YOUR_ACCESS_TOKEN',
    ...formData.getHeaders(),
  },
  data: formData,
  maxBodyLength: Infinity,
  maxContentLength: Infinity,
};

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

const fs = require('fs');
const fetch = require('node-fetch');

const fileBase64 = "/9j/4AAQSkZJRgABAQAAAQABAAD..."

const url = "https://enterprise.personr.co/api/1.1/wf/api-entity-document-upload-encoded";

const payload = {
  applicantId: "4242424242424x424242424242424242",
  docSubType: "Certificate of incorporation",
  fileName: "document.pdf",
  docFile: fileBase64
};

fetch(url, {
  method: "POST",
  headers: {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
  },
  body: JSON.stringify(payload)
})
.then(response => response.json())
.then(data => console.log(data))
.catch(error => console.error('Error:', error));

require "uri"
require "net/http"
require "json"

base64_file = "/9j/4AAQSkZJRgABAQAAAQABAAD..."

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

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

request = Net::HTTP::Post.new(url)
request["Content-Type"] = "application/json"
request["Authorization"] = "Bearer YOUR_ACCESS_TOKEN"

payload = {
  applicantId: "4242424242424x424242424242424242",
  docSubType: "Certificate of incorporation",
  fileName: "document.pdf",
  docFile: base64_file
}

request.body = payload.to_json

response = https.request(request)
puts response.read_body

import requests
import json

url = "https://enterprise.personr.co/api/1.1/wf/api-entity-document-upload-encoded"

base64_file = "/9j/4AAQSkZJRgABAQAAAQABAAD..."

payload = {
    "applicantId": "4242424242424x424242424242424242",
    "docSubType": "Certificate of incorporation",
    "fileName": "document.pdf",
    "docFile": base64_file
}

headers = {
    "Content-Type": "application/json",
    "Authorization": "Bearer YOUR_ACCESS_TOKEN"
}

response = requests.post(url, headers=headers, json=payload)

print(response.text)

Response

{
    "applicantId": "4242424242424x424242424242424242",
    "documentSubType": "Certificate of incorporation"
}

Once all required documents have been uploaded, head toRequesting to start the verification processto confirm everything has been uploaded, and to start the verification check.

PreviousUploading documents to an entity NextSupported Documents and Types

Last updated 6 months ago

Was this helpful?

hashtagUpload documents to your applicant

hashtagRequest

Upload documents to your applicant

Request