Skip to content
For the complete documentation index, see llms.txt. This page is also available as Markdown.

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.


POST /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 (required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-onboarding-link-status' \
--header 'Authorization: Bearer YOUR_TOKEN' \
--form 'applicantId="4242424242424x424242424242424242"'
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); });
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)

Response

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

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

Sent The link has been sent, but not opened.

Opened The applicant has opened the link and hasn't submitted yet.

Incomplete 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.

Completed The applicant's verification has been submitted and a result recorded.

Expired The link has expired. Send the applicant a new one with Generating a verification link.

To be notified when an applicant opens their link or drops off, rather than polling, see Onboarding webhooks.

Was this helpful?