action credas_get_registration_summary {
label: "Finds a registration by the Id."
provider: credas
method: GET
path: "/api/registrations/{id}/summary"
encoding: json
input: {
type: "object"
properties: {
apikey: {
type: "string"
}
id: {
type: "string"
format: "uuid"
}
}
required: ["apikey", "id"]
additionalProperties: false
}
output: {
type: "object"
required: ["dataCheckResult", "dataChecksPerformed", "dateCreated", "forename", "id", "livenessStatus", "livenessVerified", "regCode", "regTypeId", "rightToWorkDocumentsProvided", "status", "surname"]
properties: {
Comments: {
type: "array"
items: {
type: "object"
properties: {
checkType: {
type: "integer"
format: "int32"
description: "IdDocuments = 1, StandardChecks = 2, InternationalSanctionsAndPep = 3, CreditStatusCheck = 4, BankAccountCheck = 5, ProofOfOwnership = 6, RightToWork = 7, RightToRent = 8"
enum: [0, 1, 2, 3, 4, 5, 6, 7, 8]
}
comment: {
type: "string"
}
dateCreated: {
type: "string"
format: "date-time"
}
id: {
type: "string"
format: "uuid"
}
name: {
type: "string"
}
type: {
type: "integer"
format: "int32"
description: "General = 0, CheckRelated = 1"
enum: [0, 1]
}
}
}
}
DITFDate: {
type: "string"
format: "date-time"
}
DITFStatus: {
type: "integer"
format: "int32"
description: "No = 0, Yes = 1, Pending = 2"
enum: [0, 1, 2]
}
bankAccountChecks: {
type: "array"
items: {
type: "object"
properties: {
Address1: {
type: "string"
}
City: {
type: "string"
}
Forename: {
type: "string"
}
MiddleName: {
type: "string"
}
PostCode: {
type: "string"
}
Surname: {
type: "string"
}
accountNumber: {
type: "string"
}
accountNumberValidation: {
type: "integer"
format: "int32"
description: "Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, SevenDigitsMatched = 4, SixDigitsMatched = 5"
enum: [0, 1, 2, 3, 4, 5]
}
accountNumberValidationText: {
type: "string"
}
accountStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, NoMatch = 1, Live = 2, ClosedOrSettled = 3"
enum: [0, 1, 2, 3]
}
accountStatusText: {
type: "string"
}
accountValid: {
type: "boolean"
}
addressValidation: {
type: "integer"
format: "int32"
description: "Unknown = 0, NoMatch = 1, CurrentAddress = 2, PreviousAddress = 3, ForwardingAddress = 4"
enum: [0, 1, 2, 3, 4]
}
addressValidationText: {
type: "string"
}
checkDate: {
type: "string"
format: "date-time"
}
checkId: {
type: "string"
format: "uuid"
}
checkStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
error: {
type: "boolean"
}
hasBeenOverridden: {
type: "boolean"
}
nameValidation: {
type: "integer"
format: "int32"
description: "Unknown = 0, NoMatch = 1, Valid = 2"
enum: [0, 1, 2]
}
nameValidationText: {
type: "string"
}
referenceId: {
type: "string"
}
sortcode: {
type: "string"
}
sortcodeValidation: {
type: "integer"
format: "int32"
description: "Unknown = 0, NoMatch = 1, Valid = 2, Invalid = 3, FiveDigitsMatched = 4"
enum: [0, 1, 2, 3, 4]
}
sortcodeValidationText: {
type: "string"
}
}
}
}
createdByAgencyUserId: {
type: "string"
format: "uuid"
}
creditStatusCheck: {
type: "object"
properties: {
address: {
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"
}
}
}
ccj: {
type: "array"
items: {
type: "object"
properties: {
address1: {
type: "string"
}
address2: {
type: "string"
}
address3: {
type: "string"
}
address4: {
type: "string"
}
address5: {
type: "string"
}
amount: {
type: "string"
}
caseNumber: {
type: "string"
}
courtName: {
type: "string"
}
dateEnd: {
type: "string"
format: "date-time"
}
dob: {
type: "string"
format: "date-time"
}
judgementDate: {
type: "string"
format: "date-time"
}
judgementType: {
type: "integer"
format: "int32"
description: "Unknown = 0, Judgement = 1, Satisfaction = 2, Revocation = 3, SetAside = 4, AdministrationOrder = 5"
enum: [0, 1, 2, 3, 4, 5]
}
judgementTypeText: {
type: "string"
}
name: {
type: "string"
}
postcode: {
type: "string"
}
}
}
}
checkDate: {
type: "string"
format: "date-time"
}
companyDirector: {
type: "array"
items: {
type: "object"
properties: {
companyAppointments: {
type: "array"
items: {
type: "object"
properties: {
address: {
type: "string"
}
appointmentDate: {
type: "string"
format: "date-time"
}
appointmentType: {
type: "string"
}
dob: {
type: "string"
format: "date-time"
}
name: {
type: "string"
}
nationality: {
type: "string"
}
occupation: {
type: "string"
}
title: {
type: "string"
}
}
}
}
companyName: {
type: "string"
}
companyRegNo: {
type: "string"
}
dateAppointed: {
type: "string"
format: "date-time"
}
matchType: {
type: "integer"
format: "int32"
description: "Unknown = 0, NameAndDateOfBirth = 1, NameAndAddress = 2, NameAndAddressAndDateOfBirth = 3"
enum: [0, 1, 2, 3]
}
matchTypeText: {
type: "string"
}
registeredOffice: {
type: "string"
}
}
}
}
hasBeenOverridden: {
type: "boolean"
}
insolvency: {
type: "array"
items: {
type: "object"
properties: {
address: {
type: "object"
properties: {
address1: {
type: "string"
}
address2: {
type: "string"
}
address3: {
type: "string"
}
address4: {
type: "string"
}
address5: {
type: "string"
}
dps: {
type: "string"
}
isEmpty: {
type: "boolean"
}
postcode: {
type: "string"
}
}
}
aliases: {
type: "string"
}
assetTotal: {
type: "string"
}
caseNo: {
type: "string"
}
caseType: {
type: "string"
}
court: {
type: "string"
}
debtTotal: {
type: "string"
}
description: {
type: "string"
}
dob: {
type: "string"
format: "date-time"
}
name: {
type: "string"
}
occupation: {
type: "string"
}
presentationDate: {
type: "string"
format: "date-time"
}
previousAddress: {
type: "object"
additionalProperties: true
}
serviceOffice: {
type: "string"
}
startDate: {
type: "string"
format: "date-time"
}
status: {
type: "string"
}
telephoneNumber: {
type: "string"
}
tradingNames: {
type: "string"
}
type: {
type: "integer"
format: "int32"
description: "Unknown = 0, NorthernIrelandBankruptcy = 1, ScottishSequestrationBankruptcy = 2, EnglandAndWalesIVA = 3, EnglandAndWalesDRO = 4, EnglandAndWalesBankruptcy = 5"
enum: [0, 1, 2, 3, 4, 5]
}
typeText: {
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"
}
}
}
status: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
}
}
customTermsAccepted: {
type: "boolean"
}
customTermsAcceptedDateTime: {
type: "string"
format: "date-time"
}
customTermsAcceptedVersion: {
type: "integer"
format: "int32"
}
dataCheckResult: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
dataCheckSources: {
type: "array"
items: {
type: "object"
properties: {
address: {
type: "object"
additionalProperties: true
}
dateCreated: {
type: "string"
format: "date-time"
}
hasBeenOverridden: {
type: "boolean"
}
hasPepSanctionsData: {
type: "boolean"
}
label: {
type: "string"
}
pepSanctionsData: {
type: "array"
items: {
type: "object"
properties: {
addresses: {
type: "array"
items: {
type: "object"
properties: {
lines: {
type: "array"
items: {
type: "object"
additionalProperties: true
}
}
}
}
}
aliases: {
type: "array"
items: {
type: "string"
}
}
fullName: {
type: "string"
}
id: {
type: "string"
}
positions: {
type: "array"
items: {
type: "object"
properties: {
country: {
type: "string"
}
position: {
type: "string"
}
}
}
}
sanctionBodies: {
type: "array"
items: {
type: "string"
}
}
sanctionDates: {
type: "array"
items: {
type: "object"
properties: {
date: {
type: "string"
format: "date-time"
}
day: {
type: "integer"
format: "int32"
}
month: {
type: "integer"
format: "int32"
}
type: {
type: "integer"
format: "int32"
description: "Unknown = 0, Birth = 1, Death = 2"
enum: [0, 1, 2]
}
year: {
type: "integer"
format: "int32"
}
}
}
}
}
}
}
person: {
type: "object"
additionalProperties: true
}
remarks: {
type: "array"
items: {
type: "object"
properties: {
category: {
type: "integer"
format: "int32"
description: "Match = 1, Mismatch = 2, Warning = 3, Comment = 4"
enum: [1, 2, 3, 4]
}
description: {
type: "string"
}
}
}
}
sourceType: {
type: "integer"
format: "int32"
description: "Unknown = 0, EditedElectoralRollUk = 1, LandlineAppendUk = 2, MortalityUk = 3, CreaditHeaderAmlUk = 4, NcoaAlertFlagUk = 5, NcoaAlertFullUk = 6, SanctionsEnhancedInternational = 7, PepEnhancedInternational = 8, NationalIdentityRegisterUk = 9, LandRegistry = 10"
enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
}
status: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
}
}
}
dataChecksPerformed: {
type: "boolean"
}
dateCompleted: {
type: "string"
format: "date-time"
}
dateCreated: {
type: "string"
format: "date-time"
}
email: {
type: "string"
}
forename: {
type: "string"
}
hasLivenessPerformed: {
type: "boolean"
}
hasSelfie: {
type: "boolean"
}
id: {
type: "string"
format: "uuid"
}
idDocuments: {
type: "array"
items: {
type: "object"
required: ["id", "dateCreated", "description", "status", "facialMatch", "nameCheck", "nameCheckMethod", "nfcCheck", "nfcReadStatus"]
properties: {
addressCity: {
type: "string"
}
addressFull: {
type: "string"
}
addressPostcode: {
type: "string"
}
country: {
type: "string"
}
countryCode: {
type: "string"
}
dateCreated: {
type: "string"
format: "date-time"
}
dateOfBirth: {
type: "string"
format: "date-time"
}
description: {
type: "string"
}
documentAnalysisResult: {
type: "integer"
format: "int32"
description: "Unknown = 0, Passed = 1, Refer = 2, Expired = 3, NotSupported = 4, Undefined = 5, Fail = 10, NotPerformed = 11"
enum: [0, 1, 2, 3, 4, 5, 10, 11]
}
documentNumber: {
type: "string"
}
documentSide: {
type: "integer"
format: "int32"
description: "Front = 1, Back = 2"
enum: [0, 1, 2]
}
expiryDate: {
type: "string"
format: "date-time"
}
facialMatch: {
type: "boolean"
}
forename: {
type: "string"
}
fullName: {
type: "string"
}
id: {
type: "string"
format: "uuid"
}
isUnderReview: {
type: "boolean"
}
manuallyVerified: {
type: "boolean"
}
middleName: {
type: "string"
}
mrz1: {
type: "string"
}
mrz2: {
type: "string"
}
mrz3: {
type: "string"
}
nameCheck: {
type: "boolean"
}
nameCheckMethod: {
type: "integer"
format: "int32"
description: "Unknown = 0, Automatic = 1, Manual = 2"
enum: [0, 1, 2]
}
nfcCheck: {
type: "boolean"
}
nfcReadStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Passed = 1, Failed = 2, NotAttempted = 3, Skipped = 4, Unavailable = 5, NotAllowed = 6, NotTrusted = 7, NotApplicable = 8, Expired = 9, UnavailableWebJourney = 10"
enum: [0, 1, 2, 3, 4, 5, 6, 7, 8, 9, 10]
}
primaryScanId: {
type: "string"
format: "uuid"
}
status: {
type: "integer"
format: "int32"
description: "Indicates the verification status of the document itself by combining visual analysis and NFC verification results. Note that this may be a pass even if facial or name matches have failed.
values=> Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
surname: {
type: "string"
}
}
}
}
idVerification: {
type: "object"
properties: {
checkStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
hasBeenOverridden: {
type: "boolean"
}
}
}
isAgentLed: {
type: "boolean"
}
livenessMethod: {
type: "integer"
format: "int32"
description: "NotApplicable = 0, UniqueActionProcess = 1, Passive = 2"
enum: [0, 1, 2]
}
livenessStatus: {
type: "integer"
format: "int32"
description: "NotSubmitted = 0, Verified = 1, Unverified = 2, Unknown = 3, RetakeRequested = 4"
enum: [0, 1, 2, 3, 4]
}
livenessVerified: {
type: "boolean"
}
middleName: {
type: "string"
}
personalDetails: {
type: "object"
properties: {
address: {
type: "object"
additionalProperties: true
}
dateOfBirth: {
type: "string"
format: "date-time"
}
forename: {
type: "string"
}
surname: {
type: "string"
}
}
}
phoneNumber: {
type: "string"
}
proofOfOwnershipCheck: {
type: "object"
properties: {
checkStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
hasBeenOverridden: {
type: "boolean"
}
matchResult: {
type: "integer"
format: "int32"
description: "Unknown = 0, FullNameMatch = 1, SurnameMatch = 2, NoNameMatch = 3, NoAddressMatch = 4, TitleNotRegistered = 5, Unavailable = 6, OutOfHours = 7"
enum: [0, 1, 2, 3, 4, 5, 6, 7]
}
matchResultText: {
type: "string"
}
propertyOwnership: {
type: "integer"
format: "int32"
description: "Unknown = 0, SoleOwnership = 1, JointOwnership = 2"
enum: [0, 1, 2]
}
propertyOwnershipText: {
type: "string"
}
titleNumber: {
type: "string"
}
}
}
referenceId: {
type: "string"
}
regCode: {
type: "string"
}
regTypeId: {
type: "string"
format: "uuid"
}
rightToRentCheck: {
type: "object"
properties: {
checkStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
hasBeenOverridden: {
type: "boolean"
}
hasShareCodePdf: {
type: "boolean"
}
shareCodeFacialMatchStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
shareCodeNameCheckStatus: {
type: "integer"
format: "int32"
description: "Unknown = 0, Pass = 1, Refer = 2, Fail = 3"
enum: [0, 1, 2, 3]
}
}
}
rightToWorkCheck: {
type: "object"
additionalProperties: true
}
rightToWorkDocumentsProvided: {
type: "integer"
format: "int32"
description: "This property is no longer supported. Right to work is now available as an individual check.
values=> Pending = 0, Pass = 1, Fail = 2"
enum: [0, 1, 2]
}
safeHarbourVerifiedDate: {
type: "string"
format: "date-time"
}
safeHarbourVerifiedStatus: {
type: "integer"
format: "int32"
description: "No = 0, Yes = 1, UnderReview = 2"
enum: [0, 1, 2]
}
status: {
type: "integer"
format: "int32"
description: "Unknown = 0, Submitted = 1, Approved = 2, Rejected = 3, Exported = 4, Invited = 6"
enum: [0, 1, 2, 3, 4, 6]
}
surname: {
type: "string"
}
}
}
}