> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.vlenseg.com/llms.txt.
> For full documentation content, see https://docs.vlenseg.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vlenseg.com/_mcp/server.

# API Overview

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.

API keys, bearer tokens, and the refresh flow

Response envelope, pagination, dates, IDs, geolocation

Error envelope, categories, and retry strategy

Real-time event notifications

***

## Base URL

```
https://api.vlenseg.com
```

## Required headers

```http
ApiKey: YOUR_TENANT_API_KEY
Authorization: Bearer YOUR_ACCESS_TOKEN
```

Some public registration endpoints require only the `ApiKey`. See [Authentication](/authentication) for full details.

## Response envelope

```json
{
  "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

| 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.