> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.vlenseg.com/llms.txt.
> For full documentation content, see https://docs.vlenseg.com/llms-full.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.vlenseg.com/_mcp/server.

# Get business request by ID

GET https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/{id}

Retrieve full details of a specific business request by its UUID.

Reference: https://docs.vlenseg.com/api-reference/vlens-api/business-request/get-business-request-by-id

## OpenAPI Specification

```yaml
openapi: 3.1.0
info:
  title: example-openapi
  version: 1.0.0
paths:
  /api/BusinessRequest/GetBusinessRequestById/{id}:
    get:
      operationId: get-business-request-by-id
      summary: Get business request by ID
      description: Retrieve full details of a specific business request by its UUID.
      tags:
        - subpackage_businessRequest
      parameters:
        - name: id
          in: path
          required: true
          schema:
            type: string
            format: uuid
        - name: ApiKey
          in: header
          description: >-
            Static API key issued to your tenant. Obtain from the Vlens
            dashboard.
          required: true
          schema:
            type: string
      responses:
        '200':
          description: Full business request details.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ApiOutputBusinessRequest'
servers:
  - url: https://api.vlenseg.com
components:
  schemas:
    RequestStatus:
      type: string
      enum:
        - '1'
        - '2'
        - '3'
        - '4'
        - '5'
        - '6'
        - '7'
        - '8'
      description: |
        Lifecycle status of a business request:
        - `1` — Pending Approval
        - `2` — Approved
        - `3` — Rejected
        - `4` — Customer Signed
        - `5` — Service Provider Partially Signed
        - `6` — Service Provider Signed
        - `7` — Cancelled
        - `8` — Expired
      title: RequestStatus
    DropDownItemDto:
      type: object
      properties:
        id:
          type: integer
        name:
          type:
            - string
            - 'null'
        relatedQuestions:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BusinessRequestsField'
      title: DropDownItemDto
    BusinessRequestsField:
      type: object
      properties:
        order:
          type: integer
          description: Display order position.
        key:
          type:
            - string
            - 'null'
          description: >-
            Machine-readable identifier. Use this as the key in
            `requestFieldsValues`.
        displayText:
          type:
            - string
            - 'null'
          description: English label shown to the user.
        displayArText:
          type:
            - string
            - 'null'
          description: Arabic label shown to the user.
        value:
          type:
            - string
            - 'null'
        multiValues:
          type:
            - array
            - 'null'
          items:
            type: string
          description: Submitted values for multi-select fields.
        tabularData:
          type:
            - array
            - 'null'
          items:
            type: array
            items:
              type: string
          description: Row-column data for table field types.
        type:
          type:
            - string
            - 'null'
          description: Field type (e.g., text, dropdown, date, table, checkbox).
        visibleToUser:
          type: boolean
        defaultValue:
          type:
            - string
            - 'null'
        defaultArValue:
          type:
            - string
            - 'null'
        availableValues:
          type:
            - array
            - 'null'
          items:
            type: string
        firstRowHeader:
          type: boolean
        convertNumbersToArabic:
          type: boolean
        availableValuesItems:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/DropDownItemDto'
        parentQuestionKey:
          type:
            - string
            - 'null'
          description: Key of the field this field is conditionally dependent on.
        parentQuestionValue:
          type:
            - string
            - 'null'
          description: The parent field value that makes this field visible.
        relatedQuestions:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BusinessRequestsField'
        groupTitle:
          type:
            - string
            - 'null'
        groupArTitle:
          type:
            - string
            - 'null'
      description: >
        A single configurable field in a business request form.

        Fields can be conditional: when `parentQuestionKey` is set, this field
        only appears

        when the parent field's value matches `parentQuestionValue`.
      title: BusinessRequestsField
    BusinessRequestDocumentDto:
      type: object
      properties:
        order:
          type: integer
        title:
          type:
            - string
            - 'null'
        content:
          type:
            - string
            - 'null'
          description: HTML document content.
        signature:
          type:
            - string
            - 'null'
        isHtml:
          type: boolean
      title: BusinessRequestDocumentDto
    UserBasicInfo:
      type: object
      properties:
        id:
          type: integer
          format: int64
        name:
          type:
            - string
            - 'null'
        surname:
          type:
            - string
            - 'null'
        fullName:
          type:
            - string
            - 'null'
        userName:
          type:
            - string
            - 'null'
        emailAddress:
          type:
            - string
            - 'null'
          format: email
        phoneNumber:
          type:
            - string
            - 'null'
        idNumber:
          type:
            - string
            - 'null'
          description: Egyptian national ID number.
        address:
          type:
            - string
            - 'null'
      description: Core profile information for a registered user.
      title: UserBasicInfo
    CustomerSignerDto:
      type: object
      properties:
        customerSigner:
          $ref: '#/components/schemas/UserBasicInfo'
        isSigned:
          type: boolean
      title: CustomerSignerDto
    BusinessRequestDto:
      type: object
      properties:
        id:
          type: string
          format: uuid
        relatedBusinessRequest:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BusinessRequestDto'
        typeName:
          type:
            - string
            - 'null'
        type:
          type: integer
        contractTypeId:
          type: integer
        contractTypeName:
          type:
            - string
            - 'null'
        idNumber:
          type:
            - string
            - 'null'
        requestNumber:
          type:
            - string
            - 'null'
        fullName:
          type:
            - string
            - 'null'
        requeststatus:
          $ref: '#/components/schemas/RequestStatus'
        requestStatusName:
          type:
            - string
            - 'null'
        requestFields:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BusinessRequestsField'
        documents:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/BusinessRequestDocumentDto'
        user:
          $ref: '#/components/schemas/UserBasicInfo'
        confirmationMessage:
          type:
            - string
            - 'null'
        contractDocument:
          type:
            - string
            - 'null'
        coverPage:
          type:
            - string
            - 'null'
        generalTC:
          type:
            - string
            - 'null'
        technicalTC:
          type:
            - string
            - 'null'
        financialTC:
          type:
            - string
            - 'null'
        kycConfirmation:
          type:
            - string
            - 'null'
        customerSignature:
          type:
            - string
            - 'null'
        contractSignerSignature:
          type:
            - string
            - 'null'
        promissoryNote:
          type:
            - string
            - 'null'
        amount:
          type:
            - string
            - 'null'
        periodValue:
          type:
            - string
            - 'null'
        periodUnit:
          type:
            - string
            - 'null'
        installmentValue:
          type:
            - string
            - 'null'
        totalAmount:
          type:
            - string
            - 'null'
        installmentsNo:
          type:
            - string
            - 'null'
        firstInstallmentDate:
          type:
            - string
            - 'null'
        hasPaymentCheckPerRequestFeature:
          type: boolean
        customerSigners:
          type:
            - array
            - 'null'
          items:
            $ref: '#/components/schemas/CustomerSignerDto'
        creatorUserFullName:
          type:
            - string
            - 'null'
        creationTime:
          type: string
          format: date-time
        lastModificationTime:
          type:
            - string
            - 'null'
          format: date-time
      description: >-
        Full details of a business request, including documents, fields, and
        financial terms.
      title: BusinessRequestDto
    ApiOutputBusinessRequest:
      type: object
      properties:
        data:
          $ref: '#/components/schemas/BusinessRequestDto'
        error_code:
          type:
            - integer
            - 'null'
        error_message:
          type:
            - string
            - 'null'
        error_descriptions:
          oneOf:
            - description: Any type
            - type: 'null'
      title: ApiOutputBusinessRequest
  securitySchemes:
    ApiKey:
      type: apiKey
      in: header
      name: ApiKey
      description: Static API key issued to your tenant. Obtain from the Vlens dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      description: |
        Short-lived JWT. Obtain via:
        - `/api/credentials/Login` for admin / service tokens
        - `/api/DigitalIdentity/Register` or login for end-user tokens

```

## SDK Code Examples

```python
import requests

url = "https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id"

payload = {}
headers = {
    "ApiKey": "<apiKey>",
    "Content-Type": "application/json"
}

response = requests.get(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id';
const options = {
  method: 'GET',
  headers: {ApiKey: '<apiKey>', 'Content-Type': 'application/json'},
  body: '{}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id"

	payload := strings.NewReader("{}")

	req, _ := http.NewRequest("GET", url, payload)

	req.Header.Add("ApiKey", "<apiKey>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Get.new(url)
request["ApiKey"] = '<apiKey>'
request["Content-Type"] = 'application/json'
request.body = "{}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.get("https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id")
  .header("ApiKey", "<apiKey>")
  .header("Content-Type", "application/json")
  .body("{}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('GET', 'https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id', [
  'body' => '{}',
  'headers' => [
    'ApiKey' => '<apiKey>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id");
var request = new RestRequest(Method.GET);
request.AddHeader("ApiKey", "<apiKey>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "ApiKey": "<apiKey>",
  "Content-Type": "application/json"
]
let parameters = [] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.vlenseg.com/api/BusinessRequest/GetBusinessRequestById/id")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "GET"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```