Skip to main content
POST
Register a participant

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Headers

X-Idempotency
string
required

Idempotency key for this state-changing request (required, max 255 characters).

Maximum string length: 255

Body

application/json
ispb
string
required

8-digit BACEN ISPB.

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

"46026562"

name
string
required

Participant legal name.

Maximum string length: 200
role
enum<string>
required

Participant role.

Available options:
DIRECT,
INDIRECT,
SETTLING_INSTITUTION
settlingInstitutionIspb
string

Required when role is INDIRECT.

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

Response

Created

createdAt
string<date-time>
required

Creation timestamp.

id
string<uuid>
required

Participant id.

ispb
string
required

8-digit BACEN ISPB.

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

"46026562"

name
string
required

Participant legal name.

Maximum string length: 200
role
enum<string>
required

Participant role.

Available options:
DIRECT,
INDIRECT,
SETTLING_INSTITUTION
statuses
object[]
required

The câmara's standing operational situation, one entry per product a PAG0101 has named (never null; empty when none has).

updatedAt
string<date-time>
required

Last-update timestamp.

settlingInstitutionIspb
string

For an indirect participant, the ISPB of its settling institution.

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