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 form fields for a product type

||View as Markdown|
GET
https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestTypeTemplateFields
GET
/api/BusinessRequest/GetBusinessRequestTypeTemplateFields
$curl -G https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestTypeTemplateFields \
> -H "ApiKey: <apiKey>" \
> -H "Content-Type: application/json" \
> -d requestTypeId=414
200Retrieved
1{
2 "data": {
3 "id": 101,
4 "name": "Business Loan Application",
5 "requestsFields": [
6 {
7 "order": 1,
8 "key": "businessName",
9 "displayText": "Business Name",
10 "displayArText": "اسم العمل",
11 "value": null,
12 "multiValues": null,
13 "tabularData": null,
14 "type": "text",
15 "visibleToUser": true,
16 "defaultValue": null,
17 "defaultArValue": null,
18 "availableValues": null,
19 "firstRowHeader": false,
20 "convertNumbersToArabic": false,
21 "availableValuesItems": null,
22 "parentQuestionKey": null,
23 "parentQuestionValue": null,
24 "relatedQuestions": null,
25 "groupTitle": "Business Details",
26 "groupArTitle": "تفاصيل العمل"
27 },
28 {
29 "order": 2,
30 "key": "businessType",
31 "displayText": "Type of Business",
32 "displayArText": "نوع العمل",
33 "value": null,
34 "multiValues": null,
35 "tabularData": null,
36 "type": "dropdown",
37 "visibleToUser": true,
38 "defaultValue": "Retail",
39 "defaultArValue": "تجزئة",
40 "availableValues": [
41 "Retail",
42 "Manufacturing",
43 "Services",
44 "Agriculture"
45 ],
46 "firstRowHeader": false,
47 "convertNumbersToArabic": false,
48 "availableValuesItems": [
49 {
50 "id": 1,
51 "name": "Retail",
52 "relatedQuestions": null
53 },
54 {
55 "id": 2,
56 "name": "Manufacturing",
57 "relatedQuestions": null
58 },
59 {
60 "id": 3,
61 "name": "Services",
62 "relatedQuestions": null
63 },
64 {
65 "id": 4,
66 "name": "Agriculture",
67 "relatedQuestions": null
68 }
69 ],
70 "parentQuestionKey": null,
71 "parentQuestionValue": null,
72 "relatedQuestions": null,
73 "groupTitle": "Business Details",
74 "groupArTitle": "تفاصيل العمل"
75 },
76 {
77 "order": 3,
78 "key": "hasExistingLoan",
79 "displayText": "Do you have an existing loan?",
80 "displayArText": "هل لديك قرض قائم؟",
81 "value": null,
82 "multiValues": null,
83 "tabularData": null,
84 "type": "checkbox",
85 "visibleToUser": true,
86 "defaultValue": "false",
87 "defaultArValue": "خطأ",
88 "availableValues": null,
89 "firstRowHeader": false,
90 "convertNumbersToArabic": false,
91 "availableValuesItems": null,
92 "parentQuestionKey": null,
93 "parentQuestionValue": null,
94 "relatedQuestions": null,
95 "groupTitle": "Financial Information",
96 "groupArTitle": "المعلومات المالية"
97 },
98 {
99 "order": 4,
100 "key": "existingLoanDetails",
101 "displayText": "Existing Loan Details",
102 "displayArText": "تفاصيل القرض القائم",
103 "value": null,
104 "multiValues": null,
105 "tabularData": null,
106 "type": "text",
107 "visibleToUser": true,
108 "defaultValue": null,
109 "defaultArValue": null,
110 "availableValues": null,
111 "firstRowHeader": false,
112 "convertNumbersToArabic": false,
113 "availableValuesItems": null,
114 "parentQuestionKey": "hasExistingLoan",
115 "parentQuestionValue": "true",
116 "relatedQuestions": null,
117 "groupTitle": "Financial Information",
118 "groupArTitle": "المعلومات المالية"
119 }
120 ],
121 "requestsFieldsWithGroupTitles": [
122 {
123 "title": "Business Details",
124 "requestsFields": [
125 {
126 "order": 1,
127 "key": "businessName",
128 "displayText": "Business Name",
129 "displayArText": "اسم العمل",
130 "value": null,
131 "multiValues": null,
132 "tabularData": null,
133 "type": "text",
134 "visibleToUser": true,
135 "defaultValue": null,
136 "defaultArValue": null,
137 "availableValues": null,
138 "firstRowHeader": false,
139 "convertNumbersToArabic": false,
140 "availableValuesItems": null,
141 "parentQuestionKey": null,
142 "parentQuestionValue": null,
143 "relatedQuestions": null,
144 "groupTitle": "Business Details",
145 "groupArTitle": "تفاصيل العمل"
146 },
147 {
148 "order": 2,
149 "key": "businessType",
150 "displayText": "Type of Business",
151 "displayArText": "نوع العمل",
152 "value": null,
153 "multiValues": null,
154 "tabularData": null,
155 "type": "dropdown",
156 "visibleToUser": true,
157 "defaultValue": "Retail",
158 "defaultArValue": "تجزئة",
159 "availableValues": [
160 "Retail",
161 "Manufacturing",
162 "Services",
163 "Agriculture"
164 ],
165 "firstRowHeader": false,
166 "convertNumbersToArabic": false,
167 "availableValuesItems": [
168 {
169 "id": 1,
170 "name": "Retail",
171 "relatedQuestions": null
172 },
173 {
174 "id": 2,
175 "name": "Manufacturing",
176 "relatedQuestions": null
177 },
178 {
179 "id": 3,
180 "name": "Services",
181 "relatedQuestions": null
182 },
183 {
184 "id": 4,
185 "name": "Agriculture",
186 "relatedQuestions": null
187 }
188 ],
189 "parentQuestionKey": null,
190 "parentQuestionValue": null,
191 "relatedQuestions": null,
192 "groupTitle": "Business Details",
193 "groupArTitle": "تفاصيل العمل"
194 }
195 ]
196 },
197 {
198 "title": "Financial Information",
199 "requestsFields": [
200 {
201 "order": 3,
202 "key": "hasExistingLoan",
203 "displayText": "Do you have an existing loan?",
204 "displayArText": "هل لديك قرض قائم؟",
205 "value": null,
206 "multiValues": null,
207 "tabularData": null,
208 "type": "checkbox",
209 "visibleToUser": true,
210 "defaultValue": "false",
211 "defaultArValue": "خطأ",
212 "availableValues": null,
213 "firstRowHeader": false,
214 "convertNumbersToArabic": false,
215 "availableValuesItems": null,
216 "parentQuestionKey": null,
217 "parentQuestionValue": null,
218 "relatedQuestions": null,
219 "groupTitle": "Financial Information",
220 "groupArTitle": "المعلومات المالية"
221 },
222 {
223 "order": 4,
224 "key": "existingLoanDetails",
225 "displayText": "Existing Loan Details",
226 "displayArText": "تفاصيل القرض القائم",
227 "value": null,
228 "multiValues": null,
229 "tabularData": null,
230 "type": "text",
231 "visibleToUser": true,
232 "defaultValue": null,
233 "defaultArValue": null,
234 "availableValues": null,
235 "firstRowHeader": false,
236 "convertNumbersToArabic": false,
237 "availableValuesItems": null,
238 "parentQuestionKey": "hasExistingLoan",
239 "parentQuestionValue": "true",
240 "relatedQuestions": null,
241 "groupTitle": "Financial Information",
242 "groupArTitle": "المعلومات المالية"
243 }
244 ]
245 }
246 ],
247 "groupTitles": [
248 "Business Details",
249 "Financial Information"
250 ],
251 "groupArTitles": [
252 "تفاصيل العمل",
253 "المعلومات المالية"
254 ],
255 "content": "<html><body><h1>Business Loan Contract</h1><p>Please review the terms carefully.</p></body></html>",
256 "confirmationMessage": "Your business loan application has been submitted successfully.",
257 "coverPage": "<html><body><h1>Loan Application Cover Page</h1></body></html>",
258 "generalTC": "All applicants must comply with the general terms and conditions of the loan.",
259 "technicalTC": "Technical requirements include submission of valid business licenses and financial statements.",
260 "financialTC": "Financial terms include interest rates, repayment schedules, and penalties for late payment.",
261 "contractEmailBody": "Dear Applicant,\n\nPlease find attached your loan contract for review and signature.\n\nBest regards,\nLoan Department",
262 "signers": [
263 1001,
264 1002
265 ],
266 "isLocalized": true,
267 "hasCustomPayment": false,
268 "hasPromissoryNote": true,
269 "type": 414,
270 "parentId": 0,
271 "parentName": null
272 },
273 "error_code": null,
274 "error_message": null,
275 "error_descriptions": null
276}

Retrieve all configurable fields for a given business request type. Use these to build the form your users fill in before creating a request.

Fields support conditional visibility: when parentQuestionKey is present, the field only appears if the parent field’s value matches parentQuestionValue.

Was this page helpful?
Previous

List available product types

Next

Check user eligibility

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

requestTypeIdintegerRequired

The request type ID from GetAllRequestTypes.

isLocalizedbooleanOptionalDefaults to false

Use displayArText instead of displayText for Arabic labels.

Response

Template fields for the request type.
dataobject
All configurable fields and document templates for a business request type.
error_codeinteger or null
error_messagestring or null
error_descriptionsany or null