Claves PIX

Lista las claves PIX registradas en la cuenta asociada a la API Key.

Endpoint

GET /api/external/pix/keys

Headers

Header	Tipo	Obligatorio	Descripcion
Authorization	String	Si	ApiKey {client_id}:{client_secret}

Ejemplo

curl -X GET https://api.owem.com.br/api/external/pix/keys \
  -H "Authorization: ApiKey $CLIENT_ID:$CLIENT_SECRET"

Respuesta Exitosa (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"
    }
  ]
}

Campo	Tipo	Descripcion
worked	Boolean	true indica exito en la operacion
keys	Array	Lista de claves PIX de la cuenta
keys[].key	String	Valor de la clave PIX
keys[].key_type	String	Tipo de clave (ver tabla abajo)
keys[].status	String	Estado actual de la clave
keys[].created_at	String	Fecha de registro (ISO 8601)

Tipos de Clave

Tipo	Formato	Ejemplo
cpf	11 digitos	12345678901
cnpj	14 digitos	12345678000190
email	E-mail valido	contato@empresa.com.br
phone	+55 + DDD + numero	+5511999998888
evp	UUID v4 (clave aleatoria)	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Estado de la Clave

Status	Descripcion
active	Clave activa y operacional
pending	Registro en procesamiento en el DICT
portability	En proceso de portabilidad

Respuesta de Error (401)

{
  "error": {
    "status": 401,
    "message": "Missing API key credentials. Use Authorization: ApiKey <client_id>:<client_secret>"
  }
}

Limites por tipo de clave

Cuentas PF: hasta 5 claves. Cuentas PJ: hasta 20 claves. Solo se permite 1 clave CPF/CNPJ por cuenta.