action credas_add_data_check {
label: "Creates new data check against a specified registration."
provider: credas
method: POST
path: "/api/datachecks"
encoding: json
input: {
type: "object"
properties: {
apikey: {
type: "string"
}
checkType: {
type: "integer"
format: "int32"
description: "The value of checkType dictates what checks are performed.
The StandardAml check (value = 1) will check DOB & Mortality.
The InternationalPepSanctions check (value = 3) will check just International PEP & Sanctions.
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.
values=> None = 0, StandardAml = 1, EnhancedAml = 2, InternationalPepSanctions = 3"
enum: [0, 1, 2, 3]
}
currentAddress: {
type: "object"
required: ["addressLine1", "city", "country", "postcode"]
properties: {
addressLine1: {
type: "string"
}
addressLine2: {
type: "string"
}
addressLine3: {
type: "string"
}
city: {
type: "string"
}
country: {
type: "string"
}
county: {
type: "string"
}
postcode: {
type: "string"
}
}
}
person: {
type: "object"
required: ["dateOfBirth", "forename", "surname"]
properties: {
dateOfBirth: {
type: "string"
format: "date-time"
}
forename: {
type: "string"
}
middleName: {
type: "string"
}
surname: {
type: "string"
}
}
}
regEntryId: {
type: "string"
format: "uuid"
}
}
required: ["apikey", "checkType", "currentAddress", "person", "regEntryId"]
additionalProperties: false
}
output: {
type: "object"
required: ["id", "regCode"]
properties: {
id: {
type: "string"
format: "uuid"
}
regCode: {
type: "string"
}
}
}
}