Skip to main content
PUT
Update a participant

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Cabeçalhos

X-Idempotency
string
obrigatório

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

Maximum string length: 255

Parâmetros de caminho

participantId
string<uuid>
obrigatório

Participant id.

Corpo

application/json
name
string

New legal name (unchanged when omitted).

Maximum string length: 200
settlingInstitutionIspb
string

New settling institution ISPB (unchanged when omitted).

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

Resposta

OK

createdAt
string<date-time>
obrigatório

Creation timestamp.

id
string<uuid>
obrigatório

Participant id.

ispb
string
obrigatório

8-digit BACEN ISPB.

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

"46026562"

name
string
obrigatório

Participant legal name.

Maximum string length: 200
role
enum<string>
obrigatório

Participant role.

Opções disponíveis:
DIRECT,
INDIRECT,
SETTLING_INSTITUTION
statuses
object[]
obrigatório

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>
obrigatório

Last-update timestamp.

settlingInstitutionIspb
string

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

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