Sign in

v4

latestSwagger 2.02026-08-033766226.9 KB
Images

Get all id document images associated with a registration.

get/api/images/id-document/{registrationId}

Path parameters

registrationIdstring uuid required

The id of the registration.

Headers

apikeystring required

ApiKey supplied.

Response

Details of the id documents associated with the registration.

urlstring required
hiResUrlstring required
nfcFacialUrlstring
idstring uuid required
dateCreatedstring date-time required
descriptionstring required
status0 | 1 | 2 | 3 required

Indicates the verification status of the document itself by combining visual analysis and NFC verification results. </br>Note that this may be a pass even if facial or name matches have failed.<br /> values=> Unknown = 0, Pass = 1, Refer = 2, Fail = 3

facialMatchboolean required
nameCheckboolean required
nameCheckMethod0 | 1 | 2 required

Unknown = 0, Automatic = 1, Manual = 2

nfcCheckboolean required
nfcReadStatus0 | 1 | 2 | 3 | 4 | 5 | 6 | 7 | 8 | 9 | 10 required

Unknown = 0, Passed = 1, Failed = 2, NotAttempted = 3, Skipped = 4, Unavailable = 5, NotAllowed = 6, NotTrusted = 7, NotApplicable = 8, Expired = 9, UnavailableWebJourney = 10

forenamestring
middleNamestring
surnamestring
fullNamestring
dateOfBirthstring date-time
countryCodestring
countrystring
documentNumberstring
expiryDatestring date-time
addressFullstring
addressPostcodestring
addressCitystring
isUnderReviewboolean
documentAnalysisResult0 | 1 | 2 | 3 | 4 | 5 | 10 | 11

Unknown = 0, Passed = 1, Refer = 2, Expired = 3, NotSupported = 4, Undefined = 5, Fail = 10, NotPerformed = 11

mrz1string
mrz2string
mrz3string
manuallyVerifiedboolean
documentSide0 | 1 | 2

Front = 1, Back = 2

primaryScanIdstring uuid