Pular para o conteúdo
Última atualização

Incomes

🚧 Solicite transações primeiro

Antes de solicitar incomes, você deve primeiro fazer uma solicitação POST Retrieve Transactions.

Se você não solicitar as transações, as análises não poderão ser realizadas.

Nota: Recomendamos que você faça a solicitação POST Retrieve Transactions logo antes de fazer sua solicitação de incomes para garantir que todos os dados sejam devidamente calculados.

Nosso recurso Incomes fornece informações sobre as fontes de renda de um link bancário.

Use o recurso Incomes para obter insights sobre as fontes de renda de uma conta nos últimos 365 dias. O endpoint é particularmente útil quando você deseja verificar a renda de uma pessoa.

📘 O recurso Incomes está disponível apenas para contas Corrente e Poupança associadas a links bancários.

Use este recurso para obter informações sobre um link bancário:

  • fonte de renda e confiança
  • pontuações de estabilidade e regularidade
  • lista de transações usadas para determinar a fonte de renda

Oferecemos os seguintes métodos para interagir com Incomes:

EndpointsMétodoDescrição
RetrievePOSTRecupere insights de renda de um link específico. O período é de até 365 dias e depende do histórico de transações disponível para cada banco.
ListarGETListe as rendas associadas à sua conta Belvo.
DetalharGETObtenha os detalhes de uma renda específica.
ExcluirDELETEExclua uma renda específica da sua conta Belvo.

Obtendo dados de renda melhores

Para que a verificação de renda retorne dados precisos, seu usuário precisa conectar a conta na qual recebe seu salário. Se eles vincularem uma conta que não inclua suas transações salariais, nossa API retornará um array vazio.

💡 Para evitar receber um array vazio, certifique-se de indicar ao seu usuário que ele deve conectar a conta que recebe seu salário.

Além disso, recomendamos implementar um mecanismo onde, se seu usuário conectar uma conta que não contenha transações salariais, você o notifique de que a conta conectada não continha informações salariais e peça para conectar outra conta.

Despesas recorrentes

🚧 Solicite contas e transações primeiro

Antes de solicitar despesas recorrentes, você deve primeiro fazer uma solicitação POST Retrieve Transactions.

Se você não solicitar transações, as análises não poderão ser realizadas.

Nota: Recomendamos que você faça a solicitação POST Retrieve Transactions logo antes de fazer sua solicitação de despesas recorrentes para garantir que todos os dados sejam devidamente calculados.

O recurso de Despesas Recorrentes da Belvo permite identificar pagamentos regulares de um usuário para serviços de assinatura, como Netflix ou academias, bem como pagamentos de serviços públicos, como contas de eletricidade ou telefone. Esta informação é extremamente útil quando você deseja ajudar os usuários a gerenciar suas obrigações futuras.

📘 O recurso de despesas recorrentes está disponível apenas para contas Corrente e Poupança associadas a links bancários. Retornamos informações de até 365 dias.

Se nenhuma despesa recorrente puder ser identificada, retornamos um array vazio.

Para cada transação recorrente, retornamos os dados enriquecidos (tipo de transação, categoria, valores médios) bem como informações de conta e transação de suporte. Confira nossa referência da API de despesas recorrentes para informações detalhadas sobre cada ponto de dados que retornamos.

[
  {
    "id": "076c66e5-90f5-4e01-99c7-50e32f65ae42",
    "account": {}, // Informações sobre a conta em que encontramos a transação recorrente
    "name": "Netflix",
    "transactions": [ // Array de transações que identificamos como sendo cíclicas
      {
        "amount": 32.9,
        "description": "Netflix.com/march",
        "value_date": "2019-10-23"
      },
      {
        "amount": 32.9,
        "description": "Netflix.com/april",
        "value_date": "2019-10-23"
      },
      {
        "amount": 32.9,
        "description": "Netflix.com/may",
        "value_date": "2019-10-23"
      }
    ],
    "frequency": "MONTHLY", // Com que frequência a transação ocorre
    "average_transaction_amount": 32.9, // Valor médio da transação
    "median_transaction_amount": 32.9,
    "days_since_last_transaction": 5, // Ajuda a identificar quanto tempo até a próxima transação
    "category": "Online Platforms & Leisure", // Categoria da transação
    "payment_type": "SUBSCRIPTION" // Categoria do método de pagamento
  }
]
EndpointsMétodoDescrição
RetrievePOSTRecuperar insights de despesas recorrentes de um link específico. O período é de até 365 dias e depende do histórico de transações disponível para cada banco.
ListGETListar a despesa recorrente associada à sua conta Belvo.
DetailGETObter os detalhes de uma despesa recorrente.
DestroyDELETEExcluir uma despesa recorrente específica da sua conta Belvo.

Risk insights

🚧 Solicite contas e transações primeiro

Antes de solicitar insights de risco, você deve primeiro fazer uma solicitação POST Retrieve Accounts e uma POST Retrieve Transactions.

Se você não solicitar as contas e transações, as análises não poderão ser realizadas.

Nota: Recomendamos que você faça as solicitações POST Retrieve Accounts e POST Retrieve Transactions logo antes de fazer sua solicitação de insights de risco para garantir que todos os dados sejam devidamente calculados.

Construir um modelo de crédito exige uma análise meticulosa de dados, cálculo de variáveis e limpeza de dados. O recurso de Risk Insights da Belvo oferece uma lista abrangente de características pré-calculadas, fornecendo às equipes de ciência de dados blocos de construção para criar, iterar e validar rapidamente seus modelos.

📘 Para calcular os insights de risco, consideramos até 365 dias de dados transacionais das contas correntes, poupança, investimento, empréstimo e cartão de crédito do usuário.

EndpointsMétodoDescrição
RetrievePOSTRecuperar insights de risco para um link específico. O período é de até 90 dias e depende do histórico de transações disponível para cada banco.
ListGETListar todas as análises de insights de risco associadas à sua conta Belvo.
DetailGETObter os detalhes de uma análise de insights de risco.
DestroyDELETEExcluir uma análise de insights de risco específica da sua conta Belvo.