Create an embedded auth session | Vlens

Create a session token for a user identified by phone number or email. This token is used to launch the Vlens iframe or WebView for that user, embedding the full verification and contracting UX inside your own application.

Authentication: Requires only the ApiKey header — no admin bearer token.

Authentication

ApiKeystring

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

Request

This endpoint expects an object.

phoneNumberstring or nullOptional

emailstring or nullOptionalformat: "email"

userPublicKeystring or nullOptional

Optional RSA public key to encrypt the session token.

sessionPermissionsobjectOptional

Controls which features and contract types are available in the session.

Response

Session token. Use this to initialize the Vlens iframe.

datastring or null

error_codeinteger or null

error_messagestring or null

error_descriptionsany or null

$	curl -X POST https://api.vlenseg.com/api/IdentityUserSession/CreateAuthSession \
>	-H "ApiKey: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"phoneNumber": "+201234567890",
>	"sessionPermissions": {
>	"allowedContractTypeIds": [
>	414
>	],
>	"minimalSignatureFlow": true,
>	"DigitalIdentityOnly": false
>	}
>	}'

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

$	curl -X POST https://api.vlenseg.com/api/IdentityUserSession/CreateAuthSession \
>	-H "ApiKey: <apiKey>" \
>	-H "Content-Type: application/json" \
>	-d '{
>	"phoneNumber": "+201234567890",
>	"sessionPermissions": {
>	"allowedContractTypeIds": [
>	414
>	],
>	"minimalSignatureFlow": true,
>	"DigitalIdentityOnly": false
>	}
>	}'

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