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

Get current business request

||View as Markdown|
GET
https://api.vlenseg.com/api/BusinessRequest/Current
GET
/api/BusinessRequest/Current
$curl https://api.vlenseg.com/api/BusinessRequest/Current \
>     -H "ApiKey: <apiKey>" \
>     -H "Content-Type: application/json"
200Retrieved
1{
2  "data": {
3    "id": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
4    "relatedBusinessRequest": [
5      null
6    ],
7    "typeName": "Loan Application",
8    "type": 2,
9    "contractTypeId": 5,
10    "contractTypeName": "Personal Loan Contract",
11    "idNumber": "29807123456789",
12    "requestNumber": "REQ-20240615-0001",
13    "fullName": "Ahmed Mohamed Ali",
14    "requeststatus": 4,
15    "requestStatusName": "Customer Signed",
16    "requestFields": [
17      {
18        "order": 1,
19        "key": "loanAmount",
20        "displayText": "Loan Amount",
21        "displayArText": "مبلغ القرض",
22        "value": "50000",
23        "multiValues": [
24          "50000"
25        ],
26        "tabularData": [
27          [
28            "Installment 1",
29            "10000",
30            "2024-07-01"
31          ],
32          [
33            "Installment 2",
34            "10000",
35            "2024-08-01"
36          ]
37        ],
38        "type": "text",
39        "visibleToUser": true,
40        "defaultValue": "0",
41        "defaultArValue": "٠",
42        "availableValues": [
43          "10000",
44          "20000",
45          "30000",
46          "40000",
47          "50000"
48        ],
49        "firstRowHeader": true,
50        "convertNumbersToArabic": false,
51        "availableValuesItems": [
52          {
53            "id": 10000,
54            "name": "10,000 EGP",
55            "relatedQuestions": [
56              null
57            ]
58          },
59          {
60            "id": 20000,
61            "name": "20,000 EGP",
62            "relatedQuestions": [
63              null
64            ]
65          }
66        ],
67        "parentQuestionKey": null,
68        "parentQuestionValue": null,
69        "relatedQuestions": [
70          null
71        ],
72        "groupTitle": "Financial Details",
73        "groupArTitle": "التفاصيل المالية"
74      }
75    ],
76    "documents": [
77      {
78        "order": 1,
79        "title": "Loan Agreement",
80        "content": "<html><body><h1>Loan Agreement</h1><p>Terms and conditions...</p></body></html>",
81        "signature": "SGVsbG8gV29ybGQ=",
82        "isHtml": true
83      }
84    ],
85    "user": {
86      "id": 123456789,
87      "name": "Ahmed",
88      "surname": "Ali",
89      "fullName": "Ahmed Mohamed Ali",
90      "userName": "ahmed.ali",
91      "emailAddress": "ahmed.ali@example.com",
92      "phoneNumber": "+201234567890",
93      "idNumber": "29807123456789",
94      "address": "123 Nile Street, Cairo, Egypt"
95    },
96    "confirmationMessage": "Your loan application has been successfully signed.",
97    "contractDocument": "<html><body><h1>Contract Document</h1><p>Contract details here...</p></body></html>",
98    "coverPage": "<html><body><h1>Cover Page</h1><p>Cover page content...</p></body></html>",
99    "generalTC": "General terms and conditions apply.",
100    "technicalTC": "Technical terms and conditions apply.",
101    "financialTC": "Financial terms and conditions apply.",
102    "kycConfirmation": "KYC verified on 2024-06-10.",
103    "customerSignature": "SGVsbG8gV29ybGQ=",
104    "contractSignerSignature": "SGVsbG8gV29ybGQ=",
105    "promissoryNote": "Promissory note content here.",
106    "amount": "50000",
107    "periodValue": "12",
108    "periodUnit": "months",
109    "installmentValue": "4166.67",
110    "totalAmount": "50000",
111    "installmentsNo": "12",
112    "firstInstallmentDate": "2024-07-01",
113    "hasPaymentCheckPerRequestFeature": true,
114    "customerSigners": [
115      {
116        "customerSigner": {
117          "id": 987654321,
118          "name": "Sara",
119          "surname": "Hassan",
120          "fullName": "Sara Hassan",
121          "userName": "sara.hassan",
122          "emailAddress": "sara.hassan@example.com",
123          "phoneNumber": "+201112223344",
124          "idNumber": "29807123456780",
125          "address": "45 Tahrir Square, Cairo, Egypt"
126        },
127        "isSigned": true
128      }
129    ],
130    "creatorUserFullName": "Ahmed Mohamed Ali",
131    "creationTime": "2024-06-10T08:45:00Z",
132    "lastModificationTime": "2024-06-15T10:00:00Z"
133  },
134  "error_code": null,
135  "error_message": null,
136  "error_descriptions": null
137}
Retrieve full details of the authenticated user's most recent active business request.
Was this page helpful?
Previous

Create a business request

Next

List user's business requests

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

Query parameters

minimalbooleanOptionalDefaults to false

Return a reduced response (no documents or contract HTML).

Response

Current business request.
dataobject
Full details of a business request, including documents, fields, and financial terms.
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null