CRcredas
DataChecks

Creates new data check against a specified registration.

post/api/datachecks

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/datachecks
  • Auth
    none declared. Required headers: apikey

Headers

apikeystring required

ApiKey supplied.

Request body

regEntryIdstring uuid required
checkType0 | 1 | 2 | 3 required

The value of checkType dictates what checks are performed. <br/>The StandardAml check (value = 1) will check DOB & Mortality. <br/>The InternationalPepSanctions check (value = 3) will check just International PEP & Sanctions. <br/>The EnhancedAml check (value = 2) will perform both these checks and is equivalent to making two calls with values of 1 then 3 and will be charged accordingly. <br /> values=> None = 0, StandardAml = 1, EnhancedAml = 2, InternationalPepSanctions = 3

Example request

{
  "regEntryId": "141dbb24-c4ff-4658-9556-15ea25428d48",
  "checkType": 2,
  "person": {
    "forename": "Angela",
    "middleName": null,
    "surname": "UK Specimen",
    "dateOfBirth": "1988-12-04T00:00:00"
  },
  "currentAddress": {
    "addressLine1": "25 Westgate Street",
    "addressLine2": "",
    "addressLine3": "",
    "city": "Cardiff",
    "postcode": "CF101NS",
    "county": "Cardiff",
    "country": "United Kingdom"
  }
}

Response

Details of newly added data check.

idstring uuid required
regCodestring required

Changes

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