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

Check user eligibility

||View as Markdown|
GET
https://api.vlenseg.com/api/BusinessRequest/CheckEligibility
GET
/api/BusinessRequest/CheckEligibility
$curl https://api.vlenseg.com/api/BusinessRequest/CheckEligibility \
>     -H "ApiKey: <apiKey>"
200Business Request_checkEligibility_example
1{
2  "data": {
3    "isEligible": true,
4    "isDigitalIdentityVerified": true,
5    "hasPendingRequest": false,
6    "isEmailConfirmed": true
7  },
8  "error_code": null
9}
Verify that the current user can create a new business request. Call this before `Create` to surface blocking issues early. `isEligible` is `true` only when: - `isDigitalIdentityVerified` is `true` - `hasPendingRequest` is `false` - `isEmailConfirmed` is `true` (when required by tenant settings)
Was this page helpful?
Previous

Get form fields for a product type

Next

Create a business request

Built with

Verify that the current user can create a new business request. Call this before Create to surface blocking issues early.

isEligible is true only when:

  • isDigitalIdentityVerified is true
  • hasPendingRequest is false
  • isEmailConfirmed is true (when required by tenant settings)

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

Response

Eligibility result.
dataobject
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null