📄 Current User Business Request
Endpoint:
GET https://api.vlenseg.com/api/BusinessRequest/Current
Overview:
Retrieve details of the current business request for a user, including the request status, associated documents, and user information.
Workflow:
Send a GET request with the appropriate headers.
Receive a response containing all relevant business request data.
Process the response based on the retrieved data.
get
Query parameters
minimalbooleanOptionalDefault:
falseResponses
200
Success
get
/api/BusinessRequest/CurrentGET /api/BusinessRequest/Current HTTP/1.1
Host:
Accept: */*
200
Success
{
"data": {
"relatedBusinessRequest": [
{
"relatedBusinessRequest": [
{
"relatedBusinessRequest": "[Circular Reference]",
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": "[Circular Reference]",
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"customerSigners": [
{
"customerSigner": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"isSigned": true
}
],
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": [
{
"order": 1,
"key": "text",
"displayText": "text",
"displayArText": "text",
"value": "text",
"multiValues": [
"text"
],
"tabularData": [
[
"text"
]
],
"type": "text",
"visibleToUser": true,
"defaultValue": "text",
"defaultArValue": "text",
"availableValues": [
"text"
],
"firstRowHeader": true,
"convertNumbersToArabic": true,
"availableValuesItems": "[Circular Reference]",
"parentQuestionKey": "text",
"parentQuestionValue": "text",
"relatedQuestions": "[Circular Reference]",
"groupTitle": "text",
"groupArTitle": "text"
}
],
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"customerSigners": [
{
"customerSigner": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"isSigned": true
}
],
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": [
{
"order": 1,
"key": "text",
"displayText": "text",
"displayArText": "text",
"value": "text",
"multiValues": [
"text"
],
"tabularData": [
[
"text"
]
],
"type": "text",
"visibleToUser": true,
"defaultValue": "text",
"defaultArValue": "text",
"availableValues": [
"text"
],
"firstRowHeader": true,
"convertNumbersToArabic": true,
"availableValuesItems": "[Circular Reference]",
"parentQuestionKey": "text",
"parentQuestionValue": "text",
"relatedQuestions": "[Circular Reference]",
"groupTitle": "text",
"groupArTitle": "text"
}
],
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"customerSigners": [
{
"customerSigner": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"isSigned": true
}
],
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"error_code": 1,
"error_message": "text",
"error_descriptions": null
}Endpoint:
https://api.vlenseg.com/api/BusinessRequest/CurrentList
Description:
This endpoint retrieves a list of current business requests. It returns detailed information about each request, including associated fields, documents, and user information.
get
Query parameters
skipCountinteger · int32Optional
MaxResultCountinteger · int32Optional
Responses
200
Success
get
/api/BusinessRequest/CurrentListGET /api/BusinessRequest/CurrentList HTTP/1.1
Host:
Accept: */*
200
Success
{
"data": [
{
"relatedBusinessRequest": [
{
"relatedBusinessRequest": [
"[Circular Reference]"
],
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": [
"[Circular Reference]"
],
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"customerSigners": [
{
"customerSigner": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"isSigned": true
}
],
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": [
{
"order": 1,
"key": "text",
"displayText": "text",
"displayArText": "text",
"value": "text",
"multiValues": [
"text"
],
"tabularData": [
[
"text"
]
],
"type": "text",
"visibleToUser": true,
"defaultValue": "text",
"defaultArValue": "text",
"availableValues": [
"text"
],
"firstRowHeader": true,
"convertNumbersToArabic": true,
"availableValuesItems": [
"[Circular Reference]"
],
"parentQuestionKey": "text",
"parentQuestionValue": "text",
"relatedQuestions": [
"[Circular Reference]"
],
"groupTitle": "text",
"groupArTitle": "text"
}
],
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"customerSigners": [
{
"customerSigner": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"isSigned": true
}
],
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
}
],
"totalCount": 1,
"returnedCount": 1,
"error_code": 1,
"error_message": "text",
"error_descriptions": null
}Get Current list IDs
API Endpoint:
https://api.vlenseg.com/api/BusinessRequest/CurrentListIds
Overview:
Retrieve a list of IDs for the user’s current business requests. Unlike /CurrentList, this endpoint only returns the request IDs (and possibly minimal metadata) without full details.
Workflow:
1 - Send a GET request with headers:
The server responds with an array of request IDs (and optional status).
get
Query parameters
skipCountinteger · int32Optional
MaxResultCountinteger · int32Optional
Responses
200
Success
get
/api/BusinessRequest/CurrentListIdsGET /api/BusinessRequest/CurrentListIds HTTP/1.1
Host:
Accept: */*
200
Success
{
"data": [
{
"id": "123e4567-e89b-12d3-a456-426614174000",
"typeName": "text",
"type": 1,
"contractTypeId": 1,
"contractTypeName": "text",
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"creationTime": "2025-11-08T04:12:47.108Z"
}
],
"totalCount": 1,
"returnedCount": 1,
"error_code": 1,
"error_message": "text",
"error_descriptions": null
}Get Business Request By ID
Overview
Retrieve full details of a specific business request by its ID. This includes:
Request metadata (ID, status, creation time)
User information
Associated documents and their verification status
Workflow
Send a GET request to this endpoint with query parameter
requestId.Receive the detailed information about the specific business request.
Required Query Parameter
id (string) – The unique identifier of the business request
Retrieve all data related to a specific business request, including user info, request fields, documents, and other metadata.
Path parameters
idstring · uuidRequired
Responses
200
Detailed business request object
application/json
get
/api/BusinessRequest/GetBusinessRequestById/{id}GET /api/BusinessRequest/GetBusinessRequestById/{id} HTTP/1.1
Host:
Accept: */*
200
Detailed business request object
{
"data": {
"relatedBusinessRequest": [
"text"
],
"typeName": "text",
"type": 1,
"idNumber": "text",
"requestNumber": "text",
"fullName": "text",
"requeststatus": 1,
"requestStatusName": "text",
"requestFields": [
{
"order": 1,
"key": "text",
"displayText": "text",
"displayArText": "text",
"value": "text",
"multiValues": [
"text"
],
"tabularData": [
[
"text"
]
],
"type": "text",
"visibleToUser": true,
"defaultValue": "text",
"defaultArValue": "text",
"availableValues": [
"text"
],
"firstRowHeader": true,
"convertNumbersToArabic": true,
"availableValuesItems": [
{
"id": 1,
"name": "text",
"relatedQuestions": [
"text"
]
}
],
"parentQuestionKey": "text",
"parentQuestionValue": "text",
"relatedQuestions": [
"text"
],
"groupTitle": "text",
"groupArTitle": "text"
}
],
"documents": [
{
"order": 1,
"title": "text",
"content": "text",
"signature": "text",
"isHtml": true
}
],
"user": {
"id": 1,
"name": "text",
"surname": "text",
"fullName": "text",
"userName": "text",
"emailAddress": "text",
"phoneNumber": "text",
"idNumber": "text",
"address": "text"
},
"confirmationMessage": "text",
"contractDocument": "text",
"coverPage": "text",
"generalTC": "text",
"technicalTC": "text",
"financialTC": "text",
"kycConfirmation": "text",
"customerSignature": "text",
"contractSignerSignature": "text",
"promissoryNote": "text",
"amount": "text",
"periodValue": "text",
"periodUnit": "text",
"installmentValue": "text",
"installmentValueNumber": "text",
"totalAmount": "text",
"totalAmountNumber": "text",
"installmentsNo": "text",
"firstInstallmentDate": "text",
"hasPaymentCheckPerRequestFeature": true,
"creatorUserFullName": "text",
"lastModificationTime": "2025-11-08T04:12:47.108Z",
"lastModifierUserId": 1,
"creationTime": "2025-11-08T04:12:47.108Z",
"creatorUserId": 1,
"id": "123e4567-e89b-12d3-a456-426614174000"
},
"error_code": 1,
"error_message": "text"
}
async function getCurrentBusinessRequest() {
const url = "https://api.vlenseg.com/api/BusinessRequest/Current";
const headers = {
"Content-Type": "application/json",
"ApiKey": "<your-api-key>",
"Authorization": "Bearer <accessToken>"
};
try {
const response = await fetch(url, { method: 'GET', headers });
if (response.ok) {
const data = await response.json();
console.log(data);
} else {
console.error(`Error: ${response.status} - ${response.statusText}`);
}
} catch (error) {
console.error('Fetch error:', error);
}
}
getCurrentBusinessRequest();
import requests
def get_current_business_request():
url = "https://api.vlenseg.com/api/BusinessRequest/Current"
headers = {
"Content-Type": "application/json",
"ApiKey": "<your-api-key>",
"Authorization": "Bearer <accessToken>"
}
response = requests.get(url, headers=headers)
if response.status_code == 200:
print(response.json())
else:
print(f"Error: {response.status_code} - {response.text}")
get_current_business_request()curl -X GET "https://api.vlenseg.com/api/BusinessRequest/Current" \
-H "Content-Type: application/json" \
-H "ApiKey: <your-api-key>" \
-H "Authorization: Bearer <accessToken>"Last updated