Retrieve a Pix key

​

Retrieves the details of a Pix key based on its value. When includeStatistics=true, the response includes key and owner statistics. When payerDocument is not provided, the lookup is restricted to internal cache and database; DICT is not queried and 404 is returned if the key is not found locally.

Path Parameters
  • key
    Type: string
    required

    Pix key value (CPF, CNPJ, phone, email, or EVP)

Query Parameters
  • payerDocument
    Type: string

    Payer document (CPF or CNPJ). When present, the DICT is queried for the key entry; when absent, only the local cache is consulted and 404 is returned if the key is not found locally.

  • includeStatistics
    Type: boolean

    When true, includes anti-fraud statistics data in the response.

Headers
  • Idempotency-Key
    Type: string
    required

    Unique idempotency key for the request

Responses
  • application/json
  • application/json
  • application/json
  • application/json
Request Example for get/api/v1/keys/{key}
curl 'http://localhost:8080/api/v1/keys/{key}' \
  --header 'Idempotency-Key: ' \
  --header 'Authorization: Bearer YOUR_SECRET_TOKEN'

{
  "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.547Z"
  },
  "reason": "USER_REQUESTED",
  "keyOwnershipDate": "2026-07-29T19:28:46.547Z",
  "createdAt": "2026-07-29T19:28:46.547Z",
  "updatedAt": "2026-07-29T19:28:46.547Z",
  "creationDate": "2026-07-29T19:28:46.547Z",
  "openClaimCreationDate": "2026-07-29T19:28:46.547Z",
  "endToEndId": "string",
  "ownerStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "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.547Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "registeredAccounts": 1
    }
  },
  "keyStatistics": {
    "spi": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "settlements": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "fraudMarkers": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "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.547Z",
      "openReports": 1,
      "openReportsDistinctReporters": 1,
      "rejectedReports": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    },
    "entries": {
      "watermark": "2026-07-29T19:28:46.547Z",
      "distinctAccounts": {
        "d90": 1,
        "m12": 1,
        "m60": 1
      }
    }
  }
}

Pix key retrieved successfully.