Get Address Info

Returns public information about a destination address so you can verify the recipient before sending a transfer.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…

PIX QR codes

For BRAZIL, the address can be a PIX key or a PIX QR code (EMV string). Send QR codes as the address query parameter instead of in the path, URL-encoding the value:

GET /wallet/v1/address-info?exchange=BRAZIL&address=00020101021126580014br.gov.bcb.pix0136a1b2c3d4-0000-0000-0000-0000000000005204000053039865802BR5912LOJA%20EXEMPLO6009SAO%20PAULO62070503%2A%2A%2A630468F8

The response has the same fields as for a PIX key. recipientLegalId comes masked, in the same format for a QR code as for a key: a CPF as 123******09 and a CNPJ as 12**********95. For a QR code, which digits are visible can vary.

{
  "exchange": "BRAZIL",
  "asset": "BRL",
  "destination": "00020101021126580014br.gov.bcb.pix0136a1b2c3d4-0000-0000-0000-0000000000005204000053039865802BR5912LOJA EXEMPLO6009SAO PAULO62070503***630468F8",
  "recipientName": "LOJA EXEMPLO",
  "recipientLegalId": "12**********95"
}

When the QR code fixes the amount to pay, the response also includes amount. It is absent when the payer chooses the amount, as in the example above:

{
  "exchange": "BRAZIL",
  "asset": "BRL",
  "destination": "00020101021126580014br.gov.bcb.pix0136a1b2c3d4-0000-0000-0000-0000000000005204000053039865406100.005802BR5912LOJA EXEMPLO6009SAO PAULO62070503***63046933",
  "recipientName": "LOJA EXEMPLO",
  "recipientLegalId": "12**********95",
  "amount": "100.00"
}
Path Params
string
required

Destination address to look up (CBU, CVU, alias, PIX key, or equivalent). URL-encode the value before sending it.

Query Params
string
enum
required

Exchange (country) that determines which banking network to query

Allowed:
Headers
string
Responses

Language
Credentials
Header
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json