Documentação da API Belvo (1.221.0)

Introdução

Alcance novos públicos e converta mais usuários conectando-se fácil e seguramente aos dados financeiros deles, entendendo seu comportamento e possibilitando pagamentos instantâneos com open finance. Através da nossa API, você pode acessar:

Informações Disponíveis e Métodos de Pagamento

A Belvo é uma API de open banking para a América Latina que permite que empresas acessem informações bancárias e fiscais de maneira segura e ágil.

Através da nossa API, você pode acessar:

  • Informações Bancárias no Brasil
  • Informações de Emprego no Brasil
  • Informações de Emprego no México
  • Informações Fiscais no México
  • Informações Fiscais no Chile

Você também pode usar nossa API para realizar pagamentos em:

  • Brasil
  • México

Dicionários de Dados

Se você deseja a documentação de resposta em formato Excel ou CSV, por favor, faça o download a partir do nosso Repositório Público no GitHub: Belvo Open Finance Data Dictionaries.

Nossos arquivos EXCEL e CSV estão adicionalmente localizados em Espanhol e Português (Brasil).

Ambientes

Atualmente, oferecemos dois ambientes: sandbox e produção.

Sandbox

Disponível para:

  • 🟢 Agregação e Enriquecimento
  • ⚪️ Iniciação de Pagamento

Use nosso ambiente Sandbox para construir sua integração. Oferecemos dados fictícios que imitam casos de uso do mundo real, o que significa que você pode testar todos os endpoints, usar o widget e implementar webhooks - exatamente como faria com dados reais!

Tudo o que você precisa para começar com o ambiente Sandbox é obter suas chaves de API. Recomendamos fortemente que você comece a criar sua integração neste ambiente.

Produção

Disponível para:

  • 🟢 Agregação e Enriquecimento
  • 🟢 Iniciação de Pagamento

Depois de testar sua integração no ambiente Sandbox e estar pronto para entrar em operação, você precisará solicitar acesso ao nosso ambiente de Produção. Após solicitar o acesso, nossa equipe de Vendas entrará em contato para agendar uma reunião apenas para garantir que suas necessidades sejam atendidas, e então você precisará passar por um processo de certificação com um de nossos engenheiros para garantir que sua integração esteja funcionando de forma otimizada. Para se preparar para a reunião de certificação, basta seguir nossa lista de verificação de Integração.

Uma vez que sua integração esteja certificada, tudo o que você precisará fazer é:

  • Solicitar chaves de API de Produção (e alterar suas chaves de API do Sandbox no código para estas novas).
  • Alterar a URL base para a qual você faz solicitações de sandbox.belvo.com para api.belvo.com.
  • Se você estiver usando webhooks, certifique-se de definir uma URL de Produção para seus webhooks.

Códigos de Resposta

Usamos o seguinte código de status HTTP na resposta, dependendo do sucesso ou falha:

Código de StatusDescrição
200Sucesso - O conteúdo está disponível no corpo da resposta.
201Sucesso - O conteúdo foi criado com sucesso na Belvo.
204Sucesso - Nenhum conteúdo para retornar.
400Erro de Solicitação Inválida - A solicitação retornou um erro, detalhe no conteúdo.
401Não Autorizado - As credenciais da Belvo fornecidas não são válidas.
404Não Encontrado - O recurso que você tentou acessar não pode ser encontrado.
405Método Não Permitido - O método HTTP que você está usando não é aceito para este recurso.
408Tempo de Solicitação Esgotado - A solicitação expirou e foi encerrada pelo servidor.
428Token MFA Necessário - O token MFA foi exigido pela instituição para conectar.
500Erro Interno do Servidor - O detalhe do erro está disponível no corpo da resposta.

Tratamento de Erros

Os erros da API Belvo são retornados em formato JSON. Por exemplo, um erro pode ser assim:

[
    {
      "request_id": "a6e1c493d7a29d91aed4338e6fcf077d",
      "message": "Este campo é obrigatório.",
      "code": "required",
      "field": "link"
    }
]

Normalmente, uma resposta de erro terá os seguintes parâmetros:

  • request_id: um ID único para a solicitação, você deve compartilhá-lo com a equipe de suporte da Belvo para investigações.
  • message: descrição legível do erro.
  • code: um código único para o erro. Verifique a tabela abaixo para ver como lidar com cada código de erro.
  • field (opcional): O campo específico no corpo da solicitação que tem um problema.

