Verifying entity information

Verify entity, or company, data against registries and commercial data sources.

With database verification, you only need to use this endpoint. Entities are created and submitted for processing automatically.

Make sure you pass the correct country when calling this endpoint. This tells us the relevant registry and sources to check within the country.

---

Verify identity data

POST /api-entity-database-verification

Create the entity, match and verify the entity data, and request verification.

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

Body

Name	Type	Description
flowName	string	The name of the flow your Account Manager has provided (required)
companyName	string	The entity's legal name (required)
registrationNumber	string	The entity's registration number (required)
country	string	The entity's registration country, in alpha-3 format (required)
sourceKey	string	An internal unique identifier, or source, that you can use to identify where the entity came from, which is returned in all responses (optional)
externalUserId	list	External identifiers that are returned in all responses (optional)

Use ISO 3166-1 A3 format forcountry. See here for country codes.

Request

cURL

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-entity-database-verification' \
--form 'flowName="KYB Basic"' \
--form 'companyName="Personr Pty Ltd"' \
--form 'registrationNumber="123456789"' \
--form 'country="AUS"'

Node.js

var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();

data.append('flowName', 'KYB Basic');
data.append('companyName', 'Personr Pty Ltd');
data.append('registrationNumber', '123456789');
data.append('country', 'AUS');

var config = {
  method: 'post',
  maxBodyLength: Infinity,
  url: 'https://enterprise.personr.co/api/1.1/wf/api-entity-database-verification',
  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('flowName', 'KYB Basic');
form.append('companyName', 'Personr Pty Ltd');
form.append('registrationNumber', '123456789');
form.append('country', 'AUS');

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

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

Ruby

require "uri"
require "net/http"

url = URI("https://enterprise.personr.co/api/1.1/wf/api-entity-database-verification")

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

request = Net::HTTP::Post.new(url)
form_data = [
  ['flowName', 'KYB Basic'],
  ['companyName', 'Personr Pty Ltd'],
  ['registrationNumber', '123456789'],
  ['country', 'AUS']
]
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-entity-database-verification"

payload = {
    'flowName': 'KYB Basic',
    'companyName': 'Personr Pty Ltd',
    'registrationNumber': '123456789',
    'country': 'AUS'
}

response = requests.post(url, data=payload)

print(response.text)

Response

200

{
    "status": "success",
    "response": {
        "applicantId": "4242424242424242x42424242424242",
        "flow": "KYB Basic",
        "status": "Pending"
    }
}

400

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