Skip to main content
POST
Lift a judicial block on a PIX key

Authorizations

Authorization
string
header
required

JWT bearer token issued by the identity provider.

Body

application/json
keyValue
string
required

PIX key the ofício names, in its canonical format for the key type. At most 77 characters, the ceiling BACEN publishes on a DICT key.

Required string length: 1 - 77
Example:

"12345678901"

oficioReference
string
required

Reference of the Banco Central ofício ordering (or revoking) the block — process number, document id, whatever the order carries. Recorded in the audit trail under the caller's identity and never emitted on the event topic. Operator prose only: never a tax id, a Pix key, an account or a holder name.

Required string length: 8 - 384

Response

OK

keyValue
string
required

The key, as supplied.

Example:

"12345678901"

status
enum<string>
required

The key's status after this call.

Available options:
ACTIVE,
INACTIVE,
PENDING_CLAIM,
PENDING_BACEN_SYNC,
BLOCKED
Example:

"BLOCKED"

alreadyApplied
boolean

True when the key was already on the requested side of the block and nothing was written. 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.