Identificador de Solicitação

Quando você precisar de ajuda com um erro específico, inclua o identificador de solicitação (request_id) em sua mensagem para a equipe de suporte da Belvo. Isso acelerará as investigações e fará com que você volte a funcionar rapidamente.

Códigos de Erro e Solução de Problemas

Para uma lista completa de erros e como solucioná-los, consulte nosso artigo dedicado Tratamento de Erros.

Política de Repetição

Erros 50x

Implemente uma repetição automática exponencial de até cinco tentativas. Recomendamos usar um intervalo base de três segundos com um fator de dois. Por exemplo, a primeira repetição deve ser após três segundos, a segunda repetição após seis segundos (2 * 3), a terceira repetição após 12 segundos (2 * 6), a quarta repetição após 24 segundos (2 * 12) e a quinta repetição após 48 segundos (2 * 24).

Erros 40x

Você não deve tentar novamente fazer solicitações se receber uma resposta 40x, pois isso é um erro do cliente.

A única exceção é o erro "Muitas Sessões", pois isso significa que seu usuário final está acessando a conta de outro navegador ao mesmo tempo. Nesse caso, implemente a mesma política de repetição que para erros 50x.

Campos Obsoletos

Em nosso esquema, você pode ver que um campo foi marcado como deprecated. Isso significa que este campo não é mais mantido pela equipe da Belvo. Você ainda pode receber dados para este campo dependendo da instituição, no entanto, você não deve confiar neste campo.

OpenAPI: campos obrigatórios e anuláveis

Em nossa especificação de API, você verá que alguns parâmetros de resposta terão uma anotação required. De acordo com a especificação OpenAPI, quando um parâmetro de resposta é marcado como required, isso significa que a chave de resposta deve ser retornada. No entanto, o valor desse parâmetro de resposta pode ser null.

📘 Informação

Em resumo, qualquer parâmetro de resposta marcado como obrigatório será retornado pela nossa API, mas o valor pode ser definido como nulo.

Baixar o arquivo de descrição OpenAPI
Idiomas
Servidores
Mock server

https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/

Ambiente de Testes

https://sandbox.belvo.com/

Institutions

Uma instituição é uma entidade da qual a Belvo pode acessar informações. Pode ser uma:

  • instituição bancária, como o Nubank Brasil.
  • instituição fiscal, como o Servicio de Administración Tributaria (SAT) no México.
  • instituição de emprego, como o Instituto Mexicano del Seguro Social (IMSS) no México ou o Instituto Nacional do Seguro Social (INSS) no Brasil.
Operações

Widget Access Token

Operações

Consents

Um consentimento é uma permissão dada pelo usuário final para acessar seus dados financeiros na Rede de Open Finance no Brasil.

Operações

Owners

Um proprietário representa a pessoa que tem acesso a um Link e é o proprietário de todas as contas dentro do Link.

Você pode usar este endpoint para obter informações úteis sobre seu cliente, como:

  • seu nome completo
  • informações de contato principais
  • informações sobre o documento de identidade que usaram ao abrir a conta
Operações

Accounts

Uma conta é a representação de uma conta bancária dentro de uma instituição financeira. Um usuário pode ter uma ou mais contas em uma instituição.

Por exemplo, um usuário (ou link) pode ter uma conta corrente, vários cartões de crédito e uma conta de empréstimo.

Consultar as informações da conta de um usuário é útil, pois você pode obter informações sobre:

  • quais tipos de contas o usuário possui.
  • o saldo de cada conta (poupança, corrente, cartão de crédito, empréstimo, etc.).
  • informações detalhadas sobre os gastos com cartão de crédito.
  • a situação atual de quaisquer empréstimos que possam ter.
Operações

Balances

Um saldo é a quantidade de dinheiro disponível em uma determinada conta bancária (corrente ou poupança) em um determinado momento.

Operações

Transactions

Uma transação contém as informações detalhadas de cada movimento dentro de uma conta. Por exemplo, uma compra em uma loja ou em um restaurante.

Operações

Bills

Uma bill refere-se à fatura do cartão de crédito que um usuário recebe para uma determinada conta.

Operações

Investments Brazil

Operações

