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:

1. Send a GET request with the appropriate headers.

2. Receive a response containing all relevant business request data.

3. Process the response based on the retrieved data.

get

Query parameters

minimalbooleanOptionalDefault: false

Responses

200

Success

text/plainapplication/jsontext/json

error_codeinteger · int32 · nullableOptional

error_messagestring · nullableOptional

error_descriptionsany · nullableOptional

get

/api/BusinessRequest/Current

HTTPcURLJavaScriptPython

GET /api/BusinessRequest/Current HTTP/1.1
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": "2026-03-31T14:19:12.039Z",
            "lastModifierUserId": 1,
            "creationTime": "2026-03-31T14:19:12.039Z",
            "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": "2026-03-31T14:19:12.039Z",
        "lastModifierUserId": 1,
        "creationTime": "2026-03-31T14:19:12.039Z",
        "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": "2026-03-31T14:19:12.039Z",
    "lastModifierUserId": 1,
    "creationTime": "2026-03-31T14:19:12.039Z",
    "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

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

returnedCountinteger · int32Optional

error_codeinteger · int32 · nullableOptional

error_messagestring · nullableOptional

error_descriptionsany · nullableOptional

get

/api/BusinessRequest/CurrentList

HTTPcURLJavaScriptPython

GET /api/BusinessRequest/CurrentList HTTP/1.1
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": "2026-03-31T14:19:12.039Z",
          "lastModifierUserId": 1,
          "creationTime": "2026-03-31T14:19:12.039Z",
          "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": "2026-03-31T14:19:12.039Z",
      "lastModifierUserId": 1,
      "creationTime": "2026-03-31T14:19:12.039Z",
      "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

text/plainapplication/jsontext/json

totalCountinteger · int32Optional

returnedCountinteger · int32Optional

error_codeinteger · int32 · nullableOptional

error_messagestring · nullableOptional

error_descriptionsany · nullableOptional

get

/api/BusinessRequest/CurrentListIds

HTTPcURLJavaScriptPython

GET /api/BusinessRequest/CurrentListIds HTTP/1.1
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": "2026-03-31T14:19:12.039Z"
    }
  ],
  "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

1. Send a GET request to this endpoint with query parameter requestId.

2. Receive the detailed information about the specific business request.

Required Query Parameter

• id (string) – The unique identifier of the business request

Get Business Request By ID

get

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

error_codeintegerOptional

error_messagestringOptional

get

/api/BusinessRequest/GetBusinessRequestById/{id}

HTTPcURLJavaScriptPython

GET /api/BusinessRequest/GetBusinessRequestById/{id} HTTP/1.1
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": "2026-03-31T14:19:12.039Z",
    "lastModifierUserId": 1,
    "creationTime": "2026-03-31T14:19:12.039Z",
    "creatorUserId": 1,
    "id": "123e4567-e89b-12d3-a456-426614174000"
  },
  "error_code": 1,
  "error_message": "text"
}

JavaScript

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();

Python

cURL