Get User Digital Identity Images

✅ Overview and Workflow

Goal:

To retrieve a user's Digital Identity Images securely using admin access.

---

1- List the images URLs

🔐 Requires: Admin Access Token (with "Requests" permission)

• Purpose: Fetches metadata (filenames + transaction ID) for 3 identity-related images:

  • Front of ID

  • Back of ID

  • Liveness (face) image

• Input: emailOrPhoneNumber query parameter

• Response: URLs that reference images hosted on the API, built using fileName and transactionId

get

Query parameters

emailOrPhoneNumberstringOptional

Responses

200

Success

text/plainapplication/jsontext/json

get

/api/DigitalIdentity/GetUserDigitalIdentityImages

HTTPcURLJavaScriptPython

GET /api/DigitalIdentity/GetUserDigitalIdentityImages HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "data": {
    "idFrontImage": "text",
    "idBackImage": "text",
    "livenessImage": "text",
    "livenessFace01Image": "text",
    "livenessFace02Image": "text",
    "livenessFace03Image": "text"
  },
  "error_code": 1,
  "error_message": "text",
  "error_descriptions": null
}

---

2- Retrieve a specific image

🔐 Requires: Admin Access Token

• Purpose: Given a transactionId and fileName from step 1, returns the base64 representation of the requested image.

• Input:

  • TransactionId: GUID

  • FileName: Filename of the image

• Response: Base64 string of the image

get

Query parameters

TransactionIdstringOptional

FileNamestringOptional

ImpersonatedTenantIdinteger · int32Optional

LogIdstringOptional

Responses

200

Success

text/plainapplication/jsontext/json

get

/api/DigitalIdentity/GetStepImage

HTTPcURLJavaScriptPython

GET /api/DigitalIdentity/GetStepImage HTTP/1.1
Host: 
Accept: */*

200

Success

{
  "data": {
    "image": "Ynl0ZXM="
  },
  "error_code": 1,
  "error_message": "text",
  "error_descriptions": null
}