Skip to main content
GET
Get a participant's operational status

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

ispb
string | null
obrigatório

The participant's ISPB (8 characters) — the key the PAG0101 notice arrived under and the key the submission gate evaluates. Null when the participant has no ISPB registered, in which case it can never receive a notice.

Exemplo:

"12345678"

nonOperating
boolean
obrigatório

Whether the submission gate blocks this participant. Read with the SAME key (the participant's ISPB) and the SAME predicate the gate uses, so it cannot disagree with it. NO_NOTICE is false — no notice does not block.

Exemplo:

true

previousStatus
enum<string> | null
obrigatório

What the PREVIOUS row for this ISPB carried — a REWRITE marker, not a transition. PAG0101 is a recurring full-roster snapshot (at least 2 per business day) and there is no insert-only-on-change guard, so for a stable institution this equals status on essentially every read; a differing value is the exception. Diagnostic only: the submission gate reads status. Null on a first-ever notice or a NO_NOTICE answer.

Opções disponíveis:
ACTIVE,
SUSPENDED,
SPECIAL_REGIME,
null
Exemplo:

"ACTIVE"

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

When the notice was recorded (RFC3339 UTC); null on a NO_NOTICE answer.

Exemplo:

"2026-08-11T05:50:00Z"

source
string | null
obrigatório

Message type the status came from; null on a NO_NOTICE answer.

Exemplo:

"PAG0101"

sourceMessageId
string | null
obrigatório

Originating RSFN message id — the value to grep for in the logs to find the notice that caused this status. Null on a NO_NOTICE answer.

Exemplo:

"29011780260628000000050"

status
enum<string>
obrigatório

Latest operational status: ACTIVE, SUSPENDED, SPECIAL_REGIME, or NO_NOTICE when the participant exists but no PAG0101 has ever been recorded for it.

Opções disponíveis:
ACTIVE,
SUSPENDED,
SPECIAL_REGIME,
NO_NOTICE
Exemplo:

"SUSPENDED"