Skip to main content
POST
/
v4
/
i
/
baas
/
accounts
/
{accountId}
/
pix-keys
curl -X POST https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -H "Content-Type: application/json" \
  -d '{"pixKeyType": "EVP"}'
{
  "requestId": "b579b11d-a604-4a46-ad71-820015d42940",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "379925652244",
    "pixKey": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "pixKeyType": "EVP",
    "pixKeyName": "João da Silva",
    "pixKeyCpfCnpj": "12345678901",
    "isCurrent": true,
    "createdAt": 1768919801000,
    "holderId": "usr_551862c8"
  }
}
curl -X POST https://api.owem.com.br/v4/i/baas/accounts/123456789012/pix-keys \
  -H "Authorization: Basic $(echo -n 'SUA_API_KEY:SEU_SECRET' | base64)" \
  -H "Content-Type: application/json" \
  -d '{"pixKeyType": "EVP"}'

Descrição

Cria uma nova chave PIX para uma conta bancária BaaS. Suporta todos os tipos de chave PIX: EVP (aleatória), CPF, CNPJ, EMAIL e PHONE.
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
AuthorizationstringBasic Auth (API Key + Secret em Base64)
Content-Typestringapplication/json

Path Parameters

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

Body Parameters

ParâmetroTipoObrigatórioDescrição
pixKeyTypestringTipo da chave: EVP, CPF, CNPJ, EMAIL, PHONE
pixKeystringCondicionalValor da chave (não enviar para EVP)

Tipos de Chave PIX

EVP (Chave Aleatória)

{
  "pixKeyType": "EVP"
}
Para chaves EVP, não envie o campo pixKey. O sistema gera automaticamente um UUID.

CPF

{
  "pixKeyType": "CPF",
  "pixKey": "12345678901"
}

CNPJ

{
  "pixKeyType": "CNPJ",
  "pixKey": "12345678000199"
}
Regras para CPF/CNPJ:
  • O documento informado deve ser idêntico ao ownerDocument da conta bancária
  • Não pode estar cadastrado em nenhuma instituição financeira
  • Se já estiver vinculado a outra conta, delete-o primeiro ou solicite portabilidade

EMAIL

{
  "pixKeyType": "EMAIL",
  "pixKey": "contato@empresa.com"
}
ValidaçãoRegra
FormatoEmail válido (RFC 5321)
TamanhoMáximo 77 caracteres
CaracteresSem caracteres especiais

PHONE

{
  "pixKeyType": "PHONE",
  "pixKey": "+5511999998888"
}
ValidaçãoRegra
FormatoDeve iniciar com +55
DDD2 dígitos (11-99)
Número8 ou 9 dígitos

Limites e Restrições

Limite PF

Máximo 5 chaves por conta Pessoa Física

Limite PJ

Máximo 20 chaves por conta Pessoa Jurídica

Cooldown

Aguarde 10 minutos entre criações de chaves

Primeira Chave

A primeira chave criada é automaticamente definida como corrente

Response

Sucesso (201 Created)

{
  "requestId": "b579b11d-a604-4a46-ad71-820015d42940",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "379925652244",
    "pixKey": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "pixKeyType": "EVP",
    "pixKeyName": "João da Silva",
    "pixKeyCpfCnpj": "12345678901",
    "isCurrent": false,
    "createdAt": 1768919801000,
    "holderId": "usr_551862c8"
  }
}

Campos da Response

CampoTipoDescrição
accountIdstringID da conta
pixKeystringValor da chave PIX (usar em set-current e delete)
pixKeyTypestringTipo da chave: EVP, CPF, CNPJ, EMAIL, PHONE
pixKeyNamestringNome do titular
pixKeyCpfCnpjstringCPF/CNPJ do titular
isCurrentbooleanSe é a chave principal da conta
createdAtnumberTimestamp de criação (ms)
holderIdstringID do parceiro BaaS
Use o valor de pixKey para chamar os endpoints de definir chave corrente e deletar chave.

Erros

CódigoHTTPDescrição
BAAS_PIX_KEY_COOLDOWN429Aguarde 10 minutos entre criações
BAAS_PIX_KEY_LIMIT_EXCEEDED400Limite de chaves excedido (5 PF / 20 PJ)
BAAS_PIX_KEY_INVALID_FORMAT400Formato da chave inválido
BAAS_PIX_KEY_EVP_NO_KEY400EVP não deve enviar pixKey
BAAS_PIX_KEY_DOC_MISMATCH400CPF/CNPJ diferente do documento da conta
BAAS_PIX_KEY_ALREADY_EXISTS409Chave já cadastrada no sistema
BAAS_PIX_KEY_OTHER_PARTICIPANT409Chave cadastrada em outra instituição (requer portabilidade)
BAAS_PIX_KEY_OTHER_OWNER409Chave pertence a outra pessoa (outro CPF/CNPJ)
BAAS_ACCOUNT_NOT_FOUND404Conta não encontrada
BAAS_ACCOUNT_WRONG_PARTNER403Conta não pertence ao parceiro
{
  "requestId": "b579b11d-a604-4a46-ad71-820015d42940",
  "success": true,
  "size": 1,
  "data": {
    "accountId": "379925652244",
    "pixKey": "75be0efc-51b0-47e1-803d-5162f06b755c",
    "pixKeyType": "EVP",
    "pixKeyName": "João da Silva",
    "pixKeyCpfCnpj": "12345678901",
    "isCurrent": true,
    "createdAt": 1768919801000,
    "holderId": "usr_551862c8"
  }
}