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

Download verification image (base64)

||View as Markdown|
GET
https://api.vlenseg.com/api/DigitalIdentity/GetStepImage
GET
/api/DigitalIdentity/GetStepImage
$curl -G https://api.vlenseg.com/api/DigitalIdentity/GetStepImage \
> -H "ApiKey: <apiKey>" \
> -H "Content-Type: application/json" \
> -d TransactionId=3fa85f64-5717-4562-b3fc-2c963f66afa6 \
> -d FileName=id_front_20240601.png \
> -d ImpersonatedTenantId=1024 \
> -d LogId=log-20240601-xyz123
200Retrieved
1{
2 "data": {
3 "image": "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9h"
4 },
5 "error_code": 0,
6 "error_message": null,
7 "error_descriptions": null
8}

Download a specific verification image as base64-encoded data. Use the transactionId and file name from GetUserDigitalIdentityImages.

Requires admin access token.

Was this page helpful?
Previous

List user identity image references

Next

Link user to existing OCR transaction

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

TransactionIdstringRequiredformat: "uuid"
FileNamestringRequired

File name returned by GetUserDigitalIdentityImages.

ImpersonatedTenantIdintegerOptional
LogIdstringOptional

Response

Base64-encoded image data.

dataobject
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null