Skip to main content

Project Brief - Documentação BAAS Owem

Objetivo

Criar documentação focada no sistema BAAS (Banking as a Service) da Owem para parceiros B2B selecionados.

Público-Alvo

  • Parceiros B2B autorizados que criam contas bancárias para seus clientes
  • Acesso restrito (não público)
  • Desenvolvedores integrando via API

Escopo BAAS

O Que é BAAS Owem?

Permite que parceiros criem contas bancárias digitais para seus clientes finais através de API, incluindo:
  1. Onboarding: Criar proposta de abertura de conta
  2. KYC: Widget CAF para verificação de identidade
  3. Conta: Criação automática após aprovação
  4. Webhooks: Notificações de status

Endpoints BAAS

EndpointMétodoDescrição
/v4/i/baas/onboarding/newPOSTCriar proposta
/v4/i/baas/onboarding/:userIdGETConsultar status
/v4/i/baas/onboarding/:userId/docsPOSTUpload manual de documentos
/v4/i/baas/accounts/:accountIdGETConsultar conta

Webhooks BAAS

EventoDescrição
baas:onboarding.proposal.updatedStatus do KYC mudou
baas:onboarding.account.createdConta criada com sucesso

Base URL

  • Produção: https://api.owem.com.br

Autenticação BAAS

  • Método: API Key Header
  • Formato: X-API-Key: ak_baas_xxx...
  • Scope: baas:onboarding

Fluxo Principal

1. Parceiro → POST /onboarding/new { cpf, name, email, ... }
2. Owem → Retorna { userId, kycUrl }
3. Cliente → Acessa kycUrl (Widget CAF)
4. CAF → Processa KYC
5. Owem → Webhook para parceiro
6. Se aprovado → Conta criada automaticamente
7. Parceiro → GET /accounts/:id para dados da conta

Estrutura da Documentação

📁 BAAS Docs
├── Introdução (O que é BAAS)
├── Quickstart (Criar primeira conta)
├── Conceitos
│   ├── Autenticação
│   ├── Fluxo de Onboarding
│   └── Códigos de Erro
├── Guias
│   ├── Criar Conta
│   └── Webhooks
├── API Reference
│   ├── Onboarding (3 endpoints)
│   ├── Accounts (2 endpoints)
│   └── Webhooks (eventos)
└── AI Tools

Diferenças: BAAS vs Documentação Pública

AspectoDocs Público (docs.owem.com.br)BAAS Docs (restrito)
AcessoPúblicoParceiros autorizados
FocoPIX IN/OUT, Ledger, WebhooksOnboarding, Accounts
AutenticaçãoBasic AuthAPI Key com scope
Quem usaClientes diretosParceiros B2B

Idioma

  • PT-BR (único, sem bilíngue por enquanto)

Commit Pattern

<type>(<scope>): <short description>