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

# List user keys

`GET /v2/pix/keys`

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: <br /> `CACC` - Checking/current account. 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.<br /> `SVGS` - Savings account<br /> `TRAN` - Payment account. Payment institutions offer payment accounts to move funds and make payments, while banks offer checking accounts that include full financial services such as credit and investments.<br /> `SLRY` - Salary account. Employer deposits a fixed amount every month.<br />
      - `branch` string, required — This could be a bank-assigned branch ID or the branch's ISPB number.
      - `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 — Pix key value.
    - `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.net/pismo/apis/platform-authentication.md) · [All operations](https://skmtc.net/pismo/apis/platform-authentication/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/pismo/platform-authentication/versions/935b62e16de4/schema)