Skip to navigation
Overview

API Overview

Get started with the Vlens REST API
View as Markdown

The Vlens API is a REST API that accepts JSON request bodies and returns JSON responses. Every endpoint shares the same envelope, authentication pattern, and conventions.

Authentication

API keys, bearer tokens, and the refresh flow

Conventions

Response envelope, pagination, dates, IDs, geolocation

Errors

Error envelope, categories, and retry strategy

Webhooks

Real-time event notifications

Base URL

https://api.vlenseg.com

Required headers

ApiKey: YOUR_TENANT_API_KEY
Authorization: Bearer YOUR_ACCESS_TOKEN

Some public registration endpoints require only the ApiKey. See Authentication for full details.

Response envelope

{
  "data": { ... },
  "error_code": null,
  "error_message": null,
  "error_descriptions": null
}

Paginated list endpoints add totalCount and returnedCount. Errors are signalled via error_code in the envelope — not via HTTP status.

API groups

GroupBase pathDescription
Credentials/api/credentials/Admin login, token refresh
Registration (standard)/api/DigitalIdentity/Register/Phone/email OTP → StepCreate → then verify/* KYC
Consent-based Digital Identity (CDI)/api/DigitalIdentity/Register/hasCDI → StepVerifyCDI → StepCreate with SkipEmail — guide
User authentication/api/DigitalIdentity/User login, refresh token, logout, hosted register/login links
Digital Identity/api/DigitalIdentity/verify/National ID OCR, liveness, CSO/NTRA verification
Verification data/api/DigitalIdentity/GetUserDigitalIdentity*OCR fields and images (admin); native LinkUserWithExistingTransaction after pre-login capture
Account Management/api/DigitalIdentity/Delete account, cancel verified identity, update email/phone, forgot password
Business Request/api/BusinessRequest/E-contracting lifecycle — create, approve, sign
Transactions/api/Transactions/Look up OCR and Digital Identity transaction records by ID
Identity Session/api/IdentityUserSession/Iframe/WebView sessions — login, register, contract create/sign

Browse the full reference using the navigation on the left.