Investment Transactions Brazil

Operações

Employments Brazil

Nosso recurso de empregos para o Brasil permite que você obtenha uma visão abrangente do histórico de emprego atual e das informações salariais do seu usuário.

Para cada usuário, nós retornamos:

  • histórico de trabalho (incluindo ocupações e dados do empregador)
  • informações salariais históricas e atuais (por empregador)

No momento, o recurso de empregos está disponível para:

  • 🇧🇷 Brasil (INSS)
Operações

Employment Records Mexico

Nosso recurso de registros de emprego para o México permite que você obtenha uma visão abrangente das contribuições atuais para a seguridade social e do histórico de emprego do seu usuário.

Com o recurso de registros de emprego da Belvo para o México, você pode acessar informações sobre as contribuições atuais para a seguridade social e o histórico de emprego do seu usuário. Para cada usuário, retornamos:

  • dados pessoais
  • histórico de trabalho
  • salário base diário histórico e atual
  • e mais!

No momento, o recurso de registros de emprego está disponível para:

  • 🇲🇽 México (IMSS)
  • 🇲🇽 México (ISSSTE)
Operações

Invoices

Operações

Tax compliance status

Operações

Tax returns

Operações

Tax retentions

Operações

Tax status

Operações

Financial Statements

Operações

Invoices Chile

Operações

Tax Status Chile

Operações

Debt Reports Chile

Operações

Incomes

Use o endpoint 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.

📘 Info

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

Operações

Recurring Expenses

A API de Despesas Recorrentes da Belvo permite que você identifique os pagamentos regulares de um usuário para serviços de assinatura, como Netflix ou assinaturas de academia, bem como pagamentos de serviços públicos, como contas de eletricidade ou telefone. Nós retornamos informações de até 365 dias.

📘 Informação

O recurso de despesas recorrentes está disponível apenas para contas Corrente, Poupança e de Cartão de Crédito associadas a links bancários.

Operações

Risk Insights

Operações

Employment Metrics

Operações

Objeto de Métricas de Emprego

Detalhes das Métricas de Emprego

idstring(uuid)obrigatório

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)obrigatório

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
created_atstring(date-time)obrigatório

O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.

Exemplo: "2022-02-09T08:45:50.406032Z"
updated_atstring or null(date-time)obrigatório

O carimbo de data/hora ISO-8601 de quando o cálculo das métricas de emprego foi atualizado pela última vez.

Exemplo: "2023-08-30T15:31:35.728607Z"
reference_datestring or null(date)obrigatório

A reference_date que você forneceu em sua solicitação. Se você não forneceu uma, este campo retornará null, indicando que os cálculos são realizados até a data da solicitação.

Nota: Todos os cálculos são relativos a esta data.

Exemplo: "2023-06-01"
ageinteger(int32)obrigatório

A idade do indivíduo.

Exemplo: 32
current_statusstringobrigatório

Indica o status de emprego do indivíduo. Retornamos uma das seguintes respostas:

  • EMPLOYED
  • RETIRED
  • UNEMPLOYED
  • null
Enum"EMPLOYED""RETIRED""UNEMPLOYED""null"
Exemplo: "EMPLOYED"
current_employer_countinteger or null(int32)obrigatório

O número de empregadores que o indivíduo tem no momento.

Exemplo: 1
base_salary_lastnumber or null(float)obrigatório

O salário base mais recente do usuário. Se current_status for EMPLOYED, este é o salário base atual do usuário.

Exemplo: 42.17
weeks_employed_last_jobnumber or null(float)obrigatório

O número de semanas em que o usuário esteve empregado em seu último emprego. Se current_status for EMPLOYED, então este campo indica o número de semanas em que o usuário está empregado em seu emprego atual.

Exemplo: 327.1429
weeks_since_last_jobnumber or null(float)obrigatório

O número de semanas desde o último emprego. Se o valor deste campo for 0, isso indica que o usuário está atualmente empregado.

Exemplo: 0
weeks_employed_totalnumber or null(float)obrigatório

O número total de semanas em que o usuário esteve empregado, de acordo com a instituição.

Nota:

No caso de o usuário estar empregado em dois ou mais lugares ao mesmo tempo, ainda calculamos essas semanas como uma semana. Por exemplo, se um usuário tem três empregos simultâneos por um mês, isso é calculado como 4 semanas.

