List all company PIX keys

Requires the banking.list permission.

Returns all PIX keys for the authenticated company. Each item includes dict_key_information when a DICT snapshot has been persisted for that key; otherwise the field is present and null.

GET /v1/companies/me/pix-keys

List all company PIX keys

cURL

curl --request GET \
  --url https://api-sandbox.rinne.com.br/core/v1/companies/me/pix-keys \
  --header 'x-api-key: <api-key>'

200

[
  {
    "id": "123e4567-e89b-12d3-a456-426614174001",
    "company_id": "a3dbd0c2-9f79-4f86-8caa-47779b3f2793",
    "key_type": "EMAIL",
    "key": "[e-mail]",
    "primary": false,
    "status": "ACTIVE",
    "deleted_at": null,
    "created_at": "2025-01-01T10:00:00.000Z",
    "updated_at": "2025-01-01T10:05:00.000Z",
    "dict_key_information": {
      "bank": "18236120",
      "account": "********",
      "branch": "0",
      "account_type": "********",
      "owner_name": "teste celcoin",
      "owner_document": "***778477**",
      "is_owned_by_company": true
    }
  }
]

Authorizations

x-api-key · string · header · required

Company API key for authentication

Response

200

application/json

PIX keys retrieved successfully

id · string<uuid> · required

PIX key ID

Example:

"123e4567-e89b-12d3-a456-426614174001"

company_id · string<uuid> · required

Company ID

Example:

"a3dbd0c2-9f79-4f86-8caa-47779b3f2793"

key_type · enum<string> · required

PIX key type

Available options: CPF, CNPJ, EMAIL, PHONE, EVP

Example:

"EMAIL"

key · string · required

PIX key value

Example:

"[e-mail]"

primary · boolean · required

Whether this is the primary PIX key

Example:

false

status · enum<string> · required

PIX key status

Available options: ACTIVE, DELETED

Example:

"ACTIVE"

deleted_at · string<date-time> | null · required

Deletion timestamp (null if not deleted)

Example:

null

created_at · string<date-time> · required

Creation timestamp

Example:

"2025-01-01T10:00:00.000Z"

updated_at · string<date-time> · required

Last update timestamp

Example:

"2025-01-01T10:05:00.000Z"

dict_key_information · object · required

Last persisted DICT key lookup snapshot for this PIX key (from create or update). Always present on every company and merchant PIX key response; use null when no snapshot is stored (for example legacy keys) or the stored snapshot is invalid.

Per BACEN's rules, DICT applies masking to protect against read attacks; fields such as account number, account type, and owner document may appear partially or fully masked (e.g. asterisks). Use the values as returned for any follow-up payment initiation on the same flow.

Show child attributes