List the changes of the tenant's Pix key

Lists the changes of the Pix key of the tenant of the credentials you authenticate with, the most recent first, paginated: for each change, the key it set and the key it replaced, who made it and when, and how the key was checked against the holder of the collection account. Every write with POST /v1/admin/pix-config that changes the key is recorded, the tenant’s first key included (firstConfiguration: true, with no previous key); a write that keeps the key and changes only the address is not a change. Each change is announced by a PIX_KEY_CHANGED notice whose changeId is its id.

A CPF, e-mail or phone key is shown masked, by its type; a CNPJ key and a random key are shown whole. The keys are kept with no automatic purge, so the history answers which key a boleto that carries a Pix QR code, issued at a given instant, paid into.

A tenant with no change is answered 200 with an empty items list and total: 0, never 404. A page below 1 or a limit outside 1 to 100 is refused with 400 PBP-0001.

WHO MAY CALL IT. The caller needs the admin:read permission, which the editor, operator and viewer roles carry. A caller without it is refused with 403 PBP-0004 before the operation runs.

GET /v1/admin/pix-config/history

List the changes of the tenant's Pix key

cURL

curl --request GET \
  --url https://api.example.com/v1/admin/pix-config/history \
  --header 'Authorization: Bearer <token>'

200

{
  "items": [
    {
      "changedAt": "2026-10-31T14:05:09Z",
      "changedBy": "<string>",
      "firstConfiguration": true,
      "holderCheck": "VERIFIED",
      "id": "019a3b8e-6f1c-7d2e-8a4b-5c6d7e8f9a01",
      "key": "***.456.789-**",
      "keyType": "CPF",
      "previousKey": "f34f8ec2-a4b7-41b4-8200-b53a07e00bac",
      "previousKeyType": "EVP"
    }
  ],
  "limit": 20,
  "page": 1,
  "total": 3
}

Autorizaciones

Authorization · string · header · requerido

JWT bearer token issued by the identity provider.

Encabezados

X-Organization-Id · string

Tenant organization ID. Optional. The organization context is determined by the credentials you authenticate with; this header does not select or change it.

Parámetros de consulta

page · integer<int64> · predeterminado: 1

Page number, one-based.

Rango requerido: x >= 1

Ejemplo:

1

limit · integer<int64> · predeterminado: 20

Changes per page.

Rango requerido: 1 <= x <= 100

Ejemplo:

20

Respuesta

200

application/json

OK

items · object[] | null · requerido

Changes of the page, the most recent first. A tenant with no change answers an empty list.

Show child attributes

limit · integer<int64> · requerido

Changes per page.

Ejemplo:

20

page · integer<int64> · requerido

Page number, one-based.

Ejemplo:

1

total · integer<int64> · requerido

Number of changes of the tenant's Pix key. A page past the last change answers an empty items list and 0.

Ejemplo:

3