Skip to main content
GET
/
v4
/
i
/
baas
/
accounts
/
{accountId}
/
pix-keys
curl -X GET https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

{
  "requestId": "5bbaf3ce-0e75-446d-8dea-43f805db8af4",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "123456789012",
    "ispb": "37839059",
    "agency": "0001",
    "holderName": "JOAO DA SILVA",
    "holderDocument": "12345678901",
    "keys": [
      {
        "key": "9d4c2c8e-1234-4294-b1a0-d41e8be92d6d",
        "type": "EVP",
        "name": "JOAO DA SILVA",
        "isCurrent": true,
        "createdAt": 1768253830000
      }
    ]
  }
}

curl -X GET https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)"

​
Descrição

Lista todas as chaves PIX registradas em uma conta bancária BaaS. Retorna informações como tipo, valor e status de cada chave.
PROGRAMA BETA - Este endpoint está disponível apenas para parceiros aprovados no programa BAAS.

​
Autenticação

Este endpoint usa Basic Auth com sua API Key + Secret. O scope baas:accounts é configurado pela Owem na sua API Key.
Authorization: Basic {Base64(API_KEY:API_SECRET)}

​
Request

​
Headers

HeaderTipoObrigatórioDescrição
Authorizationstring✅Basic Auth (API Key + Secret em Base64)

​
Path Parameters

ParâmetroTipoObrigatórioDescrição
accountIdstring✅ID da conta (retornado em onboarding/status)

​
Response

​
Sucesso (200 OK)

{
  "requestId": "5bbaf3ce-0e75-446d-8dea-43f805db8af4",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "123456789012",
    "ispb": "37839059",
    "agency": "0001",
    "holderName": "JOAO DA SILVA",
    "holderDocument": "12345678901",
    "keys": [
      {
        "key": "9d4c2c8e-1234-4294-b1a0-d41e8be92d6d",
        "type": "EVP",
        "name": "JOAO DA SILVA",
        "isCurrent": true,
        "createdAt": 1768253830000
      }
    ]
  }
}

​
Campos da Response

CampoTipoDescrição
accountIdstringID/Número da conta
ispbstringCódigo ISPB do banco (8 dígitos)
agencystringCódigo da agência
holderNamestringNome completo do titular
holderDocumentstringCPF/CNPJ do titular
keysarrayLista de chaves PIX

​
Campos de Cada Chave

CampoTipoDescrição
keystringValor da chave PIX (usar em set-current/delete)
typestringTipo: CPF, CNPJ, EMAIL, PHONE, EVP
namestringNome do titular
isCurrentbooleanSe é a chave principal da conta
createdAtnumberTimestamp de criação (ms)

​
Tipos de Chave PIX

TipoDescrição
CPFCPF do titular (formato: 12345678900)
EMAILEmail do titular
PHONETelefone (+5511999998888)
EVPChave aleatória (UUID gerado automaticamente)

​
Erros

CódigoDescrição
403Conta não pertence a este parceiro
404Conta não encontrada
Ao criar uma conta BaaS, uma chave EVP (aleatória) é criada automaticamente. O cliente pode adicionar outras chaves (CPF, EMAIL, PHONE) posteriormente.
A chave EVP é ideal para receber PIX de forma anônima, pois não expõe dados pessoais do titular.
{
  "requestId": "5bbaf3ce-0e75-446d-8dea-43f805db8af4",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "123456789012",
    "ispb": "37839059",
    "agency": "0001",
    "holderName": "JOAO DA SILVA",
    "holderDocument": "12345678901",
    "keys": [
      {
        "key": "9d4c2c8e-1234-4294-b1a0-d41e8be92d6d",
        "type": "EVP",
        "name": "JOAO DA SILVA",
        "isCurrent": true,
        "createdAt": 1768253830000
      }
    ]
  }
}