Exemplo: 148.2
weeks_with_multiple_employersnumber or null(float)obrigatório

O número de semanas em que o indivíduo teve mais de um empregador ao mesmo tempo.

Exemplo: 0
employer_countinteger or null(int32)obrigatório

O número total de empregadores que o usuário teve. Útil para indicar a estabilidade de emprego ao longo de sua vida.

Exemplo: 14
unique_employer_countinteger or null(int32)obrigatório

O número de empregadores únicos que o indivíduo teve.

Nota:

Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.

Exemplo: 3
employers_per_yearnumber or null(float)obrigatório

Número de empregadores por ano. Útil para indicar a estabilidade no emprego ao longo de um ano.

Nota:

Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.

Exemplo: 0.6326
weeks_between_jobsnumber or null(float)obrigatório

O número total de semanas em que o indivíduo esteve desempregado.

Exemplo: 687.2865
max_weeks_between_jobsnumber or null(float)obrigatório

O número máximo de semanas em que o indivíduo esteve desempregado.

Exemplo: 249.8571
increases_last_jobinteger or null(int32)obrigatório

O número total de aumentos salariais que o usuário teve em seu último emprego. Se current_status for EMPLOYED, isso se refere ao emprego atual do usuário.

Nota:

Para todos os aumentos ou reduções salariais, consideramos apenas aqueles em que a mudança no salário é superior a 2%.

Exemplo: 0
decreases_last_jobinteger or null(int32)obrigatório

O número total de aumentos salariais que o usuário teve em seu último emprego. Se current_status for EMPLOYED, isso se refere ao emprego atual do usuário.

Exemplo: 0
increases_after_changeinteger or null(int32)obrigatório

O número total de aumentos salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

Exemplo: 0
decreases_after_changeinteger or null(int32)obrigatório

O número total de reduções salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

Exemplo: 0
increases_overallinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo da carreira profissional do indivíduo.

Exemplo: 0
decreases_overallinteger or null(int32)obrigatório

O número total de reduções salariais ao longo da carreira profissional do indivíduo.

Exemplo: 0
increases_1yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo do último ano do indivíduo (YTD).

Exemplo: 0
decreases_1yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo do último ano do indivíduo (YTD).

Exemplo: 0
increases_3yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo dos últimos três anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
decreases_3yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo dos últimos três anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
increases_5yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo dos últimos cinco anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
decreases_5yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo dos últimos cinco anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
yearly_change_1ynumber or null(float)obrigatório

A mudança percentual do salário do indivíduo para o último ano (YTD).

Exemplo: 0
yearly_change_3ynumber or null(float)obrigatório

A variação percentual do salário do indivíduo nos últimos três anos.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
yearly_change_5ynumber or null(float)obrigatório

A variação percentual do salário do indivíduo nos últimos cinco anos.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
min_monthly_salary_1ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo no último ano.

Exemplo: 3402.88
min_monthly_salary_3ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo nos últimos três anos.

Exemplo: 3402.88
min_monthly_salary_5ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
average_monthly_salary_1ynumber or null(float)obrigatório

O salário médio mensal do indivíduo no último ano.

Exemplo: 3402.88
average_monthly_salary_3ynumber or null(float)obrigatório

O salário médio mensal do indivíduo nos últimos três anos.

Exemplo: 3402.88
average_monthly_salary_5ynumber or null(float)obrigatório

O salário médio mensal do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
max_monthly_salary_1ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo no último ano.

Exemplo: 3402.88
max_monthly_salary_3ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo nos últimos três anos.

Exemplo: 3402.88
max_monthly_salary_5ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "updated_at": "2023-08-30T15:31:35.728607Z", "reference_date": "2023-06-01", "age": 32, "current_status": "EMPLOYED", "current_employer_count": 1, "base_salary_last": 42.17, "weeks_employed_last_job": 327.1429, "weeks_since_last_job": 0, "weeks_employed_total": 148.2, "weeks_with_multiple_employers": 0, "employer_count": 14, "unique_employer_count": 3, "employers_per_year": 0.6326, "weeks_between_jobs": 687.2865, "max_weeks_between_jobs": 249.8571, "increases_last_job": 0, "decreases_last_job": 0, "increases_after_change": 0, "decreases_after_change": 0, "increases_overall": 0, "decreases_overall": 0, "increases_1y": 0, "decreases_1y": 0, "increases_3y": null, "decreases_3y": null, "increases_5y": null, "decreases_5y": null, "yearly_change_1y": 0, "yearly_change_3y": null, "yearly_change_5y": null, "min_monthly_salary_1y": 3402.88, "min_monthly_salary_3y": 3402.88, "min_monthly_salary_5y": 3402.88, "average_monthly_salary_1y": 3402.88, "average_monthly_salary_3y": 3402.88, "average_monthly_salary_5y": 3402.88, "max_monthly_salary_1y": 3402.88, "max_monthly_salary_3y": 3402.88, "max_monthly_salary_5y": 3402.88 }

