action credas_add_registration {
label: "Creates new registration."
provider: credas
method: POST
path: "/api/registrations"
encoding: json
input: {
type: "object"
properties: {
apikey: {
type: "string"
}
diallingCode: {
type: "string"
}
duplicateAcknowledgement: {
type: "boolean"
}
emailAddress: {
type: "string"
}
forename: {
type: "string"
}
middleName: {
type: "string"
}
parameters: {
type: "array"
items: {
type: "object"
properties: {
key: {
type: "string"
}
value: {
type: "string"
}
}
}
}
phoneNumber: {
type: "string"
}
provideWebJourneyLink: {
type: "boolean"
}
referenceId: {
type: "string"
}
regTypeId: {
type: "string"
format: "uuid"
}
returnUrls: {
type: "object"
properties: {
returnUrl: {
type: "string"
}
}
}
sendEmail: {
type: "boolean"
}
sendSms: {
type: "boolean"
}
settings: {
type: "object"
properties: {
capturePersonalDetails: {
type: "boolean"
}
nameMatchRoutine: {
type: "integer"
format: "int32"
description: "Fuzzy = 1, Strict = 2"
enum: [1, 2]
}
requiredChecks: {
type: "array"
description: "The value of required checks determines what checks are performed.
Unknown = 0,Id Documents = 1, Standard Checks = 2, International Sanctions and Pep = 3, Credit Status Check = 4, Bank Account Check = 5, Proof of Ownership = 6, Right to Work = 7, Right to Rent = 8
"
items: {
type: "integer"
format: "int32"
enum: [0, 1, 2, 3, 4, 5, 6, 7, 8]
}
}
skipEmailStep: {
type: "boolean"
}
}
}
significantPersonId: {
type: "string"
format: "uuid"
}
surname: {
type: "string"
}
}
required: ["apikey", "forename", "regTypeId", "sendSms", "surname"]
additionalProperties: false
}
output: {
type: "object"
required: ["id", "regCode"]
properties: {
id: {
type: "string"
format: "uuid"
}
regCode: {
type: "string"
}
webJourneyUrl: {
type: "object"
properties: {
url: {
type: "string"
}
validUntil: {
type: "string"
format: "date-time"
}
}
}
}
}
}