> 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/applicant-results/tracking-verification-progress.md).

# Tracking verification progress

See which step of the verification an applicant has reached.

Use this endpoint to see where an applicant is up to: whether the link has been sent or opened, whether they've submitted their documents, and whether the result is being processed or is ready.

***

## Retrieving progress

<mark style="color:green;">`POST`</mark> `/api-verification-progress`

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

**Body**

| Name          | Type   | Description                                                                                   |
| ------------- | ------ | --------------------------------------------------------------------------------------------- |
| `applicantId` | string | Unique applicantId generated on applicant creation <mark style="color:red;">(required)</mark> |

#### Request

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

```sh
curl --location 'https://enterprise.personr.co/api/1.1/wf/api-verification-progress' \
--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');

axios({
  method: 'post',
  url: 'https://enterprise.personr.co/api/1.1/wf/api-verification-progress',
  headers: { 'Authorization': 'Bearer YOUR_TOKEN', ...data.getHeaders() },
  data: data
})
.then(function (response) { console.log(JSON.stringify(response.data)); })
.catch(function (error) { console.log(error); });
```

{% endtab %}

{% tab title="Python" %}

```python
import requests

url = "https://enterprise.personr.co/api/1.1/wf/api-verification-progress"
payload = {'applicantId': '4242424242424x424242424242424242'}
headers = {'Authorization': 'Bearer YOUR_TOKEN'}

response = requests.request("POST", url, headers=headers, data=payload)
print(response.text)
```

{% endtab %}
{% endtabs %}

**Response**

{% tabs %}
{% tab title="200 - Link opened" %}

```json
{
    "status": "success",
    "response": {
        "applicantId": "4242424242424x424242424242424242",
        "currentStep": "link_opened",
        "applicantStatus": "Created",
        "linkStatus": "Incomplete",
        "linkAccessed": true,
        "documentsSubmitted": false,
        "documentTypes": []
    }
}
```

{% endtab %}

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

```json
{
    "status": "success",
    "response": {
        "applicantId": "4242424242424x424242424242424242",
        "currentStep": "reviewed",
        "applicantStatus": "Reviewed",
        "linkStatus": "Completed",
        "linkAccessed": true,
        "documentsSubmitted": true,
        "documentTypes": ["PASSPORT", "SELFIE"],
        "reviewAnswer": "Approved"
    }
}
```

{% endtab %}
{% endtabs %}

#### Response fields

| Field                | Type    | Description                                                                                                                                                                           |
| -------------------- | ------- | ------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- |
| `currentStep`        | string  | The step the applicant has reached. See **Steps** below                                                                                                                               |
| `applicantStatus`    | string  | The applicant's status, as in [Retrieving applicant verification results](https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results.md) |
| `linkStatus`         | string  | Status of the most recent onboarding link, as in [Checking onboarding link status](https://manual.personr.co/api-documentation/applicant-results/checking-onboarding-link-status.md)  |
| `linkAccessed`       | boolean | `true` once the applicant has opened their link                                                                                                                                       |
| `documentsSubmitted` | boolean | `true` once ID or selfie images have been received                                                                                                                                    |
| `documentTypes`      | array   | Types of the images received, e.g. `PASSPORT`, `DRIVERS`, `SELFIE`                                                                                                                    |
| `reviewAnswer`       | string  | `Approved` or `Rejected`, once the applicant has been reviewed                                                                                                                        |

#### Steps

In order:

| `currentStep`            | Meaning                                                     |
| ------------------------ | ----------------------------------------------------------- |
| `not_sent`               | No onboarding link has been sent yet                        |
| `link_sent`              | The link was sent but hasn't been opened                    |
| `link_opened`            | The applicant opened the link but hasn't submitted anything |
| `documents_submitted`    | ID and/or selfie received, processing is about to start     |
| `pre_checked`            | Document images are being processed                         |
| `pending`                | Identity data is being processed                            |
| `requires_investigation` | The verification needs a manual review                      |
| `reviewed`               | The verification is complete. See `reviewAnswer`            |

{% hint style="info" %}
Documents are only received once the applicant submits them. An applicant who started the ID or selfie capture but left before submitting shows as `link_opened`.
{% endhint %}


---

# 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/applicant-results/tracking-verification-progress.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.
