---
title: "Get all id document images associated with a registration."
method: GET
path: "/api/images/id-document/{registrationId}"
tags: ["Images"]
---

# Get all id document images associated with a registration.

`GET /api/images/id-document/{registrationId}`

## Path parameters

- `registrationId` string, uuid, required

## Headers

- `apikey` string, required

## Response `200`

Details of the id documents associated with the registration.

- CredasApiModelsImagesGetIdDocumentImageResponse[]
  - `url` string, required
  - `hiResUrl` string, required
  - `nfcFacialUrl` string
  - `id` string, uuid, required
  - `dateCreated` string, date-time, required
  - `description` string, required
  - `status` 0 | 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
  - `facialMatch` boolean, required
  - `nameCheck` boolean, required
  - `nameCheckMethod` 0 | 1 | 2, required — Unknown = 0, Automatic = 1, Manual = 2
  - `nfcCheck` boolean, required
  - `nfcReadStatus` 0 | 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
  - `forename` string
  - `middleName` string
  - `surname` string
  - `fullName` string
  - `dateOfBirth` string, date-time
  - `countryCode` string
  - `country` string
  - `documentNumber` string
  - `expiryDate` string, date-time
  - `addressFull` string
  - `addressPostcode` string
  - `addressCity` string
  - `isUnderReview` boolean
  - `documentAnalysisResult` 0 | 1 | 2 | 3 | 4 | 5 | 10 | 11 — Unknown = 0, Passed = 1, Refer = 2, Expired = 3, NotSupported = 4, Undefined = 5, Fail = 10, NotPerformed = 11
  - `mrz1` string
  - `mrz2` string
  - `mrz3` string
  - `manuallyVerified` boolean
  - `documentSide` 0 | 1 | 2 — Front = 1, Back = 2
  - `primaryScanId` string, uuid

## Other responses

- `400` — If the service was supplied invalid data.
- `401` — If credentials supplied were invalid.
- `403` — If requesting entity have no permission to access the resource.
- `500` — If an unexpected exception occurred whilst processing the request.

---

[API](https://skmtc.dev/credas/apis/credas-api.md) · [All operations](https://skmtc.dev/credas/apis/credas-api/llms.txt) · [OpenAPI document](https://skmtc-service-production.skmtc.workers.dev/v1/apis/credas/credas-api/revisions/a8dd82736563/schema)