---
title: "List key claims"
method: GET
path: "/v2/pix/claims"
tags: ["Claims"]
---

# List key claims

`GET /v2/pix/claims`

List key DICT claims

## Query parameters

- `type` 'OWNERSHIP' | 'PORTABILITY'
- `status` 'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED'

## Headers

- `Authorization` string, required

## Response `200`

List claims

- ClaimListResponse
  - `claims` ClaimListItemResponse[]
    - `account_id` integer, required — Account ID
    - `claim_id` string, required — Claim ID for key transfer. The Create key claim or Create DICT key claim endpoint returns this field.
    - `claim_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.
    - `claimer` ClaimClaimer, required
      - `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
      - `trade_name` string — Name under which the business operates. Not necessarily the same as the legal name.
      - `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.
    - `claimer_account` ClaimClaimerAccount, 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 />
      - `opening_datetime` string, date-time, required — Opening date time. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
      - `participant` string, required — Participant's ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
      - `branch` string — This could be a bank-assigned branch ID or the branch's ISPB number.
    - `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.
    - `last_modified` string, date-time, required — Last modified datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
    - `status` 'OPEN' | 'WAITING_RESOLUTION' | 'CONFIRMED' | 'CANCELLED' | 'COMPLETED', required — Claim status
    - `creation_datetime` string, date-time, required — Creation datetime. A RFC 3339 date-time value. For example - `2023-04-12T23:20:50.52Z`.
    - `resolution_period_end` string, date-time, required — Resolution period end for claim. ISO 8601 format.
    - `reason` string — Reason that indicates why the card was added to the Protection Bulletin.
    - `completion_period_end` string, date-time — Completion period end for claim. Present for claim type `OWNERSHIP`. ISO 8601 format.

## Other responses

- `400` — Bad request
- `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)