Retrieve Key Statistics

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/statistics/keys/{key} \
  --header 'Authorization: Bearer <token>'

{
  "keyStatistics": {},
  "ownerStatistics": {}
}

Retrieve Key Statistics

Use this endpoint to fetch usage and risk statistics for a specific Pix key.

Notes:

Returns both key-level statistics and owner-level statistics in a single response.
Key statistics track data specific to the Pix key as an entity independent of its current owner.
Owner statistics provide the same data as the person statistics endpoint for the key’s current owner.
This endpoint queries the provider directly and does not store data locally.
Use this information for comprehensive risk assessment when processing payments to a Pix key.

GET

dict

statistics

keys

{key}

Retrieve Key Statistics

curl --request GET \
  --url https://plugin-pix-indirect.api.lerian.net/v1/dict/statistics/keys/{key} \
  --header 'Authorization: Bearer <token>'

{
  "keyStatistics": {},
  "ownerStatistics": {}
}

Authorization

string

header

required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

key

string

required

Pix key value (CPF, CNPJ, Email, Phone, or EVP).

Key statistics retrieved successfully.

keyStatistics

object

Statistics specific to the Pix key.

ownerStatistics

object

Statistics for the key owner.

⌘I