Skip to main content
GET
Obter um participante

Autorizações

Authorization
string
header
obrigatório

JWT bearer token issued by the identity provider.

Parâmetros de caminho

id
string
obrigatório

Participant id (UUID).

Exemplo:

"0190b5a0-0000-7000-8000-0000000000aa"

Resposta

OK

active
boolean
obrigatório

Whether the participant is active.

Exemplo:

true

connectivityOk
boolean | null
obrigatório

Last connectivity-probe result; null until a probe runs.

Exemplo:

true

createdAt
string<date-time>
obrigatório

Creation timestamp (RFC3339 UTC).

Exemplo:

"2026-06-15T07:50:00Z"

id
string
obrigatório

Participant id (UUID).

Exemplo:

"018f8a3e-4b2c-7c1a-9e5d-2f6a1b3c4d5e"

lastConnectivityAt
string<date-time> | null
obrigatório

Timestamp of the last connectivity probe (RFC3339 UTC); null until a probe runs.

Exemplo:

"2026-06-15T07:50:00Z"

name
string
obrigatório

Participant legal name.

Exemplo:

"Acquirer Example S.A."

type
string
obrigatório

Participant role/type in the card-settlement flow.

Exemplo:

"ACQUIRER"

updatedAt
string<date-time>
obrigatório

Last-update timestamp (RFC3339 UTC).

Exemplo:

"2026-06-15T07:50:00Z"

bcbCode
string

Participant code at the Banco Central.

Exemplo:

"0001"

document
string

Participant CNPJ (14 digits, unformatted).

Exemplo:

"12345678000199"

ispb
string

Participant ISPB (8-digit identifier).

Exemplo:

"29011780"

metadata
object

Free-form tenant metadata key/value pairs.

nucleaCode
string

Participant code assigned by Núclea.

Exemplo:

"NU12345"