1. Reports
CG Scanning API
latest
  • latest
  • 5.4.2
  • 5.5.x
  • Scanning API
    • Getting Started
    • Scanning API SDKs
    • Authentication
    • Common Error Responses
    • Filtering Data
    • Core Workflows
    • Authentication
      • User Confirmation
        • Confirm a User
        • Show confirmation form
      • User Invitation
        • Accept an invitation
        • Pre-Accept invitation check
      • Password Reset
        • Forgot Password
        • Reset Password
      • Impersonation
        • Impersonate user
        • Impersonate user
      • MFA
        • Check 2fa
        • Send SMS OTP
      • Sign in authentication
      • Sign in with recovery code
      • Sign out authentication
      • SSO Link login
    • Targets
      • List targets
      • Create Target
      • Show a target
      • Updates a target
      • Delete a target
      • Delete targets
      • Calculate Hosts
    • Scans
      • Scan Histories
        • List of history for a scan
        • History details for a scan
      • Scan Hosts
        • List of hosts for a scan
        • Host details for a scan
      • Scan Vulnerabilities
        • List of vulnerabilities for a scan
        • Show vulnerability details
        • Statistics for a scan
      • Scan Profiles (Configs)
        • List Activated Scan Profiles
      • List scans
      • Create Scan
      • Show a scan
      • Updates a scan
      • Delete a scan
      • Delete scans
      • Start a scan
      • Stop a scan
      • List upcoming scans
      • List recent scans that have been completed
      • List of the running scans
      • Create Scan from Wizard
    • Reports
      • List Reports
        GET
      • Show a report
        GET
      • Delete a report
        DELETE
      • Delete reports
        DELETE
      • Generates a report file
        GET
      • Downloads a report file
        GET
      • Check if a report file exists
        GET
      • Verifies file integrity by comparing hashes
        POST
    • Vulnerabilities
      • List of vulnerabilities
      • Vulnerability details
      • Total Vulnerabilities (widget)
      • Top Vulnerabilities (widget)
      • PCI Compliant (widget)
    • Exceptions
      • List Exceptions
      • Create Exception
      • Update Exception
      • Show an exception
      • Delete an exception
      • Show exception details
      • Delete exceptions
      • Show the exceptions statistics
    • Schedules
      • List Schedules
      • Create Schedule
      • Updates a schedule
      • Show a schedule
      • Delete a schedule
      • Delete schedules
      • Calculate First Time Schedule Date
      • Calculate Next Schedule Dates
    • Webhooks
      • Deliveries
        • List all deliveries for a webhook
        • Get a delivery for a webhook
      • List all webhooks
      • Create a webhook
      • Show a webhook
      • Update a webhook
      • Delete a webhook
      • Activate a webhook
      • Deactivate a webhook
    • Advanced Reports
      • List Advanced Reports
      • Create an advanced report
      • Show an advanced report
      • Update an advanced report
      • Delete an advanced report
      • Delete advanced reports
      • Generates an advanced report file
      • Downloads an advanced report file
    • Audit
      • Get all events
      • Get event by id
    • Notifications
      • List Notifications
      • Show a notification
      • Delete a notification
      • Mark as read a notification
      • Mark as seen a notification
      • Mark as read all notifications
      • Mark as seen all notifications
    • Hosts
      • List of hosts
      • Host details
      • List of most vulnerable hosts
    • Scanners
      • List scanners
      • Create scanner
      • Show scanner
      • Update scanner
      • Delete scanner
      • List activated scanners
      • Activate scanner
      • Deactivate scanner
      • Update scanner app type
      • Assign a scanner to an organization
      • Verify a scanner
    • Port Lists
      • List port lists
      • Create a port list
      • Show a port list
      • Update a port list
      • Delete a port list
      • List activated port lists
      • Add a port range to a port list
      • Delete a port range to a port list
      • Activate a port list
      • Deactivate a port list
      • Updates the app_type of a port list
      • Sync the a port lists
    • Credentials
      • List Credentials
      • Show Credential
      • Delete Credential
      • Create Credential
      • Update Credential
    • User
      • User 2FA
        • Enable 2FA
        • Verify 2FA installation
        • Disable 2FA
        • Lookup phone number
        • Default 2FA method
        • Generate Recovery Codes
        • Get Recovery Codes
      • User Preferences
        • Get users notification preferences
        • Change users product
        • Enable user's event notification preference
        • Disable user's event notification preference
      • Get current user
      • Update current user
      • Change current user password
      • Get current user active plans (Not implemented yet)
      • Get organization members
      • Get current user products
      • Get current organization
      • Update current organization
      • Get subscriptions history
      • Change users product
      • Checks if authorization token is valid
      • Get current user permissions
      • Check if the user can be deleted
      • Delete my account
      • Generates a new access token
      • Revokes the current access token
      • Transfers all the resources from the user to another user
    • Organizations
      • Organization Subscriptions
        • Retrieves all subscriptions of organization
        • Retrieves all active subscriptions of organization
        • Show a subscription of organization
        • Update organization's subscription
        • Assign features to a subscription
        • Revoke features from a subscription
      • Subscribe to a plan
      • List organizations
      • Create Organization
      • List dependent subscriptions
      • Retrieve an organization
      • Update an organization
      • Delete an organization
      • Subscribe an organization to a plan
      • Unsubscribe an organization from a plan
      • Change users Organization
      • Export organizations
    • Users
      • List Users
      • Create User
      • Show User
      • Update User
      • Delete a User
      • Create Customer
      • Invite User
      • Resend Confirmation Instructions
      • Import Users
      • Check if a user can be deleted
      • Inherit all the resources from a user
      • Export all users to a CSV file
      • Set partner
      • Unset partner
    • Whitelabel Settings
      • Show the white label settings
      • Show the white label settings
      • Update white label settings
    • Schemas
      • Schemas
        • vulnerabilityData
        • errors_map
        • errorObject
        • SingleResponseBase
        • CollectionResponseBase
        • not_found
        • ErrorResponse
        • forbidden
        • TargetResource
        • WebhookResource
        • ScanResource
        • ExceptionResource
        • VulnerabilityResource
        • WebhookAttributes
        • ExceptionAttributes
        • unauthorized
        • TargetResponse
        • WebhookResponse
        • ScanResponse
        • ExceptionResponse
        • VulnerabilityResponse
        • unprocessable_entity
        • TargetAttributes
        • ScanAttributes
        • VulnerabilityAttributes
        • pagination
        • TargetsListResponse
        • WebhooksListResponse
        • ScansListResponse
        • ExceptionsListResponse
        • VulnerabilitiesListResponse
        • meta
        • target
        • OwnerAttributes
        • scan
        • FeaturesBodyRequest
        • targetAttributes
        • targetResponse
        • targetsResponse
        • product
        • productsResponse
  • SAQ API
    • List all SAQs
    • Get SAQ (JSON) or Download SAQ (PDF)
    • List Available SAQ Types
    • Get SAQ Type Template
    • Create a New SAQ
    • Delete an SAQ
    • Clone an SAQ
    • Approve an SAQ
    • Set SAQ as a template
Home
DocsPurchase PCI ASV Certified Scan
Home
DocsPurchase PCI ASV Certified Scan
latest
  • latest
  • 5.4.2
  • 5.5.x
  1. Reports

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: ********************
or
Path Params

Query Params

Body Params application/json

Example
{
    "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"
    }
}

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/v2/reports//generate?type&include_attestation&extended' \
--header 'Authorization: Bearer <token>' \
--header 'x-api-key: <api-key>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "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
Previous
Delete reports
Next
Downloads a report file
Built with