Download Report

Download the analysed report in xlsx or json format.

GET /v1/bsa/download-report

Get Download Report

cURL

curl --request GET \
  --url https://production.deepvue.tech/v1/bsa/download-report \
  --header 'Authorization: Bearer <token>' \
  --header 'x-api-key: <api-key>'

200

200 - File Processing Completed (XLSX)

{
  "code": 200,
  "timestamp": 1743779806782,
  "transaction_id": "8d42f493eb16402bad2b7ad9e7f215d8",
  "sub_code": "SUCCESS",
  "message": "File processing completed",
  "data": {
    "url": "https://deepvue-tech.s3.ap-south-1.amazonaws.com/333e8ab-91fc-4291-8dc8-29c89373b9e4_BSA_Report.xlsx"
  }
}

Authorizations

Authorization · string · header · required

ACCESS_TOKEN generated from the authorize endpoint. Should be included in the header as Bearer .

x-api-key · string · header · required

The CLIENT_SECRET provided to you. This header parameter is required for authentication purposes.

Query Parameters

reference_id · string · required

Unique ID returned from upload API

report_type · enum<string> · default: json · required

An enumeration.

Available options: json, xlsx

Response

200

application/json

Successful Response

File Processing Completed (XLSX)

File Processing Completed (JSON)

File Processing In Progress

File Processing Failed

code · integer · default: 200

timestamp · integer

transaction_id · string

sub_code · string · default: SUCCESS

message · string · default: File processing completed

data · Data · object

Show child attributes