Generates a report file

GET

/v2/reports/{id}/generate

Last modified:2026-04-09 13:13:16

This endpoint allows you to generate report files for a scan.
Once the report is generated, you can retrieve it using the Download Report endpoint

Reports are generated asynchronously depending on their size and type. After generation, they are stored and available for download.

Report generation may take time depending on the scan size and selected type.

Override company details

Overrides the organization details displayed in the report.

By default, reports include the Organization's stored details (e.g., name, phone, address). You can override any of these fields by passing them in the request.

Available Options:

{
  "company": {
    "phone": "+123456789",
    "name": "Custom Company Name",
    "contact_name": "",
    "title": "",
    "url": "",
    "email": "",
    "address: "",
    "country_name": "",
    "city_name": "",
    "state": "",
    "zipcode"
  }
}

Request

Authorization

Bearer Token

Provide your bearer token in the

Authorization

header when making requests to protected resources.

Example:

Authorization: Bearer ********************

API Key

Add parameter in header

x-api-key

Example:

x-api-key: ********************

Path Params

Query Params

Body Params application/json

Request Code Samples

Shell

JavaScript

Java

Swift

PHP

Python

HTTP

Objective-C

Ruby

OCaml

Dart

curl --location --request GET '/v2/reports//generate?type=undefined&include_attestation=undefined&extended=undefined' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data '{
    "company": {
        "name": "string",
        "contact_name": "string",
        "title": "string",
        "phone": "string",
        "url": "string",
        "email": "string",
        "address": "string",
        "country_name": "string",
        "city_name": "string",
        "state": "string",
        "zipcode": "string"
    }
}'

Responses

🟢200OK

Success

This response does not have a body.

🟠401Unauthorized

🟠404Record Not Found

🟠422Parameter Error

Modified at 2026-04-09 13:13:16

Delete reports

Downloads a report file

Generates a report file

Override company details#

Request

Request Code Samples

Responses

Override company details