---
title: "List user keys"
method: GET
path: "/v2/pix/keys"
tags: ["Keys"]
---

# List user keys

`GET /v2/pix/keys`

## Request

- Base URL: `https://sandbox.pismolabs.io/pix-dict`
- URL: `https://sandbox.pismolabs.io/pix-dict/v2/pix/keys`
- Auth: HTTP bearer

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

## Query parameters

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

## Headers

- `Authorization` string, required

## Response `200`

OK

- PresenterListResponse
  - `keys` PresenterKeyItemResponse[]
    - `bank_account` PresenterBankAccount
      - `participant` string, required: Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
      - `account_number` string, required: Account number.
      - `account_type` 'CACC' | 'SLRY' | 'SVGS' | 'TRAN', required: Account type: `CACC` - Checking account `SVGS` - Savings account `TRAN` - Transactional account (Brazil only). Also known as "conta corrente" in Portuguese, this is a bank account type designed for everyday financial transactions and is the most common type individuals and businesses use for day-to-day banking. `SLRY` - Salary account. Employer deposits a fixed amount every month.
      - `branch` string, required: Bank-assigned branch ID or ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
      - `opening_datetime` string, date-time, required: Opening date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
    - `key` string: Value, based on a key's type, used to encrypt Pix key.
    - `key_type` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP': User information that can be used to create a Pix key: * `CPF` - Cadastro de Pessoas Fisicas (Indiviual Taxpayer Registry) number. Similar to a Social Security number in the US. * `CNPJ` - Cadastro Nacional de Pessoa Juridica (National Registry of Legal Entities) number. Unique ID for legal entities, such as companies and organizations, in Brazil * `EMAIL` - Email * `PHONE` - Phone number * `EVP` - Endereco de pagamento virtual (virtual payment address). A randomly-generated UUID number.
    - `creation_datetime` string, date-time: Creation datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
    - `ownership_datetime` string, date-time: Ownership date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.

## Other responses

- `400`: Bad Request
- `404`: Resource Not Found
- `409`: Conflict
- `500`: Internal Server Error

---

[API](https://skmtc.dev/pismo/apis/instant-payments-pix-management.md) - [All operations](https://skmtc.dev/pismo/apis/instant-payments-pix-management/llms.txt) - [OpenAPI document](https://skmtc.dev/pismo/apis/instant-payments-pix-management/revisions/eb540c289547?raw)