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
      • POSTCreate an embedded auth session
      • POSTCreate an invitation with pre-filled data
Dashboard
LogoLogo
Vlens APIIdentity User Session

Create an invitation with pre-filled data

||View as Markdown|
POST
https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation
POST
/api/IdentityUserSession/CreateInvitation
$curl -X POST https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "SessionInput": {
>    "phoneNumber": "+201234567890",
>    "sessionPermissions": {
>      "allowedContractTypeIds": [
>        414
>      ],
>      "minimalSignatureFlow": true,
>      "DigitalIdentityOnly": false
>    },
>    "RequestFieldsValues": {
>      "414": {
>        "fullName": "Ahmed Mohamed",
>        "monthlyIncome": "5000"
>      }
>    }
>  }
>}'
200Identity User Session_createInvitation_example
1{
2  "data": "string",
3  "error_code": 1,
4  "error_message": "string",
5  "error_descriptions": null
6}
Create an invitation session with pre-filled form data for a specific user. The user only needs to confirm and sign — they don't need to fill in the form. Use this when you have already collected the customer's information and want to pre-populate the contract form to reduce friction. **Authentication:** Requires admin bearer token + `ApiKey`.
Was this page helpful?
Previous

Create an embedded auth session

Built with

Create an invitation session with pre-filled form data for a specific user. The user only needs to confirm and sign — they don’t need to fill in the form.

Use this when you have already collected the customer’s information and want to pre-populate the contract form to reduce friction.

Authentication: Requires admin bearer token + ApiKey.

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

Request

This endpoint expects an object.
SessionInputobjectOptional

Response

Invitation session token.
datastring or null
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null