> For the complete documentation index, see [llms.txt](https://manual.personr.co/api-documentation/llms.txt). Markdown versions of documentation pages are available by appending `.md` to page URLs; this page is available as [Markdown](https://manual.personr.co/api-documentation/entity-results/retrieving-entity-verification-results.md).

# 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

<mark style="color:green;">`POST`</mark> `/api-entity-status`

Retrieve the verification status, and extracted registry data.

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

**Body**

<table><thead><tr><th>Name</th><th width="165">Type</th><th>Description</th></tr></thead><tbody><tr><td><code>applicantId</code></td><td>string</td><td>Unique applicantId generated on entity creation <mark style="color:red;">(required)</mark></td></tr></tbody></table>

#### Request

{% tabs %}
{% tab title="cURL" %}

```sh
curl --location 'https://enterprise.personr.co/api/1.1/wf/api-entity-status' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'applicantId="4242424242424x424242424242424242"'
```

{% endtab %}

{% tab title="Node.js" %}

```javascript
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: { 
    'Authorization': 'Bearer YOUR_TOKEN',
    ...data.getHeaders()
  },
  data : data
};

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

{% endtab %}

{% tab title="Javascript" %}

```javascript
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,
  "headers": {
    "Authorization": "Bearer YOUR_TOKEN"
  },
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};

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

{% endtab %}

{% tab title="Ruby" %}

```ruby
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)
request["Authorization"] = "Bearer YOUR_TOKEN"
form_data = [['applicantId', '4242424242424x424242424242424242']]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://enterprise.personr.co/api/1.1/wf/api-entity-status"

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

]
headers = {
  'Authorization': 'Bearer YOUR_TOKEN'
}

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

print(response.text)
```

{% endtab %}
{% endtabs %}

**Response**

{% tabs %}
{% tab title="200 - Approved" %}

```json
{
    "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@personr.co",
        "representativePhone": "0400000000",
        "sourceKey": "Example Source Key",
        "externalUserId": [],
        "trustDeedStatus": "not_required",
        "deedRequired": false,
        "amlMonitoring": true,
        "amlMonitoringFrequency": "Monthly",
        "amlLastScreenedAt": "2026-12-08T03:17:11.881Z",
        "amlNextScreeningAt": "2027-01-07T03:17:11.881Z",
        "amlMonitoringAlert": false
    }
}
```

{% endtab %}

{% tab title="200 - Trust, deed required" %}

```json
{
    "status": "success",
    "response": {
        "applicantStatus": "Reviewed",
        "reviewAnswer": "Approved",
        "createdDate": "12/09/2024",
        "rejectLabels": [],
        "entityName": "The Trustee for Example Unit Trust",
        "registrationNumber": "00 000 000 000",
        "entityType": "Fixed Unit Trust (FUT)",
        "incorporatedOn": "2009-04-22",
        "entityCountry": "AUS",
        "registrySource": "Australian Business Register",
        "registeredAddress": "6000, WA, AUSTRALIA",
        "representativeEmail": "example@personr.co",
        "representativePhone": "0400000000",
        "sourceKey": "Example Source Key",
        "externalUserId": [],
        "trustDeedStatus": "required",
        "deedRequired": true,
        "amlMonitoring": false,
        "amlMonitoringFrequency": "Monthly",
        "amlLastScreenedAt": "",
        "amlNextScreeningAt": "",
        "amlMonitoringAlert": false
    }
}
```

{% endtab %}

{% tab title="200 - Rejected" %}

```json
{
  "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@personr.co",
    "representativePhone": "0400000000",
    "flowAnswers": [],
    "trustDeedStatus": "not_required",
    "deedRequired": false,
    "amlMonitoring": false,
    "amlMonitoringFrequency": "Monthly",
    "amlLastScreenedAt": "",
    "amlNextScreeningAt": "",
    "amlMonitoringAlert": false
  }
}
```

{% endtab %}

{% tab title="400" %}

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

{% endtab %}
{% endtabs %}

