Skip to main content
POST
/
v1
/
reports
Request a report
curl --request POST \
  --url https://api-sandbox.circle.com/v1/reports \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "reportType": "camt053",
  "date": "2025-01-15"
}
'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "reportType": "camt053",
    "status": "ready",
    "downloadUrl": "https://s3.amazonaws.com/...",
    "expiresAt": "2025-01-15T15:00:00Z"
  }
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Body

application/json

Request body for generating a report. The reportType field determines the type of report and which additional fields are required.

​
reportType
enum<string>
required

Report type identifier.

Available options:
camt053
Example:

"camt053"

​
date
string<date>
required

The date of the daily CAMT.053 statement to retrieve (YYYY-MM-DD). Must be a past date for which a statement has been generated.

Example:

"2025-01-15"

Response

Report is ready. Use the pre-signed downloadUrl to download the file.

​
data
object

Metadata for a unified report. status reflects whether the generated file is available.

If status is ready, the response includes a pre-signed downloadUrl. If pending, generation is still in progress. Poll GET /v1/reports/{id} until ready, then download using GET /v1/reports/{id}/content.

Requests are idempotent: the same entity and request parameters always produce the same report ID. Subsequent POST requests return the existing report.