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
      • GETList available product types
      • GETGet form fields for a product type
      • GETCheck user eligibility
      • POSTCreate a business request
      • GETGet current business request
      • GETList user's business requests
      • GETList business request IDs and statuses
      • GETGet business request by ID
      • POSTRequest contract activation OTP
      • POSTRe-validate liveness after location change
      • POSTValidate contract activation OTP
      • POSTConfirm payment and activate contract
      • POSTGenerate WebView signing URL
      • GETDownload contract PDF
Dashboard
LogoLogo
Vlens APIBusiness Request

Create a business request

||View as Markdown|
POST
https://api.vlenseg.com/api/BusinessRequest/Create/:typeId
POST
/api/BusinessRequest/Create/:typeId
$curl -X POST https://api.vlenseg.com/api/BusinessRequest/Create/414 \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "geoLocation": {
>    "latitude": 30.0444,
>    "longitude": 31.2357
>  },
>  "userDeviceUtcTime": "2025-01-15T10:30:00Z",
>  "requestFieldsValues": {
>    "fullName": "Ahmed Mohamed",
>    "nationalId": "29901234567890",
>    "monthlyIncome": "5000"
>  }
>}'
200Business Request_createBusinessRequest_example
1{
2  "data": {
3    "id": "81f404b3-d7dc-4f08-b4fe-934853c86282",
4    "requestNumber": "REQ-2025-00001",
5    "typeName": "Personal Loan"
6  },
7  "error_code": null
8}

Create a new business request (e-contract) of a given type. The user must pass the eligibility check before calling this endpoint.

Pass the form field values from GetBusinessRequestTypeTemplateFields as requestFieldsValues, using each field’s key as the map key.

The returned id is required for all subsequent signing steps.

Was this page helpful?
Previous

Check user eligibility

Next

Get current business request

Built with

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

Path parameters

typeIdintegerRequired
The request type ID.

Request

This endpoint expects an object.
geoLocationobjectOptional
Geographic coordinates of the user's device.
userDeviceUtcTimedatetime or nullOptional
UTC timestamp from the user's device at submission time.
requestFieldsValuesmap from strings to strings or nullOptional

Key-value pairs for the form fields of this request type. Keys are the key property values from GetBusinessRequestTypeTemplateFields.

isDynamicSubTypesbooleanOptionalDefaults to false
customerSignersIdentifierslist of strings or nullOptional

Phone numbers, emails, or user IDs of additional co-signers.

minimumRequiredSignatoriesinteger or nullOptional

Response

Business request created. Store the returned id for the signing flow.

dataobject
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null