Skip to main content

Progress - Documentação BAAS Owem

Status Atual: ✅ Documentação Completa

Última Atualização: Janeiro 2026


Resumo Geral

A documentação BAAS foi completamente desenvolvida com:
  • ✅ Página de produto detalhada (produtos/baas.mdx)
  • ✅ 4 endpoints documentados na API Reference
  • ✅ Autenticação corrigida para Basic Auth
  • ✅ Códigos BACEN documentados
  • ✅ Webhooks documentados
  • ✅ Fluxos e diagramas Mermaid

O Que Foi Feito

1. Correções de Compliance e Branding ✅

  • Removidas todas as referências ao CAF (parceiro externo)
  • Substituído por “sistema KYC interno da Owem” / “Owem KYC”
  • Atualizado diagrama de fluxo no index.mdx

2. Banner BETA Adicionado ✅

  • Alerta visual proeminente na página inicial
  • Deixa claro que BAAS está em fase beta
  • Informa que acesso é restrito a parceiros selecionados
  • Menciona processo de compliance e due diligence

3. Documentação das APIs BAAS ✅

POST /v4/i/baas/onboarding/new

  • Documentação completa do endpoint
  • Rate Limiting: 100 req/hora por API Key (código BAAS_RATE_LIMIT)
  • Códigos BACEN documentados (Circular nº 3.978/2020):
    • declaredIncome: DINP01-DINP05 (faixas de renda)
    • netWorth: NWNP01-NWNP05 (faixas de patrimônio)
    • occupation: ONP01-ONP31 (códigos de profissão)
  • Tabelas detalhadas com todos os códigos e descrições

GET /v4/i/baas/onboarding/:userId

  • Documentação do endpoint de consulta
  • Resposta inclui CPF mascarado (*.XXX.XXX-)
  • Campos proposalId e clientCode documentados
  • Objeto account e pixKey quando conta criada

POST /v4/i/baas/onboarding/:userId/documents/upload

  • Documentação do upload manual de documentos
  • Suporte a CNH_DIGITAL (PDF enviado como frente/verso)
  • Tipos de documento: RG, CNH, CNH_DIGITAL, RNE
  • Requisitos de arquivos (10MB max, formatos aceitos)

GET /v4/i/baas/accounts/:accountId

  • Documentação de consulta de conta
  • Dados bancários para TED (Banco 535 = Owem Pay)
  • Objetos: account, holder, pixKey, balance

4. Changelog Atualizado ✅

  • Nova entrada “Janeiro 2026 v5.0” para lançamento BAAS Beta
  • Lista de endpoints BAAS
  • Conformidade BACEN destacada
  • Warning sobre programa beta

Estrutura Final de Arquivos

mintlify-baas-docs/
├── index.mdx                         # ✅ Banner BETA + Fluxo sem CAF
├── changelog.mdx                     # ✅ Lançamento BAAS v5.0
├── api-reference/
│   └── baas/
│       ├── onboarding/
│       │   ├── criar-proposta.mdx    # ✅ Rate limit + Códigos BACEN
│       │   ├── consultar-status.mdx  # ✅ Sem CAF
│       │   └── upload-documentos.mdx # ✅ CNH_DIGITAL
│       └── accounts/
│           └── consultar-conta.mdx   # ✅ Banco 535 Owem Pay
└── docs.json                         # ✅ Navegação configurada

Próximos Passos Sugeridos

  1. Documentar Webhooks BAAS (baas:onboarding.*)
  2. Criar guia de integração passo-a-passo
  3. Adicionar exemplos em SDKs (Node.js, Python)
  4. Documentar erros específicos BAAS
  5. Criar página de FAQ BAAS

Observações Técnicas

Rate Limiting

  • 100 requisições por hora por API Key
  • Compartilhado entre múltiplos servidores do parceiro
  • Código de erro: BAAS_RATE_LIMIT (HTTP 429)

Códigos BACEN

  • Implementação da Circular nº 3.978/2020
  • Obrigatório a partir de 16/01/2026
  • Todos os códigos padronizados na documentação

Segurança

  • CPF retornado mascarado: ***.XXX.XXX-**
  • API Key com scope baas:onboarding obrigatória
  • Propostas isoladas por parceiro (não vê propostas de outros)