Generating a verification link
Once you've created an applicant, 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. A custom domain can be configured from within the platform if you intend to self-host.
Once an individual has finished uploading their documents, the verification will trigger and process automatically. You can go to Retrieving applicant verification results to retrieve the results, or create a webhook by going to Setting up a webhook.
Webhooks are the recommended method for integration.
Example Verification Screen

Whitelabelling is available upon request. This allows you to customise the verification screens' logo, font, and colours to align with your brand. 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-verificationlink-create
Generate a verification link, to send to an applicant.
Headers
Content-Type
multipart/form-data
Authorization
Bearer YOUR_TOKEN
Body
applicant
string
Unique applicantId generated on applicant creation (required)
returnUrl
string
Where to send the applicant once they've finished verifying (optional). Must be a full URL starting with https://, or your app's own scheme for a deep link (for example myapp://verification-complete). Overrides the flow's Return URL. See Returning applicants to your app or website.
Request
Response
returnUrl is only included when you sent one.
No link is created. Check response.error and fix the URL before trying again.
Verification Link
The verificationLink key contains the standard enterprise.personr.co domain that applicants 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.
Returning applicants to your app or website
Applicants can be sent back to your app or website automatically once they've finished and their verification has been recorded, usually a few seconds after they submit. There are two ways to set where they go:
On the flow: in the dashboard, open the flow and add a Return URL under its settings. Every link on that flow uses it, including links you create in the dashboard.
On the link: send
returnUrlwhen you create the link. This overrides the flow's Return URL for that link only, so you can include your own reference in it (for example?ref=12345).
With neither set, applicants stay on our completion screen.
Use an
https://URL to send them to a page on your website, or your app's own scheme (for examplemyapp://verification-complete) to reopen your mobile app.Being redirected only means the applicant has finished. Always confirm the outcome with a webhook or Retrieving applicant verification results before acting on it.
Last updated
Was this helpful?