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

Re-validate liveness after location change

||View as Markdown|
POST
https://api.vlenseg.com/api/BusinessRequest/CustomerSign/StepReValidateLiveness
POST
/api/BusinessRequest/CustomerSign/StepReValidateLiveness
$curl -X POST https://api.vlenseg.com/api/BusinessRequest/CustomerSign/StepReValidateLiveness \
> -H "ApiKey: <apiKey>" \
> -H "Content-Type: application/json" \
> -d '{
> "geoLocation": {
> "latitude": 29.9765,
> "longitude": 31.1313
> },
> "userDeviceUtcTime": "2024-04-20T14:45:00Z",
> "scanTransaction": {
> "image": "SGVsbG8gV29ybGQ=",
> "face_1": "SGVsbG8gV29ybGQ=",
> "face_2": "SGVsbG8gV29ybGQ=",
> "face_3": "SGVsbG8gV29ybGQ="
> }
>}'
200Successful
1{
2 "data": "Liveness re-validation successful. Proceed to OTP request.",
3 "error_code": 0,
4 "error_message": "",
5 "error_descriptions": null
6}

Required when the user’s current location is more than 80 km from their last active device location. Submit new liveness images to re-establish the user’s identity.

Use the same transactionId as the original KYC verification. After this step succeeds, call StepRequestOtp again.

Was this page helpful?
Previous

Request contract activation OTP

Next

Validate contract activation OTP

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

Request

This endpoint expects an object.
geoLocationobjectRequired
Geographic coordinates of the user's device.
userDeviceUtcTimedatetimeRequired
UTC timestamp from the user's device.
scanTransactionobjectRequired
Input for liveness detection. Three face images must be captured within 0.5 seconds of each other. Compress each image to under 500 KB for best performance.
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).

Response

Liveness re-validated. Proceed to StepRequestOtp.

datastring or null
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null