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

# List key claims

`GET /v2/pix/claims`

## Request

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

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` string, required: Pismo 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: A government document number, such as a Social Security number (US) or Cadastro de Pessoas Físicas number (Brazil). Must be numeric with 11-14 digits.
      - `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: `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.
      - `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: Bank-assigned branch ID or ISPB (Identifcador do Sistema de Pagamento Brazil) number - the Brazilian Payment System identifier, an 8-digit value.
    - `key` string, required: Value, based on a key's type, used to encrypt Pix key.
    - `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` 'USER_REQUESTED' | 'ACCOUNT_CLOSURE' | 'BRANCH_TRANSFER' | 'RECONCILIATION' | 'FRAUD' | 'DEFAULT_OPERATION' | 'RFB_VALIDATION': Reason for request
    - `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`: Forbidden
- `404`: Not Found
- `500`: Internal server errpr
- `502`: Bad Gateway
- `504`: Gateway Timeout

---

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