Skip to main content
DELETE
Release an end user's DICT key queries

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
justification
string
required

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

The end user's CPF or CNPJ, digits only — the same identifier their key queries carry in PI-PayerId. Hashed immediately and never stored, logged or returned. Supply this OR payerIdHash, not both.

Pattern: ^([0-9]{11}|[0-9]{14})$
Example:

"12345678901"

payerIdHash
string

Keyed digest of the end user's CPF/CNPJ, as the monitor read reports it. Supply this OR payerId, not both.

Pattern: ^[0-9a-f]{64}$
Example:

"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"

Response

OK

blocked
boolean
required

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

Example:

true

payerIdHash
string
required

Keyed digest of the end user this call acted on.

Example:

"9f86d081884c7d659a2feaa0c55ad015a3bf4f1b2b0b822cd15d6c15b0f00a08"

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.