List Pix keys by tax ID

​

Retrieves all active Pix keys associated with a specific tax ID (CPF/CNPJ), supporting pagination and sorting.

Query Parameters
  • branch
    Type: string
    min length:  
    1
    required

    Account branch number

  • accountNumber
    Type: string
    min length:  
    1
    required

    Account number

  • status
    Type: string enum

    Filter by key status

    values
    • ACTIVE
    • INACTIVE
    • OPEN
    • WAITING_RESOLUTION
    • CONFIRMED
    • CANCELLED
    • COMPLETED
  • keyType
    Type: string enum

    Filter by Pix key type

    values
    • EVP
    • CPF
    • CNPJ
    • PHONE
    • EMAIL
  • page
    Type: integer Format: int32

    Page number to retrieve (zero-based, minimum: 0)

  • size
    Type: integer Format: int32

    Number of records per page (minimum: 1, maximum: 500)

  • sort
    Type: array string[]

    Sort criteria list

Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request (UUID format)

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/keys
curl 'http://localhost:8080/api/v1/keys?branch=&accountNumber=' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "items": [
    {
      "id": "string",
      "status": "ACTIVE",
      "keyType": "EVP",
      "key": "string",
      "owner": {
        "personType": "string",
        "taxId": "string",
        "name": "string",
        "tradeName": "string"
      },
      "account": {
        "ispb": "string",
        "type": "string",
        "branch": "string",
        "number": "string",
        "openingDate": "2026-07-29T19:28:46.556Z"
      },
      "reason": "USER_REQUESTED",
      "keyOwnershipDate": "2026-07-29T19:28:46.556Z",
      "createdAt": "2026-07-29T19:28:46.556Z",
      "updatedAt": "2026-07-29T19:28:46.556Z",
      "creationDate": "2026-07-29T19:28:46.556Z",
      "openClaimCreationDate": "2026-07-29T19:28:46.556Z",
      "endToEndId": "string",
      "ownerStatistics": {
        "spi": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "settlements": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "fraudMarkers": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "applicationFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "muleAccounts": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "scammerAccounts": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "otherFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "unknownFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "totalFraudTransactionAmount": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "distinctFraudReporters": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "infractionReports": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "openReports": 1,
          "openReportsDistinctReporters": 1,
          "rejectedReports": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "entries": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "registeredAccounts": 1
        }
      },
      "keyStatistics": {
        "spi": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "settlements": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "fraudMarkers": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "applicationFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "muleAccounts": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "scammerAccounts": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "otherFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "unknownFrauds": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "totalFraudTransactionAmount": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          },
          "distinctFraudReporters": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "infractionReports": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "openReports": 1,
          "openReportsDistinctReporters": 1,
          "rejectedReports": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        },
        "entries": {
          "watermark": "2026-07-29T19:28:46.556Z",
          "distinctAccounts": {
            "d90": 1,
            "m12": 1,
            "m60": 1
          }
        }
      }
    }
  ],
  "totalItems": 1,
  "page": 1,
  "size": 1,
  "totalPages": 1,
  "hasNext": true
}

Pix keys retrieved successfully.