Cles PIX

Liste les cles PIX enregistrees sur le compte associe a la cle API.

Endpoint

GET /api/external/pix/keys

En-tetes

En-tete	Type	Obligatoire	Description
Authorization	String	Oui	ApiKey {client_id}:{client_secret}

Exemple

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

Reponse de succes (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"
    }
  ]
}

Champ	Type	Description
worked	Boolean	true indique le succes de l'operation
keys	Array	Liste des cles PIX du compte
keys[].key	String	Valeur de la cle PIX
keys[].key_type	String	Type de la cle (voir tableau ci-dessous)
keys[].status	String	Statut actuel de la cle
keys[].created_at	String	Date d'enregistrement (ISO 8601)

Types de cle

Type	Format	Exemple
cpf	11 chiffres	12345678901
cnpj	14 chiffres	12345678000190
email	E-mail valide	contato@empresa.com.br
phone	+55 + indicatif regional + numero	+5511999998888
evp	UUID v4 (cle aleatoire)	a1b2c3d4-e5f6-4a7b-8c9d-0e1f2a3b4c5d

Statut de la cle

Statut	Description
active	Cle active et operationnelle
pending	Enregistrement en cours de traitement au DICT
portability	En cours de portabilite

Reponse d'erreur (401)

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

Limites par type de cle

Comptes PF : jusqu'a 5 cles. Comptes PJ : jusqu'a 20 cles. Une seule cle CPF/CNPJ par compte est autorisee.