Skip to main content
GET
List CID set events at BACEN

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"

Query Parameters

keyType
enum<string>
required

Key type of the CID set.

Available options:
CPF,
CNPJ,
EMAIL,
PHONE,
EVP
Example:

"CPF"

startTime
string<date-time>

Inclusive lower bound on the event timestamp; omit to start at the oldest event BACEN holds.

Example:

"2026-09-28T00:00:00Z"

endTime
string<date-time>

Inclusive upper bound on the event timestamp; omit for no upper bound.

Example:

"2026-09-28T23:59:59Z"

limit
integer<int64>
default:100

Maximum events per page (1..200, default 100).

Required range: 1 <= x <= 200
Example:

100

Response

OK

cidSetEvents
object[]
required

The events, ordered by timestamp; empty when BACEN lists none.

endTime
string
required

Timestamp of the last event in the page, BACEN's wire value.

Example:

"2026-09-28T23:59:59.999Z"

hasMoreElements
boolean
required

True when BACEN holds more events after this page; ask again from endTime.

Example:

false

keyType
string
required

Key type of the CID set.

Example:

"CPF"

participant
string
required

ISPB whose CID set the events belong to.

Example:

"12345678"

startTime
string
required

Timestamp of the first event in the page, BACEN's wire value.

Example:

"2026-09-28T00:00:00.000Z"

syncVerifierEnd
string
required

BACEN's sync verifier of the set after the last event.

Example:

"cb4f8a1d9e3b27c05f6a4d8e2b1c7f90a3e5d6b8c2f4a1e7d9b3c5f8a2e4d6b1"

syncVerifierStart
string
required

BACEN's sync verifier of the set before the first event.

Example:

"e3b0c44298fc1c149afbf4c8996fb92427ae41e4649b934ca495991b7852b855"

bacen
object

BACEN's operational envelope for this call; omitted when BACEN sent no correlation id.