Create a report

Retrieve a report

Download a report

Reports

This endpoint allows you to create a report based on specified filters provided in the request body. 
Once the report request is submitted, it initiates the report generation process asynchronously and 
returns the report's ID and current status.

When the report is finished running, the Retrieve a report endpoint will include a URL where you can 
download your results. Alternatively, you can also specify the report to be delivered via email or SFTP. 
For email, specify the email address in the request body. For SFTP, the report will be delivered to the 
SFTP pre-configured. Please reach out to Banked Support to configure SFTP.

Signature

Idempotency-Key

The unique identifier of the report request.

region

The request provided by the client is invalid

You are not authorized to access this resource.

Please check your credentials and try again.

You have made too many requests in a short period of time.

Please wait a few seconds before trying again.

This endpoint retrieves the current status of a report by its unique report_id. 
If the report is completed successfully, the response will include a download URL for the report. 
If the report has failed, an error message will be returned, detailing the issue.

report_id

This endpoint allows the user to download the generated report by its unique report_id. 
The download will only be available if the report status is completed.