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
POST /api-verification-progress
Content-Type
multipart/form-data
Authorization
Bearer YOUR_TOKEN
Body
applicantId
string
Unique applicantId generated on applicant creation (required)
Request
curl --location 'https://enterprise.personr.co/api/1.1/wf/api-verification-progress' \
--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-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); });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)Response
{
"status": "success",
"response": {
"applicantId": "4242424242424x424242424242424242",
"currentStep": "link_opened",
"applicantStatus": "Created",
"linkStatus": "Incomplete",
"linkAccessed": true,
"documentsSubmitted": false,
"documentTypes": []
}
}{
"status": "success",
"response": {
"applicantId": "4242424242424x424242424242424242",
"currentStep": "reviewed",
"applicantStatus": "Reviewed",
"linkStatus": "Completed",
"linkAccessed": true,
"documentsSubmitted": true,
"documentTypes": ["PASSPORT", "SELFIE"],
"reviewAnswer": "Approved"
}
}Response fields
currentStep
string
The step the applicant has reached. See Steps below
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
Was this helpful?