Skip to main content
GET
cURL

Headers

Authorization
string
required

Bearer token. Format: Bearer <api_key>

Path Parameters

reportId
string
required

Report identifier.

Response

The request has succeeded.

A report of your organization: a statement, a balance certificate or a bank confirmation letter.

object
enum<string>
required

Object type. Always report.

Available options:
report
reportId
string
required

Report identifier.

type
enum<string>
required

The kind of document.

Available options:
ACCOUNT_STATEMENT,
TRANSACTION_STATEMENT,
BALANCE_CERTIFICATE,
BANK_CONFIRMATION_LETTER
format
enum<string>
required

File format.

Available options:
PDF,
CSV
status
enum<string>
required

Where the report stands. Download it once READY.

Available options:
PENDING,
PROCESSING,
READY,
FAILED
from
string | null
required

First day covered (YYYY-MM-DD, UTC) for a statement; null otherwise.

to
string | null
required

Last day covered, inclusive (YYYY-MM-DD, UTC) for a statement; null otherwise.

asOf
string | null
required

The day whose closing balances a certificate states (YYYY-MM-DD, UTC); null for other reports.

currency
string | null
required

The one currency covered, or null when the report covers every currency.

fileName
string | null
required

File name, once READY.

sizeBytes
integer<int32> | null
required

File size in bytes, once READY.

createdAt
string
required

When the report was requested.

readyAt
string | null
required

When the file became available. null until READY.