{% hint style="info" %}
**`incorporatedOn` format.** `incorporatedOn` is text, passed through as the registry supplies it. For companies registered with ASIC it's `DD-MM-YYYY` (for example `12-12-2020`), so parse it as day-month-year. Dates from other registries can use a different format, for example trusts from the Australian Business Register, as in the trust example above.
{% endhint %}

{% hint style="info" %}
If your flow contains a custom questionnaire, see [Retrieving entity questionnaire answers](https://manual.personr.co/api-documentation/entity-results/retrieving-entity-questionnaire-answers.md) to retrieve the questions and answers.
{% endhint %}

#### Applicant Status Types

`Created` The entity has been created.

<mark style="color:blue;">`Pre-checked`</mark> The entity's documents are being processed.

<mark style="color:orange;">`Pending`</mark> The entity's data is being processed.

<mark style="color:green;">`Reviewed`</mark> The verification is complete, and results are ready.

#### Review Answer Types

<mark style="color:green;">`Approved`</mark> The entity has successfully been verified.

<mark style="color:red;">`Rejected`</mark> The entity wasn't able to be verified. Look at `rejectLabels` to see why.

{% hint style="info" %}
See the next page for a list of rejection labels, and what they mean.
{% endhint %}

#### Trust deed status

`trustDeedStatus` tells you whether the entity needs a trust deed before customer due diligence is complete. It matches the "Deed required" label in the dashboard.

| Value          | Meaning                                                                          |
| -------------- | -------------------------------------------------------------------------------- |
| `not_required` | The entity isn't a trust, super fund or similar structure, so no deed is needed. |
| `required`     | A deed is needed and hasn't been uploaded yet.                                   |
| `uploaded`     | A deed has been uploaded but hasn't been confirmed yet.                          |
| `confirmed`    | The deed has been uploaded and confirmed.                                        |

`deedRequired` is `true` while the status is `required` or `uploaded`, and `false` otherwise. Upload the deed on the entity's page in the dashboard, then select **Analyse deed** to confirm it.

#### Ongoing AML monitoring

These fields show whether the entity is being re-screened against AML sources after verification. Monitoring is set per KYB flow; see [AML match webhook](https://manual.personr.co/api-documentation/entity-results/retrieving-entity-verification-results/setting-up-a-webhook/aml-match-webhook.md).

| Field                    | Description                                                                                              |
| ------------------------ | -------------------------------------------------------------------------------------------------------- |
| `amlMonitoring`          | `true` when the entity's flow has ongoing AML monitoring turned on.                                      |
| `amlMonitoringFrequency` | `Daily`, `Weekly` or `Monthly`.                                                                          |
| `amlLastScreenedAt`      | When the entity was last re-screened (ISO 8601, UTC). Empty until the first re-screen.                   |
| `amlNextScreeningAt`     | When the next re-screen is scheduled (ISO 8601, UTC). Empty when monitoring is off or not scheduled yet. |
| `amlMonitoringAlert`     | `true` when a re-screen found a new match that hasn't been marked as reviewed in the dashboard yet.      |


---

# Agent Instructions
This documentation is published with GitBook. GitBook is the documentation platform designed so that both humans and AI agents can read, navigate, and reason over technical content effectively. Learn more at gitbook.com.

## Querying This Documentation
If you need additional information that is not directly available in this page, you can query the documentation by asking a question.

Perform an HTTP GET request on the following URL with the `ask` and `goal` query parameters:

```
GET https://manual.personr.co/api-documentation/entity-results/retrieving-entity-verification-results.md?ask=<question>&goal=<user_goal>
```

`ask` is the immediate question: it should be specific, self-contained, and written in natural language.
`goal` is what the user is ultimately trying to achieve, the reason they need the answer. Sharing it helps GitBook give you a better, more relevant answer. A goal is most helpful when it describes the outcome the user wants rather than restating the question. For example, with `ask=how do I create an API token`, a goal like `automate deployments from our CI pipeline` lets GitBook tailor the answer to that use case.

The response will contain a direct answer to the question and relevant excerpts and sources from the documentation.

Use this mechanism when the answer is not explicitly present in the current page, you need clarification or additional context, or you want to retrieve related documentation sections.
