Recepção de Dados

Pré requisitos para implementação:

Possuir uma chave api da Celcoin, para mais informações acessar esse link

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 BaaS Celcoin
    participant Holder as Detentor de Contas

    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 de retorno (callback com code, state, id_token)
    TPP->>API: Token de Acesso para o Consentimento do Open Finance Brasil
    API->>TPP: access_token
    TPP->>API: GET /resources + access_token (buscar dados da detentora)
    API->>Holder: Validação do token e busca dos dados
    Holder->>API: Dados da detentora
    API->>TPP: Dados da detentora

Etapas do fluxo

1. Pedido de consentimento (POST /baas/v1/open/dat/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. Coleta do token do consentimento para realizar o consumo do dado (POST /baas/v1/open/dat/consents), este token deve ser utilizado nas chamadas subsequentes para consumir os endpoints de dados

Fluxos auxiliares

• Cancelar consentimento - Uso do consent_interaction_id para revogar o consentimento (DELETE /baas/v1/open/dat/consents/{consent_id})

Consentimento do compartilhamento de dados

Mais detalhes de como funciona o Consentimento para Compartilhamento de Dados, assim como a sua máquina de estados e escopos necessários por tipo de dado a ser consultado, pode ser encontrado em Como funciona consentimento e consumo de dados.

Tipos de Dados Consultáveis

Após o consentimento, os dados podem ser consultados conforme os domínios disponíveis.

Abaixo segue uma visão das informações que podem ser coletadas por domínio, assim como um link para as páginas contendo os detalhes dos dados exatos retornados para cada cenário:

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.

Registration Data - Natural Person

Registration Data - Legal Entity

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.

Mais detalhes

Credit Cards

Dados de cartões de crédito, saldos, faturas e transações.

Credit Cards

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.

Investments - Bank Fixed Incomes

Investments - Credit Fixed Incomes

Investments - Variable Incomes

Investments - Treasure Titles

Investments - Funds

Credit Operations

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

Credit Operations - Loans

Credit Operations - Financings

Resources

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

Este escopo é obrigatório para todos os consentimentos de dados criados.

GET /baas/v1/open/dat/resources

Requisições das APIs do fluxo de Compartilhamento de Dados

Mais detalhes sobre a criação e consumo de cada um dos tipos de dados retornados pela plataforma pode ser encontrado nos links abaixo.

Pré requisitos para implementação:

Possuir uma chave api da Celcoin, para mais informações acessar esse link