v4

latestSwagger 2.02026-08-033766226.9 KB

WebVerifications

Retrieves secure links to web verification pages searching by the Reference Id.

It may return none, one or many (up to 20) matching results. Each result contains a secure url; UTC date/time of when the link expires; name details of a person associated with the registration.

post/api/web-verifications/by-referenceid

Headers

apikeystring required

ApiKey supplied.

Request body

referenceIdstring required

Example request

{
  "referenceId": "JD0387152001",
  "returnUrls": {
    "returnUrl": "https://www.company.co.uk/registration-completed"
  }
}

Response

Results of the query