API Overview

Get started with the Vlens REST API

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

1 ApiKey: YOUR_TENANT_API_KEY
2 Authorization: Bearer YOUR_ACCESS_TOKEN

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

Response envelope

1 {
2   "data": { ... },
3   "error_code": null,
4   "error_message": null,
5   "error_descriptions": null
6 }

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

API groups

Group	Base path	Description
Authentication	`/api/credentials/`	Admin and service-to-service tokens
Registration	`/api/DigitalIdentity/Register/`	User registration via phone/email OTP
Digital Identity	`/api/DigitalIdentity/`	National ID scanning and liveness verification
Business Request	`/api/BusinessRequest/`	E-contracting lifecycle
Identity User Session	`/api/IdentityUserSession/`	Iframe / WebView session tokens

Browse the full reference using the navigation on the left.

1	ApiKey: YOUR_TENANT_API_KEY
2	Authorization: Bearer YOUR_ACCESS_TOKEN

1	{
2	"data": { ... },
3	"error_code": null,
4	"error_message": null,
5	"error_descriptions": null
6	}