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 business request by ID

||View as Markdown|
GET
https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/:id
GET
/api/BusinessRequest/GetBusinessRequestById/:id
$curl https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id \
>     -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": "Commercial Lease Agreement",
8    "type": 2,
9    "contractTypeId": 5,
10    "contractTypeName": "Lease Contract",
11    "idNumber": "28706123456789",
12    "requestNumber": "REQ-20240615-00123",
13    "fullName": "Ahmed Mohamed Ali",
14    "requeststatus": 2,
15    "requestStatusName": "Approved",
16    "requestFields": [
17      {
18        "order": 1,
19        "key": "business_name",
20        "displayText": "Business Name",
21        "displayArText": "اسم النشاط التجاري",
22        "value": "Nile Tech Solutions",
23        "multiValues": [
24          "IT Services",
25          "Consulting"
26        ],
27        "tabularData": [
28          [
29            "Service",
30            "Description",
31            "Price"
32          ],
33          [
34            "Web Development",
35            "Custom website design",
36            "15000 EGP"
37          ]
38        ],
39        "type": "text",
40        "visibleToUser": true,
41        "defaultValue": "Nile Tech Solutions",
42        "defaultArValue": "حلول النيل التقنية",
43        "availableValues": [
44          "Nile Tech Solutions",
45          "Cairo Innovations",
46          "Delta Enterprises"
47        ],
48        "firstRowHeader": true,
49        "convertNumbersToArabic": false,
50        "availableValuesItems": [
51          {
52            "id": 1,
53            "name": "Nile Tech Solutions",
54            "relatedQuestions": [
55              null
56            ]
57          }
58        ],
59        "parentQuestionKey": null,
60        "parentQuestionValue": null,
61        "relatedQuestions": [
62          null
63        ],
64        "groupTitle": "Business Details",
65        "groupArTitle": "تفاصيل النشاط التجاري"
66      }
67    ],
68    "documents": [
69      {
70        "order": 1,
71        "title": "Lease Agreement Document",
72        "content": "<p>This lease agreement is made between the lessor and lessee...</p>",
73        "signature": "SGVsbG8gV29ybGQ=",
74        "isHtml": true
75      }
76    ],
77    "user": {
78      "id": 1024,
79      "name": "Ahmed",
80      "surname": "Ali",
81      "fullName": "Ahmed Mohamed Ali",
82      "userName": "ahmed.ali",
83      "emailAddress": "ahmed.ali@example.com",
84      "phoneNumber": "+201234567890",
85      "idNumber": "28706123456789",
86      "address": "123 Nile Street, Cairo, Egypt"
87    },
88    "confirmationMessage": "Your business request has been approved and is now active.",
89    "contractDocument": "https://vlenseg.com/contracts/lease_3fa85f64.pdf",
90    "coverPage": "https://vlenseg.com/contracts/cover_3fa85f64.png",
91    "generalTC": "All parties agree to the general terms and conditions outlined herein.",
92    "technicalTC": "Technical specifications must be adhered to as per annex A.",
93    "financialTC": "Payments must be made within 30 days of invoice receipt.",
94    "kycConfirmation": "KYC verified on 2024-06-10 by NTRA compliant process.",
95    "customerSignature": "SGVsbG8gV29ybGQ=",
96    "contractSignerSignature": "SGVsbG8gV29ybGQ=",
97    "promissoryNote": "Payment to be made in three installments over 6 months.",
98    "amount": "45000 EGP",
99    "periodValue": "6",
100    "periodUnit": "months",
101    "installmentValue": "15000 EGP",
102    "totalAmount": "45000 EGP",
103    "installmentsNo": "3",
104    "firstInstallmentDate": "2024-07-01",
105    "hasPaymentCheckPerRequestFeature": true,
106    "customerSigners": [
107      {
108        "customerSigner": {
109          "id": 1024,
110          "name": "Ahmed",
111          "surname": "Ali",
112          "fullName": "Ahmed Mohamed Ali",
113          "userName": "ahmed.ali",
114          "emailAddress": "ahmed.ali@example.com",
115          "phoneNumber": "+201234567890",
116          "idNumber": "28706123456789",
117          "address": "123 Nile Street, Cairo, Egypt"
118        },
119        "isSigned": true
120      }
121    ],
122    "creatorUserFullName": "Sara Hassan",
123    "creationTime": "2024-06-10T09:30:00Z",
124    "lastModificationTime": "2024-06-12T15:45:00Z"
125  },
126  "error_code": null,
127  "error_message": null,
128  "error_descriptions": null
129}
Retrieve full details of a specific business request by its UUID.
Was this page helpful?
Previous

List business request IDs and statuses

Next

Request 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

Path parameters

idstringRequiredformat: "uuid"

Response

Full business request details.
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