v4

latestSwagger 2.02026-08-033766226.9 KB

Registrations

Finds registrations by the ReferenceId.

get/api/registrations/referenceid/{referenceId}/summary

Path parameters

referenceIdstring required

ReferenceId - from external system to match Registrations on.

Headers

apikeystring required

ApiKey supplied.

Response

Collection of Registration summary objects.

referenceIdstring

dateCreatedstring date-time required

status0 | 1 | 2 | 3 | 4 | 6 required

Unknown = 0, Submitted = 1, Approved = 2, Rejected = 3, Exported = 4, Invited = 6

livenessVerifiedboolean required

livenessStatus0 | 1 | 2 | 3 | 4 required

NotSubmitted = 0, Verified = 1, Unverified = 2, Unknown = 3, RetakeRequested = 4

rightToWorkDocumentsProvided0 | 1 | 2 required

This property is no longer supported. Right to work is now available as an individual check.<br /> values=> Pending = 0, Pass = 1, Fail = 2

dataChecksPerformedboolean required

dataCheckResult0 | 1 | 2 | 3 required

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

emailstring

phoneNumberstring

forenamestring required

middleNamestring

surnamestring required

regTypeIdstring uuid required

isAgentLedboolean

livenessMethod0 | 1 | 2

NotApplicable = 0, UniqueActionProcess = 1, Passive = 2

customTermsAcceptedboolean

customTermsAcceptedDateTimestring date-time

customTermsAcceptedVersioninteger

createdByAgencyUserIdstring uuid

hasSelfieboolean

dateCompletedstring date-time

hasLivenessPerformedboolean

DITFStatus0 | 1 | 2

No = 0, Yes = 1, Pending = 2

DITFDatestring date-time

safeHarbourVerifiedStatus0 | 1 | 2

No = 0, Yes = 1, UnderReview = 2

safeHarbourVerifiedDatestring date-time

IsExpiredboolean

VerifiedInAppDatestring date-time

CreatedByAgencyUserEmailstring

idstring uuid required

regCodestring required