Skip to main content

List accounts

Request

ENDPOINT
/account
METHOD
GET

Query Params

FieldTypeDescriptionCharacters
owner_document_numberstringAccount holder's document number.-
account_numberstringAccount number.-

Response

STATUS
200
Response Body
{
"data": [
{
"account_block_reason": null,
"account_branch": "0001",
"account_credentials": [{
"account_id": 4130,
"created_at": "2023-05-15T19:56:10",
"credential_type": {
"created_at": "2019-06-18T13:19:30",
"enumerator": "observer",
"id": 3,
"translation_path": "account.CredentialType.observer"
},
"credential_type_id": 3,
"id": 4394,
"is_active": true,
"person_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
"updated_at": null
},
{
"account_id": 4130,
"created_at": "2023-05-15T19:56:10",
"credential_type": {
"created_at": "2019-06-18T13:19:30",
"enumerator": "approver_requester",
"id": 4,
"translation_path": "account.CredentialType.approver_requester"
},
"credential_type_id": 4,
"id": 4395,
"is_active": true,
"person_key": "77136fe2-2ddb-4593-b285-67c40b6da46a",
"updated_at": null
},
{
"account_id": 4130,
"created_at": "2023-05-15T19:56:10",
"credential_type": {
"created_at": "2019-06-18T13:19:30",
"enumerator": "requester",
"id": 2,
"translation_path": "account.CredentialType.requester"
},
"credential_type_id": 2,
"id": 4396,
"is_active": true,
"person_key": "77136fe2-2ddb-4593-b285-67c40b6da46a",
"updated_at": null
}
],
"account_digit": "5",
"account_documents": [],
"account_events": [{
"account_id": 4130,
"created_at": "2023-05-15T19:56:10",
"id": 6250,
"new_account_status": {
"created_at": "2019-10-11T18:58:31",
"enumerator": "opened",
"id": 1,
"translation_path": "account.AccountStatus.opened"
},
"new_account_status_id": 1,
"old_account_status": null,
"old_account_status_id": null
}],
"account_key": "3e4b8746-da58-4799-bcd0-063326428d3f",
"account_name": "Default",
"account_number": "5960388",
"account_status": {
"created_at": "2019-10-11T18:58:31",
"enumerator": "opened",
"translation_path": "account.AccountStatus.opened"
},
"account_type": {
"created_at": "2019-03-15T13:09:15",
"enumerator": "checking",
"translation_path": "account.AccountType.checking"
},
"automatic_transfer_management_status": {
"created_at": "2022-10-27T13:48:18",
"enumerator": "master"
},
"automatic_transfers": [],
"balance": 264.76,
"blocked_balance": 0,
"blocked_balance_events": [],
"created_at": "2023-05-15T19:56:10",
"destinations": [],
"fee": null,
"internal_webhooks": [{
"account_id": 4130,
"created_at": "2023-05-15T16:56:10",
"id": 144,
"is_active": true,
"updated_at": "2023-05-15T16:56:10",
"webhook_tag": {
"created_at": "2023-03-30T20:20:04",
"enumerator": "billing",
"id": 2
},
"webhook_tag_id": 2
}],
"investment_available_amount": 264.76,
"investment_configuration": {
"block_yield": false,
"daily_yield_percentage": 1,
"investment_configuration_status": "active",
"monthly_yield_amount": 0
},
"is_system_account": false,
"owner_document_number": "30987145223",
"owner_name": "Maria Luiza Vieira",
"owner_person_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
"permitted_person_keys": [
"47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
"47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
"77136fe2-2ddb-4593-b285-67c40b6da46a",
"77136fe2-2ddb-4593-b285-67c40b6da46a"
],
"requester_key": "77136fe2-2ddb-4593-b285-67c40b6da46a",
"requester_name": "White Label Develop",
"setup_fee": null,
"transactional_limit": null,
"webhook_enabled": true
},
{
"account_block_reason": null,
"account_branch": "9999",
"account_credentials": [],
"account_digit": "5",
"account_documents": [],
"account_events": [],
"account_key": "748b456c-92fb-4832-837a-0f0a15222a21",
"account_name": "investment-Default",
"account_number": "5960388",
"account_status": {
"created_at": "2019-10-11T18:58:31",
"enumerator": "opened",
"translation_path": "account.AccountStatus.opened"
},
"account_type": {
"created_at": "2022-09-05T20:57:05",
"enumerator": "investment",
"translation_path": "account.AccountType.investment"
},
"automatic_transfer_management_status": {
"created_at": "2022-10-27T13:48:18",
"enumerator": "master"
},
"automatic_transfers": [],
"balance": 0,
"blocked_balance": 0,
"blocked_balance_events": [],
"created_at": "2023-05-24T12:42:42",
"destinations": [],
"fee": null,
"internal_webhooks": [],
"investment_available_amount": 0,
"investment_configuration": null,
"is_system_account": false,
"owner_document_number": "30987145223",
"owner_name": "Maria Luiza Vieira",
"owner_person_key": "47d08366-a8ec-414c-a0a5-a089fc8a4ee8",
"permitted_person_keys": [
"47d08366-a8ec-414c-a0a5-a089fc8a4ee8"
],
"requester_key": "77136fe2-2ddb-4593-b285-67c40b6da46a",
"requester_name": "White Label Develop",
"setup_fee": null,
"transactional_limit": null,
"webhook_enabled": null
}
],
"pagination": {
"current_page": 1,
"next_page": null,
"rows_per_page": 100,
"total_pages": 1,
"total_rows": 2
}
}
STATUS
400
Response Body
{
"data": "{\"title\": \"Bad Request\", \"description\": \"Invalid request body.\", \"translation\": \"Corpo da requisição inválido.\", \"extra_fields\": {}, \"code\": \"LEG000069\"}"
}