Query Account Blocks

Request

ENDPOINT

/account/ACCOUNT_KEY/account_block_records

METHOD

GET

Path parameters

Field	Type	Description
ACCOUNT_KEY	UUID	Key of the account to be detailed

Query parameters

Field	Type	Description	Characters
block_order_statuses *	enumerator	Indicates the status of the block order.	block_order_statuses enumerators

block_order_statuses enumerators

Enumerator	Description
pending	Pending block order
open	Open block order
concluded	Concluded block order

Response

STATUS

200

Response Body

{
  [
    {
      "account_blocked_amount": 1000,
      "block_order": {
        "block_order_protocol": "100000000",
        "block_order_sequence": "00001",
        "case_number": "0000000000000",
        "court_code": "00000",
        "defendant_document_number": "00000000000000",
        "institution_document_number": null,
        "lawsuit_author_name": "NOME DO JUIZ",
        "lawsuit_type": "labor",
        "protocol_datetime": "2025-04-28T08:34:16Z",
        "requested_amount": 1000,
        "requester_judge": "JUIZ DE DIREITO"
      }
    }
  ]
}

Response Body Params

Field	Type	Description	Max. Characters
account_blocked_amount	float	Amount blocked in the account.	-
block_order	object	Details of the block order.	block_order object

block_order object

Field	Type	Description	Max. Characters
block_order_protocol	string	Block order protocol.	-
block_order_sequence	string	Block order sequence.	-
case_number	string	Case number.	-
court_code	string	Court code.	-
defendant_document_number	string	Defendant's document number.	14
institution_document_number	string or null	Institution's document number, if applicable.	-
lawsuit_author_name	string	Lawsuit author's name.	-
lawsuit_type	enumerator	Lawsuit type.	lawsuit_type enumerators
protocol_datetime	string	Protocol date and time.	20
requested_amount	float	Requested amount.	-
requester_judge	string	Requesting judge's name.	-

lawsuit_type enumerators

Enumerator	Description
labor	Labor lawsuit
civil	Civil lawsuit
criminal	Criminal lawsuit
tax	Tax lawsuit
family	Family lawsuit

STATUS

404

Response Body: Account not found

{
    "title": "Not Found",
    "description": "Account not found for the given key 3e4b8746-da58-4799-bcd0-063326428d3f",
    "translation": "Conta não encontrada para a seguinte chave 3e4b8746-da58-4799-bcd0-063326428d3f",
    "code": "ACC000006"
}

STATUS

403

Response Body: User does not have permission

{
    "title": "Permission Validator Error",
    "description": "Selected agent do not own this item.",
    "translation": "O agente selecionado não é dono do item.",
    "code": "QIT000005"
}