Block an end user's DICT key queries

Stops serving DICT key queries for one end user: DICT 8.4 section 13.2.3’s “o participante deve bloquear imediatamente o(s) usuario(s) em questao”, which the same sentence conditions on a human having verified fundada suspeita and elevado indicio of misuse. Every later key lookup naming this payer is refused 403 before any read — before the retained directory answer and before this deployment’s own registry — because the block is a statement about the person, not about our wire traffic. One identified operator, no second approval, mandatory justification, audited under the caller’s identity before and after the effect. Idempotent: an end user already blocked answers 200 with alreadyApplied. Name the end user by the CPF/CNPJ the monitor read reports.

POST /api/v1/dict/internal/query-blocks

Block an end user's DICT key queries

cURL

curl --request POST \
  --url https://api.example.com/api/v1/dict/internal/query-blocks \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "justification": "<string>",
  "payerId": "12345678901"
}
'

200

{
  "blocked": true,
  "payerId": "12345678901",
  "alreadyApplied": true
}

Autorizações

Authorization · string · header · obrigatório

JWT bearer token issued by the identity provider.

Corpo

application/json

justification · string · obrigatório

Why this end user is being blocked or released — the verified suspicion section 13.2.3 conditions the act on, in the operator's own words. Recorded in the audit trail under the caller's identity. Operator prose only: never a tax id, a Pix key, an account or a holder name.

Required string length: 8 - 384

payerId · string · obrigatório

The end user's CPF (digits) or CNPJ (alphanumeric, IN RFB 2.229/2024) — the same identifier their key queries carry in PI-PayerId and the monitor read reports.

Pattern: ^([0-9]{11}|[A-Za-z0-9]{12}[0-9]{2})$

Exemplo:

"12345678901"

Resposta

200

application/json

OK

blocked · boolean · obrigatório

Whether this end user's DICT key queries are blocked after the call.

Exemplo:

true

payerId · string · obrigatório

CPF or CNPJ of the end user this call acted on.

Exemplo:

"12345678901"

alreadyApplied · boolean

True when the end user was already on the requested side and nothing changed. The call is a success either way and is still audited under the caller's identity, so re-sending a request whose response was lost is safe.