---
title: "Get key"
method: POST
path: "/v2/pix/keys/search"
tags: ["Keys"]
---

# Get key

`POST /v2/pix/keys/search`

Searches for a DICT key entry returning the owner information.

## Headers

- `Authorization` string, required

## Request body

- PresenterSearchRequest
  - `key` string, required — Pix key value.

## Response `200`

OK

- PresenterSearchResponse
  - `org_id` string — Organization ID
  - `account_id` integer — Account ID
  - `key` string, required — Pix key value.
  - `key_type` 'CPF' | 'CNPJ' | 'PHONE' | 'EMAIL' | 'EVP', required — 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.
  - `bank_account` PresenterBankAccount, required
    - `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`.
  - `owner` PresenterOwner
    - `document_number` string, required — Cardholder government document number. This can be from any document that identifies the cardholder such as a Tax ID, State ID, or driver's license.
    - `name` string, required — Person's name
    - `type` 'LEGAL_PERSON' | 'NATURAL_PERSON', required — Person type: * `LEGAL_PERSON` - An actual person with legal rights. * `NATURAL_PERSON` - An entity, such as an organization or company.
    - `trade_name` string — Name under which the business operates. Not necessarily the same as the legal name.
  - `creation_datetime` string, date-time, required — 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`.
  - `correlation_id` string — The Correlation identifier field is used to link related API requests and events. The CID can help the Pismo engineering team track everything related to a call. If not passed, a random one is generated. You can find the CID in the response header.
  - `claim_requested_datetime` string, date-time — Claim requested date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.

## Other responses

- `401` — Access token is missing or invalid
- `403` — The request has been lost
- `404` — Resource Not Found
- `409` — Conflict
- `429` — Too many reqquests
- `500` — Internal Server Error
- `502` — Bad Gateway
- `503` — Service Unavailable
- `504` — Gateway timeout

---

[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)