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

Request contract activation OTP

||View as Markdown|
POST
https://api.vlenseg.com/api/BusinessRequest/CustomerSign/StepRequestOtp
POST
/api/BusinessRequest/CustomerSign/StepRequestOtp
$curl -X POST https://api.vlenseg.com/api/BusinessRequest/CustomerSign/StepRequestOtp \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json" \
>     -d '{
>  "geoLocation": {
>    "latitude": 30.0444,
>    "longitude": 31.2357
>  },
>  "userDeviceUtcTime": "2025-01-15T10:30:00Z",
>  "requestId": "81f404b3-d7dc-4f08-b4fe-934853c86282"
>}'
200Business Request_customerSignStepRequestOtp_example
1{
2  "data": {
3    "otpRequestId": "string"
4  },
5  "error_code": 1,
6  "error_message": "string"
7}
Begin contract activation by requesting an OTP. The system first compares the user's current location against their last active device location. - **Within 80 km:** OTP is sent. Save the returned `otpRequestId` for `StepValidateOtp`. - **More than 80 km:** The response indicates that liveness re-validation is required. Call `StepReValidateLiveness` first, then retry this endpoint.
Was this page helpful?
Previous

Get business request by ID

Next

Re-validate liveness after location change

Built with

Begin contract activation by requesting an OTP. The system first compares the user’s current location against their last active device location.

  • Within 80 km: OTP is sent. Save the returned otpRequestId for StepValidateOtp.
  • More than 80 km: The response indicates that liveness re-validation is required. Call StepReValidateLiveness first, then retry this endpoint.

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.
geoLocationobjectRequired
Geographic coordinates of the user's device.
userDeviceUtcTimedatetimeRequired
UTC timestamp from the user's device.
requestIdstringOptionalformat: "uuid"
The business request ID being activated.
contractStorageIdstring or nullOptionalformat: "uuid"
transactionIdstring or nullOptionalformat: "uuid"
The KYC transaction ID associated with this request.
paymentGatewaystring or nullOptional

Payment gateway name (e.g., fawry, kashier).

smsProvidersinteger or nullOptional

SMS provider for OTP delivery:

  • 1 — Infobip 2 — Vodafone 3 — Cequens 4 — Victory Link

Response

OTP sent. Use the returned otpRequestId in StepValidateOtp.

dataobject
error_codeinteger or null
error_messagestring or null