Quickstart
🎸 Introdução
Open Finance é a nova revolução do sistema financeiro do Brasil. A democratização de big data e interoperabilidade de dados financeiros permite um sistema financeiro mais competitivo e mais justo para os usuários. Em poucos passos você pode começar a aproveitar os benefícios da nossa API para modelagem de crédito, KYC (Know Your Customer) e soluções antifraude.
Esse quickstart serve como um resumo de como a API funciona e é a maneira mais rápida para integrar com a nossa plataforma.
🪄 Dica Se ainda houver dúvidas, entre em contato por crie@klavi.ai
📖 A ferramenta
- Chaves da API
- Partner Code: identificador único por parceiro para iniciar o Link (página de conexão bancária) com a nossa API. Existem 3 códigos (sandbox, ambiente de teste e ambiente de produção)
- Partner Token: utilizado na funcionalidade de atualização automática. O token é mais uma medida de segurança, junto com o Code.
🪄 Dica Estas informações também estarão disponíveis no dashboard.
- Ambientes da API
- Sandbox: pode ser testado com dados bancários de testes providenciados por nós. Este modo é self-service.
- Homologação: ambiente de testes que funciona com dados bancários reais. Este modo requer credenciais para testar.
- Produção: ambiente de produção. Este modo requer credenciais para usar.
🪄 Dica Credenciais de teste podem ser encontradas no dashboard quando usando o Sandbox.
- Link
- Link são as páginas de conexão bancária onde o usuário faz login da conta
- É a maneira mais fácil e segura de integrar com nossa API
- As informações sensíveis são transmitidas por HTTPS
- As páginas são modulares em HTML que trabalham com autenticação de vários fatores (MFA, multi-factor authentication), senhas de uso único (OTP, one time password) e gerenciamento de erros.
- Totalmente customizável de acordo com suas necessidades
🪄 Dica Mais informações na parte de Segurança.
📚 O produto
Negócio | Produto | Descrição de cada |
Contas pessoais | Category_checking | Transações de conta corrente dos últimos 3 a 6 meses incluindo data, valores, descrição, saldo após transação e categoria da transação. |
| Category_creditcard | Transações de cartão de crédito dos últimos 3 a 6 meses incluindo data, valores, descrição e categoria da transação Dados de limite de crédito incluso. |
| Income | Salário e outros rendimentos. |
| Liabilities | Dívidas de cartão de crédito e outros históricos devedores. |
| Financial_insight | Relatório consolidado com resumo financeiro que inclui média de entradas, saídas, salário, faturas do cartão de crédito, limite de cheque especial, empréstimo pré-aprovado, pagamentos atrasados, IPVA, IPTU e mais. |
| Score_k1 | Com base em dados de transações bancárias, essa pontuação de crédito prevê a possibilidade de inadimplência no pagamento com cartão de crédito. Pode ser usado como pontuação de referência para avaliação de risco. |
Investimentos | Investment | Dados de investimento incluindo detalhes de conta, produtos e portfólio. |
Contas de empresas | Corporate_checking | Dados de contas empresas incluindo saldo, balanços mensais e transações. |
Gig economy | Gig_economy | Transações na conta de até 6 meses incluindo dados de conta, data de transação, descrição, valor e saldo. |
KYC | Identity | Dados cadastrais da conta e validação de quem é dono da conta. |
KYC | Balance | Consulta em tempo real de saldo disponível. |
KYC | Auth_account | Validação de quem é dono da conta conectada. Não requer micro depósito. |
KYC | Auth_creditcard | Validação de quem é dono do cartão de crédito. Não requer micro depósito. |
📱 Interação com o usuário