Listar métricas de emprego

Requisição

▶️ Uso

Com o método Listar Métricas de Emprego, você pode:

  1. Listar métricas de emprego relacionadas a um link.id específico (usando o parâmetro de consulta link).
  2. Obter os detalhes de um employment-metric.id específico (usando o parâmetro de consulta id).
  3. [Não Recomendado] Listar todas as métricas de emprego relacionadas à sua conta Belvo (sem usar nenhum parâmetro de consulta).

📖 Paginação

Este método retorna uma resposta paginada (padrão: 100 itens por página). Você pode usar o parâmetro de consulta page_size para aumentar o número de itens retornados até um máximo de 1000 itens. Você pode usar o parâmetro de consulta page para navegar pelos resultados. Para mais detalhes sobre como navegar pelas respostas paginadas da Belvo, consulte nosso artigo Dicas de Paginação.

🔦 Filtrando Respostas

Consulte a lista de consultas abaixo para ver uma lista de campos pelos quais você pode filtrar suas respostas. Para mais informações sobre como usar filtros, consulte nosso artigo Filtrando respostas.

Security
basicAuth
Consulta
linkstring(uuid)

O link.id pelo qual você deseja filtrar.

ℹ️ Recomendamos fortemente adicionar o filtro link.id para melhorar seu desempenho.

Exemplo: link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4
page_sizeinteger(int32)[ 1 .. 1000 ]

Indica quantos resultados retornar por página. Por padrão, retornamos 100 resultados por página.

ℹ️ O número mínimo de resultados retornados por página é 1 e o máximo é 1000. Se você inserir um valor maior que 1000, nossa API usará o valor máximo por padrão (1000).

Padrão 100
Exemplo: page_size=100
pageinteger(int32)>= 1

Um número de página dentro do conjunto de resultados paginados.

Exemplo: page=1
link__inArray of strings(uuid)

Retorne resultados apenas para esses link.ids.

Exemplo: link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6
omitstring

Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

fieldsstring

Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

curl -i -X GET \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/employment-metrics/?fields=string&link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&omit=string&page=1&page_size=100'

Respostas

Ok

Corpoapplication/json
countinteger(int32)

O número total de resultados na sua conta Belvo.

Exemplo: 130
nextstring or null(uri)

A URL para a próxima página de resultados. Cada página consiste em até 100 itens. Se não houver resultados suficientes para uma página adicional, o valor será null.

Em nosso exemplo de documentação, usamos {endpoint} como um valor de espaço reservado. Em produção, esse valor será substituído pelo endpoint real que você está usando atualmente (por exemplo, accounts ou owners).

Exemplo: "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2"
previousstring or null(uri)

A URL para a página anterior de resultados. Se não houver uma página anterior, o valor será null.

Exemplo: null
resultsArray of objects

Array de objetos de métricas de emprego.

Resposta
application/json
{ "count": 130, "next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2", "previous": null, "results": [ {} ] }

Recuperar métricas de emprego

Requisição

Recuperar métricas de emprego para um indivíduo.

Nota: Antes de solicitar métricas de emprego, certifique-se de primeiro fazer uma solicitação POST Retrieve employment record details.

Security
basicAuth
Consulta
omitstring

Omitir certos campos de serem retornados na resposta. Para mais informações, consulte nosso artigo Filtrando respostas no DevPortal.

fieldsstring

Retorne apenas os campos especificados na resposta. Para mais informações, consulte nosso artigo no DevPortal Filtrando respostas.

Corpoapplication/jsonobrigatório
linkstring(uuid)obrigatório

