> 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/checking-onboarding-link-status.md).

# Checking onboarding link status

Check whether an applicant has opened their verification link, and when.

Use this endpoint to see whether an applicant has opened the verification link you sent them, when they last accessed it, and whether it has been completed or has expired. It answers questions like *"did they open it, or never click it?"* without waiting for a result.

It reads the applicant's **most recent** onboarding link.

***

## Retrieving the link status

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

| 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-onboarding-link-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');

axios({
  method: 'post',
  url: 'https://enterprise.personr.co/api/1.1/wf/api-onboarding-link-status',
  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-onboarding-link-status"
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 - Opened, not finished" %}

```json
{
    "status": "success",
    "response": {
        "applicantId": "4242424242424x424242424242424242",
        "linkId": "4343434343434x434343434343434343",
        "linkStatus": "Incomplete",
        "linkAccessed": true,
        "sentAt": 1792987500000,
        "firstOpenedAt": 1792987560883,
        "lastAccessedAt": 1792987568589,
        "sessionCount": 1,
        "expired": false
    }
}
```

{% endtab %}

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

```json
{
    "status": "success",
    "response": {
        "applicantId": "4242424242424x424242424242424242",
        "linkId": "4343434343434x434343434343434343",
        "linkStatus": "Completed",
        "linkAccessed": true,
        "sentAt": 1792987500000,
        "firstOpenedAt": 1792987560883,
        "lastAccessedAt": 1792987568589,
        "sessionCount": 1,
        "completedAt": 1793000454719,
        "expired": false
    }
}
```

{% endtab %}

{% tab title="200 - Not opened" %}

```json
{
    "status": "success",
    "response": {
        "applicantId": "4242424242424x424242424242424242",
        "linkId": "4343434343434x434343434343434343",
        "linkStatus": "Sent",
        "linkAccessed": false,
        "sentAt": 1792987500000,
        "sessionCount": 0,
        "expired": false
    }
}
```

{% endtab %}
{% endtabs %}

Dates are Unix timestamps in milliseconds. Fields with no value are left out of the response.

#### Response fields

| Field            | Type    | Description                                                 |
| ---------------- | ------- | ----------------------------------------------------------- |
| `linkId`         | string  | ID of the most recent onboarding link                       |
| `linkStatus`     | string  | See **Link status types** below                             |
| `linkAccessed`   | boolean | `true` once the applicant has opened the link at least once |
| `sentAt`         | date    | When the link was sent (email, or SMS if no email was sent) |
| `firstOpenedAt`  | date    | When the applicant first opened the link                    |
| `lastAccessedAt` | date    | When the applicant most recently opened the link            |
| `sessionCount`   | number  | How many times the link has been opened                     |
| `completedAt`    | date    | When the applicant's verification result was recorded       |
| `expired`        | boolean | `true` if the link can no longer be used                    |

#### Link status types

`Sent` The link has been sent, but not opened.

<mark style="color:blue;">`Opened`</mark> The applicant has opened the link and hasn't submitted yet.

<mark style="color:orange;">`Incomplete`</mark> The applicant opened the link but nothing was submitted within 60 minutes. They can still reopen the link and finish, as long as it hasn't expired.

<mark style="color:green;">`Completed`</mark> The applicant's verification has been submitted and a result recorded.

<mark style="color:red;">`Expired`</mark> The link has expired. Send the applicant a new one with [Generating a verification link](https://manual.personr.co/api-documentation/applicants/generating-a-verification-link.md).

{% hint style="info" %}
To be notified when an applicant opens their link or drops off, rather than polling, see [Onboarding webhooks](https://manual.personr.co/api-documentation/applicant-results/retrieving-applicant-verification-results/setting-up-a-webhook/onboarding-webhooks.md).
{% 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/checking-onboarding-link-status.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.
