Download a Report by ID

Request

Retrieves the download information for a specific compliance report identified by its unique reportId.

This endpoint provides the URL to download the report file, along with metadata such as the file name and the expiration time for the download link.

Use this endpoint after generating a report to access the final output. Ensure the reportId corresponds to a valid and completed report in the system.

Security

bearerToken

Path

reportIdstring, (uuid)required

The unique identifier of the report to be downloaded. Must be a valid UUID that corresponds to an existing and completed report in the system.

curl -i -X GET \
  'https://connect.sandbox.creditsafe.com/v1/compliance/kyc-protect/reports/{reportId}/download' \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>'

Responses

Success. Returns the download URL, file name, and expiration timestamp for the specified report.

Bodyapplication/json

downloadUrlstring

The direct URL to download the report file. This URL is valid only until the expiration time specified in the expiresAt field.

fileNamestring

The name of the report file as specified during creation.

expiresAtstring, (date-time)

The date and time when the download URL will expire. After this time, the URL will no longer be valid, and the report must be regenerated if needed.

Response

{
  "downloadUrl": "string",
  "fileName": "string",
  "expiresAt": "2019-08-24T14:15:22Z"
}