Skip to main content
GET
Read a CID set file request

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-ISPB
string
required

ISPB of the participant the call acts for. It must be this deployment's direct participant or an indirect it sponsors; the body never carries it.

Pattern: ^[0-9A-Z]{8}$
Example:

"12345678"

Path Parameters

id
string
required

BACEN's id for the file, as POST cids/files returned it.

Pattern: ^[0-9]{1,19}$
Example:

"4521"

Response

OK

id
string
required

BACEN's id for the file.

Example:

"4521"

keyType
string
required

Key type of the CID set.

Example:

"EMAIL"

participant
string
required

ISPB whose CID set the file holds.

Example:

"12345678"

requestTime
string<date-time>
required

When BACEN received the request.

Example:

"2026-09-29T12:00:00.123Z"

status
string
required

The last status BACEN reported, verbatim: REQUESTED, PROCESSING, AVAILABLE, UNAVAILABLE or ERROR.

Example:

"AVAILABLE"

bytes
integer<int64>

Size of the file in bytes, as BACEN reported it; omitted until AVAILABLE.

Example:

3200000

creationTime
string<date-time>

When BACEN generated the file; omitted until it did.

Example:

"2026-09-29T12:01:10.5Z"

sha256
string

SHA-256 of the file, as BACEN reported it; omitted until AVAILABLE.

Example:

"f0e4c2f76c58916ec258f246851bea091d14d4247a2fc3e18694461b1816e13b"