CRcredas
WebVerifications

Retrieves secure link to web verification page searching by the Registration Id.

It may return none or one matching result. 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-registrationid

Request

  • Base URL
    https://pi-api.credas.co.uk (the document declares no server; this is the origin it was published from)
  • URL
    https://pi-api.credas.co.uk/api/web-verifications/by-registrationid
  • Auth
    none declared. Required headers: apikey

Headers

apikeystring required

ApiKey supplied.

Request body

registrationIdstring uuid required

Example request

{
  "registrationId": "4bf4db0a-1c0c-4acd-8e92-701f55163891",
  "returnUrls": {
    "returnUrl": "https://www.company.co.uk/registration-completed"
  }
}

Response

Results of the query

Changes

No recorded changes to this operation across all 10 revisions of this API.