O link.id para o qual você deseja recuperar informações.

Exemplo: "c81a1dea-6dd6-4999-8b9f-541ee8197058"
reference_datestring(date)

A data até a qual você deseja que as métricas de emprego sejam calculadas, no formato YYYY-MM-DD. Por exemplo, se você não quiser calcular as métricas de emprego para todo o ano de 2023, adicione 2022-12-31 como o reference_date.

Se você não fornecer um reference_date, realizaremos os cálculos até a data em que você fizer a solicitação.

Nota: Todos os cálculos serão relativos a esta data.

Exemplo: "2023-03-01"
save_databoolean

Indica se os dados devem ou não ser persistidos no Belvo. Por padrão, isso é definido como true e retornamos uma resposta 201 Created.

Quando definido como false, os dados não serão persistidos e retornamos uma resposta 200 OK.

Padrão true
Exemplo: true
curl -i -X POST \
  -u <username>:<password> \
  'https://developers.belvo.com/_mock/pt-br/apis/belvoopenapispec/api/employment-metrics/?fields=string&omit=string' \
  -H 'Content-Type: application/json' \
  -d '{
    "link": "c81a1dea-6dd6-4999-8b9f-541ee8197058",
    "reference_date": "2023-03-01",
    "save_data": true
  }'

Respostas

Ok

Corpoapplication/json
idstring(uuid)obrigatório

Identificador único da Belvo para o item atual.

Exemplo: "0d3ffb69-f83b-456e-ad8e-208d0998d71d"
linkstring or null(uuid)obrigatório

O link.id ao qual os dados pertencem.

Exemplo: "30cb4806-6e00-48a4-91c9-ca55968576c8"
collected_atstring(date-time)obrigatório

O carimbo de data/hora ISO-8601 quando o ponto de dados foi coletado.

Exemplo: "2022-02-09T08:45:50.406032Z"
created_atstring(date-time)obrigatório

O carimbo de data e hora ISO-8601 de quando o ponto de dados foi criado no banco de dados da Belvo.

Exemplo: "2022-02-09T08:45:50.406032Z"
updated_atstring or null(date-time)obrigatório

O carimbo de data/hora ISO-8601 de quando o cálculo das métricas de emprego foi atualizado pela última vez.

Exemplo: "2023-08-30T15:31:35.728607Z"
reference_datestring or null(date)obrigatório

A reference_date que você forneceu em sua solicitação. Se você não forneceu uma, este campo retornará null, indicando que os cálculos são realizados até a data da solicitação.

Nota: Todos os cálculos são relativos a esta data.

Exemplo: "2023-06-01"
ageinteger(int32)obrigatório

A idade do indivíduo.

Exemplo: 32
current_statusstringobrigatório

Indica o status de emprego do indivíduo. Retornamos uma das seguintes respostas:

  • EMPLOYED
  • RETIRED
  • UNEMPLOYED
  • null
Enum"EMPLOYED""RETIRED""UNEMPLOYED""null"
Exemplo: "EMPLOYED"
current_employer_countinteger or null(int32)obrigatório

O número de empregadores que o indivíduo tem no momento.

Exemplo: 1
base_salary_lastnumber or null(float)obrigatório

O salário base mais recente do usuário. Se current_status for EMPLOYED, este é o salário base atual do usuário.

Exemplo: 42.17
weeks_employed_last_jobnumber or null(float)obrigatório

O número de semanas em que o usuário esteve empregado em seu último emprego. Se current_status for EMPLOYED, então este campo indica o número de semanas em que o usuário está empregado em seu emprego atual.

Exemplo: 327.1429
weeks_since_last_jobnumber or null(float)obrigatório

O número de semanas desde o último emprego. Se o valor deste campo for 0, isso indica que o usuário está atualmente empregado.

Exemplo: 0
weeks_employed_totalnumber or null(float)obrigatório

O número total de semanas em que o usuário esteve empregado, de acordo com a instituição.

Nota:

No caso de o usuário estar empregado em dois ou mais lugares ao mesmo tempo, ainda calculamos essas semanas como uma semana. Por exemplo, se um usuário tem três empregos simultâneos por um mês, isso é calculado como 4 semanas.

Exemplo: 148.2
weeks_with_multiple_employersnumber or null(float)obrigatório

