PIX Keys

Lists the PIX keys registered to the account associated with the API Key.

Endpoint

GET /api/v2/external/pix/keys

Headers

Header	Type	Required	Description
Authorization	String	Yes	Bearer {access_token}

Example

curl -X GET https://api.owem.com.br/api/v2/external/pix/keys \
  -H "Authorization: Bearer $TOKEN"

Success Response (200)

{
  "worked": true,
  "keys": [
    {
      "key": "12345678901",
      "key_type": "cpf",
      "status": "active",
      "created_at": "2026-02-05T12:00:00Z"
    },
    {
      "key": "a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d",
      "key_type": "evp",
      "status": "active",
      "created_at": "2026-02-10T14:30:00Z"
    },
    {
      "key": "contato@empresa.com.br",
      "key_type": "email",
      "status": "active",
      "created_at": "2026-02-15T09:00:00Z"
    }
  ]
}

Field	Type	Description
worked	Boolean	true indicates operation success
keys	Array	List of PIX keys for the account
keys[].key	String	PIX key value
keys[].key_type	String	Key type (see table below)
keys[].status	String	Current key status
keys[].created_at	String	Registration date (ISO 8601)

Key Types

Type	Format	Example
cpf	11 digits	12345678901
cnpj	14 digits	12345678000190
email	Valid email	contato@empresa.com.br
phone	+55 + area code + number	+5511999998888
evp	UUID v4 (random key)	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Key Status

Status	Description
active	Key is active and operational
pending	Registration in progress at DICT
portability	Portability in progress

Error Response (401)

{
  "worked": false,
  "detail": "Invalid or expired token"
}

Limits per key type

Individual accounts: up to 5 keys. Business accounts: up to 20 keys. Only 1 CPF/CNPJ key per account is allowed.