For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Dashboard
HomeAPI Reference
HomeAPI Reference
  • Overview
    • API Overview
  • Vlens API
      • POSTScan national ID front
      • POSTScan national ID back
      • POSTPerform liveness check
      • GETList user identity image references
      • GETDownload verification image (base64)
      • POSTLink user to existing OCR transaction
Dashboard
LogoLogo
Vlens APIDigital Identity

List user identity image references

||View as Markdown|
GET
https://api.vlenseg.com/api/DigitalIdentity/GetUserDigitalIdentityImages
GET
/api/DigitalIdentity/GetUserDigitalIdentityImages
$curl -G https://api.vlenseg.com/api/DigitalIdentity/GetUserDigitalIdentityImages \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     --data-urlencode emailOrPhoneNumber=+201234567890
200Retrieved
1{
2  "data": {
3    "idFrontImage": "user123_id_front_20240601.jpg",
4    "idBackImage": "user123_id_back_20240601.jpg",
5    "livenessImage": "user123_liveness_20240601.jpg",
6    "livenessFace01Image": "user123_liveness_face1_20240601.jpg",
7    "livenessFace02Image": "user123_liveness_face2_20240601.jpg",
8    "livenessFace03Image": "user123_liveness_face3_20240601.jpg"
9  },
10  "error_code": null,
11  "error_message": null,
12  "error_descriptions": null
13}

Retrieve file name references for a user’s stored verification images (ID front, ID back, liveness). Use the returned file names with GetStepImage to download the actual image data.

Requires admin access token with Requests permission.

Was this page helpful?
Previous

Perform liveness check

Next

Download verification image (base64)

Built with

Authentication

ApiKeystring
Static API key issued to your tenant. Obtain from the Vlens dashboard.
AuthorizationBearer

Short-lived JWT. Obtain via:

  • /api/credentials/Login for admin / service tokens
  • /api/DigitalIdentity/Register or login for end-user tokens

Query parameters

emailOrPhoneNumberstringRequired
The user's email address or phone number.

Response

Image file references for the user's verification.
dataobject
File name references for a user's stored verification images.
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null