> 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. # Create an invitation with pre-filled data POST https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation Content-Type: application/json 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`. Reference: https://docs.vlenseg.com/api-reference/vlens-api/identity-user-session/create-invitation ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: example-openapi version: 1.0.0 paths: /api/IdentityUserSession/CreateInvitation: post: operationId: create-invitation summary: Create an invitation with pre-filled data description: > 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`. tags: - subpackage_identityUserSession parameters: - name: ApiKey in: header description: >- Static API key issued to your tenant. Obtain from the Vlens dashboard. required: true schema: type: string responses: '200': description: Invitation session token. content: application/json: schema: $ref: '#/components/schemas/ApiOutputString' requestBody: content: application/json: schema: $ref: '#/components/schemas/CreateInvitationInput' servers: - url: https://api.vlenseg.com components: schemas: SessionPermissions: type: object properties: allowedContractTypeIds: type: array items: type: integer description: Contract type IDs the user may create in this session. minimalSignatureFlow: type: boolean description: Skip optional steps and use the streamlined signing flow. DigitalIdentityOnly: type: boolean description: If `true`, the session only performs KYC — no contract creation. description: Controls which features and contract types are available in the session. title: SessionPermissions CreateInvitationInputSessionInput: type: object properties: phoneNumber: type: - string - 'null' email: type: - string - 'null' format: email sessionPermissions: $ref: '#/components/schemas/SessionPermissions' UserPublicKey: type: - string - 'null' RequestFieldsValues: type: - object - 'null' additionalProperties: type: object additionalProperties: type: string description: > Pre-filled field values keyed by contract type ID, then by field key. The user will see these values pre-populated in the form. title: CreateInvitationInputSessionInput CreateInvitationInput: type: object properties: SessionInput: $ref: '#/components/schemas/CreateInvitationInputSessionInput' description: >- Creates an invitation session with pre-filled form data for a specific user. title: CreateInvitationInput ApiOutputString: type: object properties: data: type: - string - 'null' error_code: type: - integer - 'null' error_message: type: - string - 'null' error_descriptions: oneOf: - description: Any type - type: 'null' title: ApiOutputString securitySchemes: ApiKey: type: apiKey in: header name: ApiKey description: Static API key issued to your tenant. Obtain from the Vlens dashboard. BearerAuth: type: http scheme: bearer description: | Short-lived JWT. Obtain via: - `/api/credentials/Login` for admin / service tokens - `/api/DigitalIdentity/Register` or login for end-user tokens ``` ## SDK Code Examples ```python Identity User Session_createInvitation_example import requests url = "https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation" payload = { "SessionInput": { "phoneNumber": "+201234567890", "sessionPermissions": { "allowedContractTypeIds": [414], "minimalSignatureFlow": True, "DigitalIdentityOnly": False }, "RequestFieldsValues": { "414": { "fullName": "Ahmed Mohamed", "monthlyIncome": "5000" } } } } headers = { "ApiKey": "", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript Identity User Session_createInvitation_example const url = 'https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation'; const options = { method: 'POST', headers: {ApiKey: '', 'Content-Type': 'application/json'}, body: '{"SessionInput":{"phoneNumber":"+201234567890","sessionPermissions":{"allowedContractTypeIds":[414],"minimalSignatureFlow":true,"DigitalIdentityOnly":false},"RequestFieldsValues":{"414":{"fullName":"Ahmed Mohamed","monthlyIncome":"5000"}}}}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go Identity User Session_createInvitation_example package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation" payload := strings.NewReader("{\n \"SessionInput\": {\n \"phoneNumber\": \"+201234567890\",\n \"sessionPermissions\": {\n \"allowedContractTypeIds\": [\n 414\n ],\n \"minimalSignatureFlow\": true,\n \"DigitalIdentityOnly\": false\n },\n \"RequestFieldsValues\": {\n \"414\": {\n \"fullName\": \"Ahmed Mohamed\",\n \"monthlyIncome\": \"5000\"\n }\n }\n }\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("ApiKey", "") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby Identity User Session_createInvitation_example require 'uri' require 'net/http' url = URI("https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["ApiKey"] = '' request["Content-Type"] = 'application/json' request.body = "{\n \"SessionInput\": {\n \"phoneNumber\": \"+201234567890\",\n \"sessionPermissions\": {\n \"allowedContractTypeIds\": [\n 414\n ],\n \"minimalSignatureFlow\": true,\n \"DigitalIdentityOnly\": false\n },\n \"RequestFieldsValues\": {\n \"414\": {\n \"fullName\": \"Ahmed Mohamed\",\n \"monthlyIncome\": \"5000\"\n }\n }\n }\n}" response = http.request(request) puts response.read_body ``` ```java Identity User Session_createInvitation_example import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation") .header("ApiKey", "") .header("Content-Type", "application/json") .body("{\n \"SessionInput\": {\n \"phoneNumber\": \"+201234567890\",\n \"sessionPermissions\": {\n \"allowedContractTypeIds\": [\n 414\n ],\n \"minimalSignatureFlow\": true,\n \"DigitalIdentityOnly\": false\n },\n \"RequestFieldsValues\": {\n \"414\": {\n \"fullName\": \"Ahmed Mohamed\",\n \"monthlyIncome\": \"5000\"\n }\n }\n }\n}") .asString(); ``` ```php Identity User Session_createInvitation_example request('POST', 'https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation', [ 'body' => '{ "SessionInput": { "phoneNumber": "+201234567890", "sessionPermissions": { "allowedContractTypeIds": [ 414 ], "minimalSignatureFlow": true, "DigitalIdentityOnly": false }, "RequestFieldsValues": { "414": { "fullName": "Ahmed Mohamed", "monthlyIncome": "5000" } } } }', 'headers' => [ 'ApiKey' => '', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp Identity User Session_createInvitation_example using RestSharp; var client = new RestClient("https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation"); var request = new RestRequest(Method.POST); request.AddHeader("ApiKey", ""); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"SessionInput\": {\n \"phoneNumber\": \"+201234567890\",\n \"sessionPermissions\": {\n \"allowedContractTypeIds\": [\n 414\n ],\n \"minimalSignatureFlow\": true,\n \"DigitalIdentityOnly\": false\n },\n \"RequestFieldsValues\": {\n \"414\": {\n \"fullName\": \"Ahmed Mohamed\",\n \"monthlyIncome\": \"5000\"\n }\n }\n }\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift Identity User Session_createInvitation_example import Foundation let headers = [ "ApiKey": "", "Content-Type": "application/json" ] let parameters = ["SessionInput": [ "phoneNumber": "+201234567890", "sessionPermissions": [ "allowedContractTypeIds": [414], "minimalSignatureFlow": true, "DigitalIdentityOnly": false ], "RequestFieldsValues": ["414": [ "fullName": "Ahmed Mohamed", "monthlyIncome": "5000" ]] ]] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://api.vlenseg.com/api/IdentityUserSession/CreateInvitation")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```