---
title: "Create key claim"
method: POST
path: "/v2/pix/claims"
tags: ["Claims"]
---

# Create key claim

`POST /v2/pix/claims`

Register a DICT claim for a key. 

The Brazil Central Bank maintains Pix keys in the Diretório de Identificadores de Contas Transacionais (DICT), a national Pix key registry and database.

On PSP timeout, a `202 Accepted` response is returned and the process continues asynchronous, eventually emitting a claim successful creation event.

This endpoint generates a <a href="https://developers.pismo.io/events/docs/pix-dict-claim-status-change-1" >Pix key claim status changed</a> event.

For more information, refer to [Pix key transfer (key claim)](https://developers.pismo.io/pismo-docs/docs/pix-instant-payments#pix-key-transfer-key-claim).

## Headers

- `Authorization` string, required
- `Idempotency-Key` string, required

## Request body

- ClaimRegisterClaimRequest
  - `claimer_account` ClaimAccount, required
    - `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.
    - `participant` string — Participant's 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, 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.
  - `type` 'OWNERSHIP' | 'PORTABILITY', required — Key claim type: * `OWNERSHIP` - Transfers key ownership between individuals in the same or another bank. * `PORTABILITY`- Transfers key ownership for the same individual to another bank.
  - `name_type` 'REGISTRATION_NAME' | 'SOCIAL_NAME' — Name type: * `REGISTRATION_NAME` - Name assigned at birth * `SOCIAL_NAME` - Preferred name, not necessarily `REGISTRATION_NAME`

## Response `200`

Claim registered

- ClaimRegisterClaimResponse
  - `bacen_response_time` string, date-time — Banco Central do Brasil (Central Bank of Brazil) response datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
  - `claim_id` string — Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.
  - `claimer` ClaimOwner
    - `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` 'OWNERSHIP' | 'PORTABILITY', required — Key claim type: * `OWNERSHIP` - Transfers key ownership between individuals in the same or another bank. * `PORTABILITY`- Transfers key ownership for the same individual to another bank.
    - `trade_name` string — Name under which the business operates. Not necessarily the same as the legal name.
  - `claimer_account` ClaimAccount
    - `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.
    - `participant` string — Participant's 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`.
  - `completion_period_end_datetime` string, date-time — Completion period end for claim. Present for claim type `OWNERSHIP`. ISO 8601 format.
  - `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.
  - `donor_participant` string — Donor participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
  - `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.
  - `last_modified_datetime` string, date-time — Last modified datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
  - `resolution_period_end_datetime` string, date-time — Resolution period end for claim. ISO 8601 format.
  - `status` 'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED' — Claim status
  - `type` 'OWNERSHIP' | 'PORTABILITY' — Key claim type: * `OWNERSHIP` - Transfers key ownership between individuals in the same or another bank. * `PORTABILITY`- Transfers key ownership for the same individual to another bank.

## Other responses

- `202` — Accepted
- `400` — Bad request
- `401` — Access token is missing or invalid
- `403` — The request has been lost
- `404` — Not Found
- `500` — Internal server error
- `502` — Bad Gateway
- `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/revisions/935b62e16de4/schema)