Generating a verification link

Once you've created an entity, you can generate a hosted link for verification.

This endpoint allows you to generate a hosted verification link, where applicants can upload their documents and verify themselves on your chosen flow.

By default, verification links are hosted on our domain https://enterprise.personr.co and are easily embeddable into your website or mobile application.

Once an entity has finished uploading their documents, the verification will process automatically. You can go to Retrieving entity verification results to retrieve the results, or create a webhook by going to Setting up a webhook.

Example Verification Screen

Whitelabelling is available upon request. This allows you to customise the verification screens' logo, and colours to align with your brand. Additionally, you can add custom questions that an entity needs to answer. Reach out to your account manager to discuss your options.

We support all device types and modern browsers for verification.

Generate a verification link

POST /api-entity-verificationlink-create

Generate a verification link, to send to an entity.

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-entity-verificationlink-create' \
--form 'applicant="4242424242424x424242424242424242"'

var axios = require('axios');
var FormData = require('form-data');
var data = new FormData();
data.append('applicant', '4242424242424x424242424242424242');

var config = {
  method: 'post',
maxBodyLength: Infinity,
  url: 'https://enterprise.personr.co/api/1.1/wf/api-entity-verificationlink-create',
  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("applicant", "4242424242424x424242424242424242");

var settings = {
  "url": "https://enterprise.personr.co/api/1.1/wf/api-entity-verificationlink-create",
  "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-entity-verificationlink-create")

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

request = Net::HTTP::Post.new(url)
form_data = [['applicant', '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-entity-verificationlink-create"

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

]
headers = {}

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

print(response.text)

Response

{
  "status": "success",
  "response": {
    "verificationLink": "https://enterprise.personr.co/entity-verification/4242424242424x424242424242424242",
    "customLink": "https://your-custom-domain.com/entity-verification/4242424242424x424242424242424242"
  }
}

{
    "statusCode": 400,
    "message": "Error: incorrect applicantId provided"
}

Verification Link

The verificationLink key contains the standard enterprise.personr.co domain that entities can access to provide information and go through the flow.

Custom Link

The customLink key contains the custom domain that you have linked to the platform. To return a custom link with this endpoint, you need to specify the domain you wish to use when editing or creating a flow.

Custom links default to enterprise.personr.co if you have not specified which domain you'd like to use when creating or editing a flow.

Verification links aren't sent to an applicant's email or phone number by default.

For more customisation and control over what your users see, upload documents directly via API instead. Head to the next page to read more.

PreviousCreating an entity NextUploading documents to an entity

Last updated 1 year ago

Was this helpful?