- O usuário inicia a jornada no seu app ou site;
- Em algum momento ele é direcionado ao Link onde a conexão bancária é feita. Trabalhamos com autenticação de vários fatores (MFA, multi-factor authentication) e senhas de uso único (OTP, one time password) para validação;
- A conexão bancária leva poucos segundos e o usuário é redirecionado a sua página usando a URL de callback.
🪄 Dica O Link pode ser inserido no seu fluxo usando um iFrame para otimizar a experiência do usuário
📈 Recebimento de dados
- Os dados são enviados no formato JSON.
- Webhook (URL dedicada para receber os dados) é o método mais utilizado e recomendado.
- Compilamos e enviamos os dados bancários para seu webhook em formato JSON assim que a conexão terminar.
🪄 Dica Recomendamos criar um whitelist de IPs para seu webhook.
⌨️ Como integrar
- Integração do Link
- Nosso Link suporta integrações de HTML, webview ou iFrame. Você pode escolher qualquer um dos métodos que melhor se adapte ao seu negócio.
- Você pode encontrar mais detalhes dentro do dashboard como o Partner Code e começar a integrar com o URL do Link. Segue abaixo parâmetros opcionais para o URL:
Parâmetro | Propósito | Notas |
uuid (obrigatório) | Identificador único de usuários na plataforma do parceiro | O dado será incluso no arquivo JSON para identificar o usuário no sistema do parceiro, se providenciado. |
cpf (opcional) | - Identifica o usuário - Necessário durante a conexão bancária | Se não providenciado, o usuário deve informar na hora da conexão bancária. |
bank_id (opcional) | Restringir a seleção de banco para conectar | Se o bank_id (código bancário) for providenciado, o usuário não pode conectar contas de outros bancos. Essa é a lista de códigos bancários de acordo com o Banco Central: - Banco do Brasil: 001 - Bradesco: 237 - Caixa: 104 - Itaú: 341 - Santander: 033 |
callback_url (obrigatório,exceto para integração iFrame) | URL para redirecionamento do usuário quando ele sair do Link | A URL de callback precisa seguir as regras de “encodeURIcompenent()” como abaixo: - “%3a” no lugar de “:” - “%2f” no lugar de “/” - “%3f” no lugar de “?” - “%3d” no lugar de “=” |
cancel_url (obrigatório,exceto para integração iFrame) | URL para redirecionamento quando o usuário cancelar a conexão | A URL de cancelar precisa seguir as regras de “encodeURIcompenent()” como abaixo: - “%3a” no lugar de “:” - “%2f” no lugar de “/” - “%3f” no lugar de “?” - “%3d” no lugar de “=” |
- Exemplo de URL do Link com parâmetros opcionais e redirecionamento para uma webpage. O URL de callback após decodificação: https://partnerDomain.com?partnerParameter=value
- Exemplo de URL do Link com parâmetros opcionais e redirecionamento para um app. O URL de callback após decodificação: partnerAppSchemeDemo://partnerAppPage?partnerParameter=value
- URLs do Link em outros ambientes::
- https://openbanking-sandbox.klavi.ai (Sandbox)
- https://openbanking-dev.klavi.ai (Homologação)
- (Produção, consultar com a Klavi)
🪄 Dica Para obter mais detalhes técnicos do elemento iFrame/windows.postMessage(), consulte o seguinte link:
- Acompanhamento de eventos
- A Klavi oferece suporte ao rastreamento de eventos das páginas de links, se necessário.
- A seguir temos um exemplo de mensagens de rastreamento de eventos para integração iFrame por meio de windows.postMessage(). Esses eventos e mensagens são personalizáveis.
Evento | Mensagem |
Abra a página da lista de instituições | { code:200, msg:”OK”, page:”institution_login” } |
Clique no botão de termos do usuário | { code:200, msg:”OK”, page:’institution_terms’ } |
Clique no botão da política de privacidade | { code:200, msg:”OK”, page:”institution_policy” } |
Clique no botão continuar após inserir a credencial | { code:200, msg:”OK”, page:”institution_loading” } |
A página MFA (pop-up) aparece | { code:200, msg:”OK”, page:”institution_MFA” } |
Clique no botão confirmar na página MFA (pop-up) | { code:200, msg:”OK”, page:”sync_starting” } |
Clique no botão cancelar na página MFA (pop-up) | { code:402, msg:’User credential error’, page:’sync_canceled’ } |
- Integração de API
- Fale conosco e nos informe qual produto deseja consumir;
- Siga o formato do JSON na parte de Produtos;
- Você deve providenciar o endereço de Webhook e daremos sequência na integração;
- Faça sua primeira conexão usando o URL do Link e receba os dados no webhook automaticamente.
🪄 Dica Simples e fácil. Clique aqui para iniciar sua jornada.
📊 Console
Uma vez em produção você pode ver as estatísticas de conexão, conexões em tempo real e faturas pelo nosso console.

🪄 Dica Nos envie seu logo para crie@klavi.ai para customizar sua página.