Skip to main content
GET
Get the APIX001 report of a closed reference month

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Query Parameters

period
string
required

Reference month, YYYY-MM. Absent or not YYYY-MM is 400 PIX-0020; a month before 2020-11, when Pix started, is 400 PIX-0003; a month in the future is 422 PIX-0710.

Pattern: ^[0-9]{4}-(0[1-9]|1[0-2])$
Example:

"2026-10"

Response

OK

blocks
object
required

The ten APIX001 blocks in layout order, each with explicit coverage.

ispb
string
required

ISPB of the participant the report is for.

Example:

"12345678"

layoutVersion
string
required

APIX001 layout version the blocks follow.

Example:

"2.7"

period
string
required

Reference month, YYYY-MM.

Example:

"2026-10"

reportId
string
required

Immutable identifier of this report; a reopen and a new close produce another.

Example:

"0193a6f0-7c1e-7b4a-9d2e-5f6a7b8c9d0e"