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

List user's business requests

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

Get current business request

Next

List business request IDs and statuses

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

skipCountintegerOptional
MaxResultCountintegerOptional

Response

Paginated list.
datalist of objects or null
totalCountinteger
returnedCountinteger
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null