Requesting to start the verification process

Once you've uploaded all required documents to an entity, you can request to start the verification.

When all documents have been uploaded and UBOs linked (if necessary), use this endpoint to confirm and start the verification process.

Note: You don't need to use this endpoint if you're verifying an entity using a verification link. Verification links submit entities for processing automatically.

Before calling this endpoint, make sure all required documents have been uploaded before confirming to start the verification process. Using this endpoint before uploading documents (if required by your flow) can lead to improper processing of the entity.

Submit the applicant for processing

POST /api-request-applicant-check

Once all documents have been uploaded, start the verification process.

Name

Value

Content-Type

multipart/form-data

Authorization

Bearer YOUR_TOKEN

Body

Name

Type

Description

applicantId

string

Unique applicantId generated on entity creation (required)

Request

curl --location 'https://enterprise.personr.co/api/1.1/wf/api-request-applicant-check' \
--form 'applicantId="4242424242424x424242424242424242"'

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-request-applicant-check',
  headers: { 
    ...data.getHeaders()
  },
  data : data
};

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

var form = new FormData();
form.append("applicantId", "4242424242424x424242424242424242");

var settings = {
  "url": "https://enterprise.personr.co/api/1.1/wf/api-request-applicant-check",
  "method": "POST",
  "timeout": 0,
  "processData": false,
  "mimeType": "multipart/form-data",
  "contentType": false,
  "data": form
};

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

require "uri"
require "net/http"

url = URI("https://enterprise.personr.co/api/1.1/wf/api-request-applicant-check")

https = Net::HTTP.new(url.host, url.port)
https.use_ssl = true

request = Net::HTTP::Post.new(url)
form_data = [['applicantId', '4242424242424x424242424242424242']]
request.set_form form_data, 'multipart/form-data'
response = https.request(request)
puts response.read_body

import requests

url = "https://enterprise.personr.co/api/1.1/wf/api-request-applicant-check"

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

]
headers = {

}

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

print(response.text)

Response

{
  "response": "success"
}

PreviousLinking a UBO to an entity NextRetrieving entity verification results

Last updated 1 year ago

Was this helpful?

hashtagSubmit the applicant for processing

hashtagRequest

Submit the applicant for processing

Request