action credas_get_id_document_images { label: "Get all id document images associated with a registration." provider: credas method: GET path: "/api/images/id-document/{registrationId}" encoding: json input: { type: "object" properties: { apikey: { type: "string" } registrationId: { type: "string" format: "uuid" } } required: ["apikey", "registrationId"] additionalProperties: false } output: { type: "array" items: { type: "object" required: ["url", "hiResUrl", "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" } hiResUrl: { 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" } nfcFacialUrl: { type: "string" } 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" } url: { type: "string" } } } } }