search

Get Brokerage Account

hashtag
Get Brokerage Accounts

GET {{Environment_URL}}/customers/v1/partner/physical/:cpf/investmentBroker/:brokerId

This query retrieves detailed information for a specific brokerage account associated with a client. It is used to fetch complete account details for display, validation, or investment operation processing.

hashtag
Headers

Name
Value

Authorization

Bearer <token>

client-key

123ABCD456

Path Params

Parameter
Description
Type
Required
Example

cpf

The CPF. Must be a valid 11-digit number without punctuation.

String

Yes

"12345678900"

brokerId

The unique identifier of the brokerage account to retrieve. This ID is returned when the account is created or listed.

String

Yes

"5f96e5aa50ec760014d2bcc1"

Response

{
    "id": "68cd7e78661baded804358b3",
    "fullName": "BANCO DE TESTES",
    "currency": "USD",
    "address": {
        "street": "Rua StreetWear",
        "number": 123,
        "complement": "Ap 01",
        "neighborhood": "Washington",
        "city": "NY",
        "state": "NY",
        "zipCode": "09090119",
        "country": "US"
    },
    "subType": "INVESTMENTS",
    "personType": "LEGAL",
    "account": {
        "bankName": "BANCO DE TESTES",
        "name": "MY BANK",
        "number": "123456789",
        "bankCountry": "USA",
        "currency": "USD",
        "code": [
            {
                "option": "ACH",
                "value": "021000a021"
            }
        ]
    },
    "bankCode": "",
    "canBeRemoved": true
}