Retrieving entity verification results

When an entity has finished processing, you can retrieve the verification results.

Verifications typically take ~2 minutes on average to process. When an entity has finished processing, use this endpoint to retrieve extracted registry data along with the verification result.

Retrieving the result

POST /api-entity-status

Retrieve the verification status, and extracted registry data.

Name

Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name

Type

Description

applicantId

string

Unique applicantId generated on entity creation (required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-entity-status' \
--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-entity-status',
  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-entity-status",
  "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-entity-status")

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-entity-status"

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

]
headers = {}

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

print(response.text)

Response

{
    "status": "success",
    "response": {
        "applicantStatus": "Reviewed",
        "reviewAnswer": "Approved",
        "createdDate": "12/09/2024",
        "rejectLabels": [],
        "entityName": "ABC Pty Ltd",
        "registrationNumber": "000000000",
        "entityType": "Australian Proprietary Company, Limited By Shares",
        "incorporatedOn": "12/12/2020",
        "entityCountry": "AUS",
        "registrySource": "Australian Securities & Investments Commission",
        "registeredAddress": "123 Example Lane, Perth, 6000, WA, Australia",
        "representativeEmail": "example@personrco",
        "representativePhone": "0400000000",
        "sourceKey": "Example Source Key",
        "externalUserId": []
    }
}

{
  "status": "success",
  "response": {
    "applicantStatus": "Reviewed",
    "reviewAnswer": "Rejected",
    "createdDate": "12/09/2024",
    "rejectLabels": [
      "SANCTIONS",
      "WATCHLIST"
    ],
    "entityName": "ABC Pty Ltd",
    "registrationNumber": "000000000",
    "entityType": "Australian Proprietary Company, Limited By Shares",
    "incorporatedOn": "12/12/2020",
    "entityCountry": "AUS",
    "registrySource": "Australian Securities & Investments Commission",
    "registeredAddress": "123 Example Lane, Perth, 6000, WA, Australia",
    "representativeEmail": "example@personrco",
    "representativePhone": "0400000000",
    "flowAnswers": []
  }
}

If your flow contains a custom questionnaire, see Retrieving entity questionnaire answers to retrieve the questions and answers.

Applicant Status Types

Created The entity has been created.

Pre-Checked The entity's documents are being processed.

Pending The entity's data is being processed.

Reviewed The verification is complete, and results are ready.

Review Answer Types

Approved The entity has successfully been verified.

Rejected The entity wasn't able to be verified. Look at rejectLabels to see why.

See the next page for a list of rejection labels, and what they mean.

PreviousRequesting to start the verification process NextUnderstanding entity rejection labels

Last updated 1 year ago

Was this helpful?

hashtagRetrieving the result

hashtagRequest

hashtagApplicant Status Types

hashtagReview Answer Types

Retrieving the result

Request

Applicant Status Types

Review Answer Types