Open Finance - Recepção de Dados

Introdução

Este documento resume o fluxo de utilização das APIs de consentimento e consumo de dados do Open Keys Data, conforme o padrão Open Finance Brasil. A API permite que iniciadores (TPPs) solicitem consentimento aos detentores de dados e, após aprovação, consultem dados cadastrais e transacionais através dos endpoints disponíveis.

Fluxo de Criação de Consentimento

O fluxo de consentimento segue a sequência abaixo:

sequenceDiagram
    participant TPP as Iniciador TPP
    participant API as API Open Keys
    participant Holder as Detentor

    TPP->>API: Pedido de consentimento
    API->>TPP: authorizationUrl + id
    TPP->>Holder: Redireciona para authorizationUrl
    Holder->>API: URL de autorização (redirecionamento)
    API->>Holder: Página de login
    Holder->>API: Login Detentor
    API->>TPP: url (consent) + interactionId
    Holder->>API: Aprovação detentor
    API->>TPP: url (callback com code, state, id_token)
    TPP->>API: Callback do consentimento
    API->>TPP: access_token

Etapas do fluxo

1. Pedido de consentimento (POST /data-reception/v1/consents) - Cria pedido com permissions, loggedUser, brandId e opcionalmente expirationDateTime. Retorna authorizationUrl e id.

2. URL de autorização - Redirecionamento para página de login do cliente (extrair interactionId da URL final).

3. Login Detentor - Autenticação com credenciais do holder.

4. Aprovação detentor - Confirmação do consentimento pelo usuário.

5. Callback do consentimento (POST /data-reception/v1/consents/callback) - Envio de code, state, id_token para obter access_token.

6. Uso do access_token - Bearer token para consumir as APIs de dados.

Fluxos auxiliares

• Cancelar consentimento - Uso do consent_interaction_id para revogar o consentimento.

Tipos de Dados Consultáveis

Após o consentimento, os dados podem ser consultados conforme os domínios disponíveis. Visão genérica por domínio:

Accounts

Contas depósito à vista, poupança e pagamento pré-pagas mantidas pelo cliente na instituição transmissora. Permite consultar lista de contas consentidas, detalhes de conta específica, saldos e transações.

Customers

Dados cadastrais de pessoas naturais e jurídicas. Inclui registros de identificação, qualificação e relacionamento da pessoa com a instituição financeira.

Resources

Recursos mantidos pelo cliente na instituição transmissora. Permite obter a lista de recursos consentidos pelo cliente.

Investments

Investimentos em diversas modalidades: renda fixa bancária, renda fixa de crédito, renda variável, títulos do tesouro e fundos. Inclui listas, detalhes, saldos, transações e notas de corretagem conforme o tipo de investimento.

Financings

Financiamentos e contratos associados. Permite consultar dados dos contratos, detalhes por contrato, cronograma de parcelas, histórico de pagamentos e garantias vinculadas.

Loans

Empréstimos e contratos associados. Permite consultar lista de contratos, detalhes, cronograma de parcelas, histórico de pagamentos e garantias.

Tabela de Domínios