CRcredas
Registrations

Sets an override for a specific check on the registration.

put/api/registrations/{id}/override-check-status

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/registrations/{id}/override-check-status
  • Auth
    none declared. Required headers: apikey

Path parameters

idstring uuid required

Id of the registration.

Headers

apikeystring required

ApiKey supplied.

Request body

checkType0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 required

IdDocuments = 1, StandardChecks = 2, InternationalSanctionsAndPep = 3, CreditStatusCheck = 4, BankAccountCheck = 5, ProofOfOwnership = 6, RightToWork = 7, RightToRent = 8

status0 | 1 | 2 | 3 required

Unknown = 0, Pass = 1, Refer = 2, Fail = 3

commentstring required

Example request

{
  "checkType": 1,
  "status": 1,
  "comment": "Documents look genuine."
}

Response

Status of the operation.

Changes

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