Skip to main content
GET
/
v1
/
reports
/
{id}
Get report by ID
curl --request GET \
  --url https://api-sandbox.circle.com/v1/reports/{id} \
  --header 'Authorization: Bearer <token>'
{
  "data": {
    "id": "550e8400-e29b-41d4-a716-446655440000",
    "reportType": "camt053",
    "status": "ready",
    "downloadUrl": "https://s3.amazonaws.com/...",
    "expiresAt": "2025-01-15T16:00:00Z"
  }
}

Documentation Index

Fetch the complete documentation index at: https://developers.circle.com/llms.txt

Use this file to discover all available pages before exploring further.

Authorizations

​
Authorization
string
header
required

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

Path Parameters

​
id
string<uuid>
required

The report ID.

Example:

"550e8400-e29b-41d4-a716-446655440000"

Response

Report metadata. Includes downloadUrl when status is ready.

​
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.