O número de semanas em que o indivíduo teve mais de um empregador ao mesmo tempo.

Exemplo: 0
employer_countinteger or null(int32)obrigatório

O número total de empregadores que o usuário teve. Útil para indicar a estabilidade de emprego ao longo de sua vida.

Exemplo: 14
unique_employer_countinteger or null(int32)obrigatório

O número de empregadores únicos que o indivíduo teve.

Nota:

Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.

Exemplo: 3
employers_per_yearnumber or null(float)obrigatório

Número de empregadores por ano. Útil para indicar a estabilidade no emprego ao longo de um ano.

Nota:

Se o usuário saiu de uma empresa e retornou, por exemplo, seis meses depois para a mesma empresa, isso é contado como um empregador.

Exemplo: 0.6326
weeks_between_jobsnumber or null(float)obrigatório

O número total de semanas em que o indivíduo esteve desempregado.

Exemplo: 687.2865
max_weeks_between_jobsnumber or null(float)obrigatório

O número máximo de semanas em que o indivíduo esteve desempregado.

Exemplo: 249.8571
increases_last_jobinteger or null(int32)obrigatório

O número total de aumentos salariais que o usuário teve em seu último emprego. Se current_status for EMPLOYED, isso se refere ao emprego atual do usuário.

Nota:

Para todos os aumentos ou reduções salariais, consideramos apenas aqueles em que a mudança no salário é superior a 2%.

Exemplo: 0
decreases_last_jobinteger or null(int32)obrigatório

O número total de aumentos salariais que o usuário teve em seu último emprego. Se current_status for EMPLOYED, isso se refere ao emprego atual do usuário.

Exemplo: 0
increases_after_changeinteger or null(int32)obrigatório

O número total de aumentos salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

Exemplo: 0
decreases_after_changeinteger or null(int32)obrigatório

O número total de reduções salariais entre o penúltimo emprego do indivíduo e o último (ou atual) emprego.

Exemplo: 0
increases_overallinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo da carreira profissional do indivíduo.

Exemplo: 0
decreases_overallinteger or null(int32)obrigatório

O número total de reduções salariais ao longo da carreira profissional do indivíduo.

Exemplo: 0
increases_1yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo do último ano do indivíduo (YTD).

Exemplo: 0
decreases_1yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo do último ano do indivíduo (YTD).

Exemplo: 0
increases_3yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo dos últimos três anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
decreases_3yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo dos últimos três anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
increases_5yinteger or null(int32)obrigatório

O número total de aumentos salariais ao longo dos últimos cinco anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
decreases_5yinteger or null(int32)obrigatório

O número total de reduções salariais ao longo dos últimos cinco anos do indivíduo.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
yearly_change_1ynumber or null(float)obrigatório

A mudança percentual do salário do indivíduo para o último ano (YTD).

Exemplo: 0
yearly_change_3ynumber or null(float)obrigatório

A variação percentual do salário do indivíduo nos últimos três anos.

Nota:

Se a carreira profissional do indivíduo for inferior a três anos, retornamos null.

Exemplo: null
yearly_change_5ynumber or null(float)obrigatório

A variação percentual do salário do indivíduo nos últimos cinco anos.

Nota:

Se a carreira profissional do indivíduo for inferior a cinco anos, retornamos null.

Exemplo: null
min_monthly_salary_1ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo no último ano.

Exemplo: 3402.88
min_monthly_salary_3ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo nos últimos três anos.

Exemplo: 3402.88
min_monthly_salary_5ynumber or null(float)obrigatório

O salário mensal mínimo do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
average_monthly_salary_1ynumber or null(float)obrigatório

O salário médio mensal do indivíduo no último ano.

Exemplo: 3402.88
average_monthly_salary_3ynumber or null(float)obrigatório

O salário médio mensal do indivíduo nos últimos três anos.

Exemplo: 3402.88
average_monthly_salary_5ynumber or null(float)obrigatório

O salário médio mensal do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
max_monthly_salary_1ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo no último ano.

Exemplo: 3402.88
max_monthly_salary_3ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo nos últimos três anos.

Exemplo: 3402.88
max_monthly_salary_5ynumber or null(float)obrigatório

O salário mensal máximo do indivíduo nos últimos cinco anos.

