Sign in

v1

latestOpenAPI 3.1.0Copyright Pismo2026-07-247702,7523.1 MB
Keys

List user keys

Get a list of user keys based on the Pismo account ID, which is parsed from the account token.

get/v2/pix/keys

Query parameters

key_type'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP'

Type of user information that can be used to create a Pix key:

  • CPF - Cadastro de Pessoas Fisicas (Brazil - Individual Taxpayer Registry) number. Similar to a Social Security number in the US
  • CNPJ - Cadastro Nacional de Pessoa Juridica (Brazil - National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil
  • EMAIL - Email address
  • PHONE - Phone number
  • EVP - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.

If nothing is selected, all key data is returned.

Headers

Authorizationstring required
Example:Bearer eyJhbGci...IUzUx

Account token - an access token encoded with a Pismo account ID. Tokens can expire quickly, which can result in a <b>401 Unauthorized</b> message.

Response

OK

Example response

{
  "keys": [
    {
      "bank_account": {
        "participant": "00115678",
        "account_number": "98765432",
        "account_type": "TRAN",
        "branch": "011",
        "opening_datetime": "2020-08-13T13:49:03Z"
      },
      "key": "email@email.com",
      "key_type": "EMAIL",
      "creation_datetime": "2020-08-13T13:49:03Z",
      "ownership_datetime": "2020-08-13T13:49:03Z"
    }
  ]
}