Exemplo: 3402.88
Resposta
application/json
{ "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d", "link": "30cb4806-6e00-48a4-91c9-ca55968576c8", "collected_at": "2022-02-09T08:45:50.406032Z", "created_at": "2022-02-09T08:45:50.406032Z", "updated_at": "2023-08-30T15:31:35.728607Z", "reference_date": "2023-06-01", "age": 32, "current_status": "EMPLOYED", "current_employer_count": 1, "base_salary_last": 42.17, "weeks_employed_last_job": 327.1429, "weeks_since_last_job": 0, "weeks_employed_total": 148.2, "weeks_with_multiple_employers": 0, "employer_count": 14, "unique_employer_count": 3, "employers_per_year": 0.6326, "weeks_between_jobs": 687.2865, "max_weeks_between_jobs": 249.8571, "increases_last_job": 0, "decreases_last_job": 0, "increases_after_change": 0, "decreases_after_change": 0, "increases_overall": 0, "decreases_overall": 0, "increases_1y": 0, "decreases_1y": 0, "increases_3y": null, "decreases_3y": null, "increases_5y": null, "decreases_5y": null, "yearly_change_1y": 0, "yearly_change_3y": null, "yearly_change_5y": null, "min_monthly_salary_1y": 3402.88, "min_monthly_salary_3y": 3402.88, "min_monthly_salary_5y": 3402.88, "average_monthly_salary_1y": 3402.88, "average_monthly_salary_3y": 3402.88, "average_monthly_salary_5y": 3402.88, "max_monthly_salary_1y": 3402.88, "max_monthly_salary_3y": 3402.88, "max_monthly_salary_5y": 3402.88 }

Payment Institutions (Brazil)

Uma instituição de pagamento é uma entidade da qual a Belvo pode acessar informações. Você pode ver uma lista completa de instituições disponíveis para pagamentos fazendo uma solicitação de List para este endpoint.

Operações

Customers (Brazil)

Um customer é o pagador que vai transferir fundos para sua conta bancária. Você precisa criar um customer para receber pagamentos de entrada na conta bancária da sua organização.

Operações

Bank Accounts (Brazil)

Para receber pagamentos de entrada na conta bancária da sua organização, você deve registrar as contas bancárias (individuais e empresariais) usando a Payments API da Belvo.

  • Contas bancárias individuais devem ser criadas para cada pagador (seu cliente).
  • Contas bancárias empresariais precisam ser criadas para o beneficiário do pagamento (sua organização).
Operações

Payment Intents (Brazil)

Um payment intent é um ponto único de acesso para criar pagamentos usando qualquer método de pagamento oferecido pela Belvo.

Um payment intent captura todas as informações de pagamento (como o valor a ser cobrado, a descrição do pagamento, o provedor, etc.) e guia seus clientes através do fluxo de pagamento.

Nota: Para instituições que exigem o username_type no array form_fields, você deve enviar esse valor na sua solicitação PATCH.

Operações

Payment Authorizations (Brazil)

Uma Autorização de Pagamento é o consentimento que seu usuário dá para que você debite dinheiro de suas contas. Você precisa realizar uma Autorização de Pagamento por ‘contrato’ (por exemplo, se sua empresa fornece tanto eletricidade quanto água, mas elas são cobradas separadamente, então você criará duas Autorizações de Pagamento separadas).

Assim que o usuário confirmar a autorização, você precisará escutar um webhook PAYMENT_AUTHORIZATION com o status definido como AUTHORIZED. Assim que você receber esse webhook, o processo de autorização estará completo, e você poderá cobrar seu usuário.

O que é uma cobrança?

Uma cobrança representa o pagamento individual (débito) que seu cliente fará.

Cabeçalho de Versão

O recurso de Autorização de Pagamento requer que você envie o cabeçalho X-Belvo-API-Resource-Version configurado para Payments-BR.V2.

Operações

Biometric Pix Widget Access Token (Brazil)

Use as solicitações de Token do Biometric Pix Widget para criar um token de acesso para Pagamentos Biométricos.

Operações

Enrollments (Brazil)

Operações

Payment Transactions (Brazil)

Cada vez que você recebe um pagamento de entrada de um cliente, uma transação é criada no banco de dados da Belvo.

Você pode usar o recurso de Transações de Pagamento para obter informações úteis sobre uma transação, bem como a cobrança específica associada a ela.

Operações