Pular para o conteúdo

Documentação da API Belvo (1.223.0)

Introdução

Alcance novos públicos e converta mais usuários conectando-se fácil e seguramente aos seus dados financeiros, 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 forma 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, baixe-a 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
200✅ Sucesso - O conteúdo está disponível no corpo da resposta.
201✅ Sucesso - O conteúdo foi criado com sucesso na Belvo.
204✅ Sucesso - Nenhum conteúdo para retornar.
400❌ Erro de Solicitação Inválida - A solicitação retornou um erro, detalhe no conteúdo.
401❌ Não Autorizado - As credenciais da Belvo fornecidas não são válidas.
404❌ Não Encontrado - O recurso que você tentou acessar não pode ser encontrado.
405❌ Método Não Permitido - O método HTTP que você está usando não é aceito para este recurso.
408❌ Tempo de Solicitação Esgotado - A solicitação expirou e foi encerrada pelo servidor.
428❌ Token MFA Necessário - O token MFA foi exigido pela instituição para conectar.
500❌ Erro 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 ao Tratamento de Erros.

Política de Retentativa

Erros 50x

Implemente um backoff exponencial automatizado de até cinco tentativas. Recomendamos usar um intervalo base de três segundos com um fator de dois. Por exemplo, a primeira tentativa deve ser após três segundos, a segunda tentativa após seis segundos (2 * 3), a terceira tentativa após 12 segundos (2 * 6), a quarta tentativa após 24 segundos (2 * 12) e a quinta tentativa 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 significa que seu usuário final está acessando a conta de outro navegador ao mesmo tempo. Nesse caso, implemente a mesma política de retentativa 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.

📘 Info

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
BelvoOpenApiSpec.json
BelvoOpenApiSpec.yaml
Visão Geral
URL
https://developers.belvo.com
Need help?
support@belvo.com
Idiomas
Servidores
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.
SchemasOperaçõ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.

SchemasOperaçõ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
SchemasOperações

Proprietário de Negócios (OFDA Brasil)

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"
internal_identificationstring or nullobrigatório

O identificador interno da instituição para o proprietário.

Exemplo: "7e5838e4"
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"
company_namestring<= 128 characters^[\w\W]{0,128}$obrigatório

O nome completo (oficial) do negócio, conforme fornecido pela instituição.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "Wayne Enterprises"
trade_namestring or null<= 128 characters^[\w\W]{0,128}$obrigatório

O nome comercial da empresa.

Exemplo: "WayneCorp"
incorporation_datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que a empresa foi constituída, no formato YYYY-MM-DD.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "1988-07-15"
companies_idArray of stringsnon-emptyobrigatório

As instituições responsáveis pela criação e verificação do proprietário.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: ["01773247000103"]
document_idobjectobrigatório

Informações sobre o documento de identificação que o proprietário forneceu ao banco.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

document_typestringobrigatório

O tipo de documento que o proprietário forneceu à instituição para abrir a conta. Tipos comuns de documentos são:

🇧🇷 Brasil

  • CPF (Cadastro de Pessoas Físicas)
  • CNPJ (Cadastro Nacional de Pessoas Jurídicas)

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "CPF"
document_numberstringobrigatório

O número de identificação do documento.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "235578435-S"
additional_documentsArray of objects or nullnon-emptyobrigatório

Informações detalhadas sobre documentos adicionais fornecidos para comprovar a identidade da empresa.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

typestring or nullobrigatório

O tipo de documento de identificação. Retornamos um dos seguintes valores:

  • DRIVERS_LICENSE
  • PASSPORT
  • ID_CARD
  • FISCAL_ID
  • FOREIGNER_REGISTRATION_CARD
  • OTHER
  • null
Enum"DRIVERS_LICENSE""PASSPORT""ID_CARD""FISCAL_ID""FOREIGNER_REGISTRATION_CARD""OTHER"null
Exemplo: "DRIVERS_LICENSE"
type_additional_infostring or null<= 70 characters^[\w\W\s]{0,70}$obrigatório

Informações adicionais sobre o tipo de documento.

Nota: Para documentos de ID Empresarial, este campo deve retornar um valor da rede de open finance do Brasil.

Exemplo: "EIN"
numberstring<= 40 characters^[\w\W]{0,40}$obrigatório

O número do documento de identidade.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "DL-7896829-7"
check_digitstring<= 2 characters^[\w\W\s]{0,2}$obrigatório

O dígito verificador do documento de identidade.

Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.

Exemplo: null
issue_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.

Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.

Exemplo: null
expiration_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data de expiração do documento de identidade, no formato YYYY-MM-DD.

Exemplo: "2019-01-01"
country_of_issuancestring or null<= 3 characters^(\w{3}){1}$obrigatório

O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "CAN"
additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$obrigatório

Informações adicionais sobre o documento de identificação.

Nota: Este campo não se aplica a documentos de identificação empresarial e retornará null.

Exemplo: null
emailstring or null(email)<= 256 charactersobrigatório

O endereço de e-mail registrado do proprietário da conta.

Exemplo: "johndoe@belvo.com"
emailsArray of objects or null>= 0 itemsobrigatório

Lista adicional de e-mails fornecida pelo proprietário.

is_mainbooleanobrigatório

Boolean para indicar se este é o endereço de e-mail principal do usuário.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: true
emailstring<= 320 characters^[\w\W\s]{0,320}$obrigatório

O endereço de e-mail do usuário.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "homen_morcego@gmail.com"
addressstring or nullobrigatório

O endereço registrado do proprietário das contas.

Exemplo: "Carrer de la Llacuna, 162, 08018 Barcelona"
addressesArray of objects or nullnon-emptyobrigatório

Informações detalhadas sobre os endereços do proprietário.

is_mainbooleanobrigatório

Boolean para indicar se este é o endereço principal do usuário.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: true
addressstring<= 150 characters^[\w\W\s]{0,150}$obrigatório

O endereço do usuário.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "Av Naburo Ykesaki, 1270"
additional_infostring or null<= 150 characters^[\w\W\s]{0,150}$obrigatório

Informações adicionais sobre o endereço do usuário.

Exemplo: "In between two palm trees"
district_namestring or null<= 50 characters^[\w\W\s]{0,50}$obrigatório

O distrito do endereço.

Exemplo: "CENTRO"
townstring<= 50 characters^[\w\W\s]{0,50}$obrigatório

A cidade do usuário.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "Brasilia"
town_codestring or null<= 7 characters\d{7}$obrigatório

O código de sete dígitos para a cidade, se aplicável.

Para o Brasil, este é o código do município do IBGE.

Exemplo: "3550308"
statestring or null<= 2 characters^[\w\W\s]{0,2}$obrigatório

O estado em que o endereço está localizado.

Exemplo: "SP"
postcodestring<= 8 characters^\d{8}$obrigatório

O código postal do endereço.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "17500001"
country_namestring<= 80 characters^[\w\W\s]{0,80}$obrigatório

O nome do país.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "Brasil"
country_codestring or null<= 3 characters^([A-Z]{3})$obrigatório

O código de país de três letras (conforme ISO-3166 Alpha 3).

Exemplo: "BRA"
latitudestring or null<= 13 characters^-?\d{1,2}\.\d{1,9}$obrigatório

A coordenada de latitude geográfica.

Exemplo: "-23.5475000"
longitudestring or null<= 13 characters^-?\d{1,3}\.\d{1,8}$obrigatório

A coordenada de longitude geográfica.

Exemplo: "-46.6361100"
phone_numberstring or nullobrigatório

O número de telefone registrado do proprietário da conta.

Exemplo: "+52-XXX-XXX-XXXX"
phone_numbersArray of objects or null>= 0 itemsobrigatório

Informações detalhadas sobre os phone_numbers do proprietário.

is_mainbooleanobrigatório

Boolean para indicar se este é o número de telefone principal do usuário.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: true
typestring or nullobrigatório

O tipo de número de telefone. Retornamos um dos seguintes valores:

  • LANDLINE
  • MOBILE
  • OTHER
  • null
Enum"LANDLINE""MOBILE""OTHER"null
Exemplo: "MOBILE"
additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$obrigatório

Informações adicionais sobre o número de telefone.

Exemplo: "This is their work mobile number."
numberstring<= 11 characters^([0-9]{8,11})$obrigatório

O número de telefone (não incluindo o código do país, área ou ramal).

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "29875132"
country_codestring or null<= 4 characters^\d{1,4}$obrigatório

O código de discagem do país. Por exemplo: 351 (sem +).

Exemplo: "351"
area_codestring or null<= 2 characters^\d{1,2}$obrigatório

O código de discagem da área.

Exemplo: "21"
extensionstring or null<= 5 characters^\d{1,5}$obrigatório

O código da extensão.

Exemplo: "932"
partiesArray of objects or nullnon-emptyobrigatório

Informações detalhadas sobre as partes autorizadas a agir em nome do proprietário.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

person_typestring or nullobrigatório

O tipo de pessoa que é parte proprietária da conta. Retornamos um dos seguintes valores:

  • INDIVIDUAL
  • COMPANY
Enum"INDIVIDUAL""COMPANY"
Exemplo: "INDIVIDUAL"
typestring or nullobrigatório

O tipo de acesso que o person_type tem à conta. Retornamos um dos seguintes valores:

  • MEMBER indica que o person_type tem acesso de leitura à conta.
  • ADMINISTRATOR indica que o person_type pode realizar todas as ações para a conta (incluindo transferências).
Enum"MEMBER""ADMINISTRATOR"
Exemplo: "MEMBER"
display_namestring or null<= 128 characters^[\w\W]{0,128}$obrigatório

O nome completo do indivíduo, conforme fornecido pela instituição. Aplicável apenas se o person_type for INDIVIDUAL.

Exemplo: "Jack Oswald White"
social_namestring or null<= 128 characters^[\w\W]{0,128}$obrigatório

O nome social do indivíduo, conforme geralmente aceito pelo país. Aplicável apenas se o person_type for INDIVIDUAL.

Exemplo: "O Piadista"
company_namestring or null<= 128 characters^[\w\W]{0,128}$

O nome completo (oficial) da empresa. Aplicável apenas se o person_type for COMPANY.

Exemplo: "Wayne Enterprises"
trade_namestring or null<= 128 characters^[\w\W]{0,128}$obrigatório

O nome comercial da empresa. Aplicável apenas se o person_type for COMPANY.

Exemplo: "WayneCorp"
start_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que a parte foi adicionada à conta, no formato YYYY-MM-DD.

Exemplo: "2021-07-15"
percentage_typenumber or null(float)= 8 characters^[01]\.\d{6}$obrigatório

A participação acionária da parte.

Exemplo: 0.51
document_typestring or nullobrigatório

O tipo de documento de identificação que a parte forneceu ao ser adicionada à conta. Retornamos um dos seguintes valores:

  • CPF
  • CNPJ
  • OTHER_TRAVEL_DOCUMENT
  • PASSPORT
Enum"CPF""CNPJ""OTHER_TRAVEL_DOCUMENT""PASSPORT"
Exemplo: "CPF"
document_numberstring<= 40 characters^[\w\W\s]{0,40}$obrigatório

O número do documento de identidade.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "DL-7896829-7"
document_issue_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que o documento de identificação foi emitido, no formato YYYY-MM-DD.

Exemplo: "2019-01-01"
document_expiration_datestring or null(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data de expiração do documento de identidade, no formato YYYY-MM-DD.

Exemplo: "2019-01-01"
document_countrystring or null<= 3 characters^(\w{3}){1}$obrigatório

O código de país de três letras que emitiu o documento (no formato ISO-3166 Alpha 3).

Exemplo: "CAN"
document_additional_infostring or null<= 100 characters^[\w\W\s]{0,100}$obrigatório

Informações adicionais sobre o documento.

Exemplo: "Confirmed CPF with their driver's licence."
financial_profileobject or nullobrigatório

Informações sobre o perfil financeiro do indivíduo.

economic_activitiesArray of objects or nullobrigatório

Detalhes sobre as atividades econômicas relatadas da empresa.

is_mainbooleanobrigatório

Boolean para indicar se esta é a principal atividade econômica do negócio.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo economic_activities estiver disponível.

Exemplo: true
codestring[ 2 .. 7 ] characters^\d{2,7}$obrigatório

O código da atividade econômica, conforme fornecido pelo país.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo economic_activities estiver disponível.

Exemplo: "8599604"
informed_revenueobject or nullobrigatório

Informações sobre a receita reportada do negócio.

frequencystring or nullobrigatório

Indica com que frequência a empresa declara sua receita. Retornamos um dos seguintes valores:

  • DAILY
  • WEEKLY
  • FORTNIGHTLY
  • MONTHLY
  • BIMONTHLY
  • QUARTERLY
  • BIANNUALLY
  • ANNUALLY
  • OTHERS
  • null
Enum"DAILY""WEEKLY""FORTNIGHTLY""MONTHLY""BIMONTHLY""QUARTERLY""BIANNUALLY""ANNUALLY""OTHERS"null
Exemplo: "MONTHLY"
frequency_additional_infostring or null<= 100 characters[\w\W\s]*obrigatório

Informações adicionais sobre a frequência.

Exemplo: "Recently switched from weekly to monthly."
amountnumber(float)^\d{1,15}\.\d{2,4}$obrigatório

A receita reportada do negócio.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.

Exemplo: 45391.89
currencystring= 3 characters^[A-Z]{3}$obrigatório

O código de moeda de três letras (ISO-4217).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.

Exemplo: "BRL"
yearinteger(int32)[ 1700 .. 2090 ]obrigatório

O ano em que a receita foi declarada pela última vez.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo informed_revenue estiver disponível.

Exemplo: 2022
patrimonyobject or nullobrigatório

Informações sobre os ativos relatados do indivíduo.

amountnumber(float)^\d{1,15}\.\d{2,4}$obrigatório

Os ativos relatados do negócio.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.

Exemplo: 45391.89
currencystring<= 3 characters^[A-Z]{3}$obrigatório

O código de moeda de três letras (ISO-4217).

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.

Exemplo: "BRL"
datestring(date)<= 10 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

A data em que os ativos relatados foram aplicados, no formato YYYY-MM-DD.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo patrimony estiver disponível.

Exemplo: "2022-12-12"
financial_relationobject or nullobrigatório

Detalhes sobre qualquer relacionamento adicional que a empresa tenha com a instituição (por exemplo, outras contas ou produtos que ela possua com a instituição).

start_datestring(date-time)<= 20 characters^(\d{4})-(1[0-2]|0?[1-9])-(3[01]|[12][0-9]|0?...obrigatório

O carimbo de data/hora ISO-8601 quando o relacionamento financeiro entre a empresa e a instituição começou.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: "2021-05-21T08:30:00Z"
product_servicesArray of stringsnon-emptyobrigatório

Uma lista de produtos que a empresa possui com a instituição.

Non-nullable: Um valor deve ser retornado pela rede de open finance do Brasil.

Exemplo: ["CONTA_DEPOSITO_A_VISTA"]
procuratorsArray of objects or nullobrigatório

Informações sobre quaisquer indivíduos ou empresas que possam agir em nome do proprietário.

typestring or nullobrigatório

O tipo de representante que pode acessar e fazer alterações na conta. Retornamos um dos seguintes valores:

  • LEGAL_REPRESENTATIVE
  • ATTORNEY
  • null
Enum"LEGAL_REPRESENTATIVE""ATTORNEY"null
Exemplo: "LEGAL_REPRESENTATIVE"
civil_namestring<= 70 characters^[\w\W]*$obrigatório

O nome completo dos representantes.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.

Exemplo: "Alfred Thaddeus Pennyworth"
social_namestring or null<= 70 characters^[\w\W]*$obrigatório

O nome social da pessoa.

Exemplo: "Alfred Pennyworth"
document_numberstring<= 11 characters^\d{11}$obrigatório

O número do documento do representante.

Nota: Para indivíduos, este é o número do CPF do Brasil. Para empresas, este é o número do CNPJ do Brasil.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo procurators estiver disponível.

Exemplo: "73677831148"
productsArray of objects or nullobrigatório

Detalhes sobre quaisquer produtos adicionais que a empresa tenha com a instituição.

typestring or nullobrigatório

Os produtos adicionais que a empresa possui na instituição. Retornamos um dos seguintes valores:

  • SAVINGS_ACCOUNT
  • CHECKING_ACCOUNT
  • null
Enum"SAVINGS_ACCOUNT""CHECKING_ACCOUNT"null
Exemplo: "SAVINGS_ACCOUNT"
subtypestringobrigatório

O subtipo do produto que a empresa possui na instituição.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.

Exemplo: "CONJUNTA_SIMPLES"
agencystring or null<= 4 characters^\d{1,4}$obrigatório

O código da agência onde o produto foi aberto.

Exemplo: "6272"
clearing_codestring<= 3 characters^\d{3}$obrigatório

O código de compensação bancária para o produto.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.

Exemplo: "001"
numberstring<= 20 characters^\d{8,20}$obrigatório

O número da conta do produto.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.

Exemplo: "24550245"
check_digitstring<= 2 characters^[\w\W\s]{0,2}$obrigatório

O dígito verificador do número do produto.

Não anulável: Um valor deve ser retornado pela rede de open finance do Brasil se o campo products estiver disponível.

Exemplo: "7"
{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "internal_identification": "7e5838e4",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "company_name": "Wayne Enterprises",
  "trade_name": "WayneCorp",
  "incorporation_date": "1988-07-15",
  "companies_id": [
    "01773247000103"
  ],
  "document_id": {
    "document_type": "CPF",
    "document_number": "235578435-S"
  },
  "additional_documents": [
    { … }
  ],
  "email": "johndoe@belvo.com",
  "emails": [
    { … }
  ],
  "address": "Carrer de la Llacuna, 162, 08018 Barcelona",
  "addresses": [
    { … }
  ],
  "phone_number": "+52-XXX-XXX-XXXX",
  "phone_numbers": [
    { … }
  ],
  "parties": [
    { … }
  ],
  "financial_profile": {
    "economic_activities": [ … ],
    "informed_revenue": { … },
    "patrimony": { … }
  },
  "financial_relation": {
    "start_date": "2021-05-21T08:30:00Z",
    "product_services": [ … ],
    "procurators": [ … ],
    "products": [ … ]
  }
}

Proprietário Padrão (Multi-Região)

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"
internal_identificationstring or nullobrigatório

O identificador interno da instituição para o proprietário.

Exemplo: "7e5838e4"
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)

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"
display_namestring or null<= 128 charactersobrigatório

O nome completo do proprietário, conforme fornecido pelo banco.

Exemplo: "John Doe"
emailstring or null(email)<= 256 charactersobrigatório

O endereço de e-mail registrado do proprietário da conta.

Exemplo: "johndoe@belvo.com"
phone_numberstring or nullobrigatório

O número de telefone registrado do proprietário da conta.

Exemplo: "+52-XXX-XXX-XXXX"
addressstring or nullobrigatório

O endereço registrado do proprietário das contas.

Exemplo: "Carrer de la Llacuna, 162, 08018 Barcelona"
document_idobject or null

Informações sobre o documento de identificação que o proprietário forneceu ao banco.

business_namestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O nome do negócio.

Exemplo: null
first_namestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O primeiro nome do titular da conta.

Exemplo: null
last_namestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O sobrenome do titular da conta.

Exemplo: null
second_last_namestring or nullObsoleto

Este campo foi descontinuado. Para mais informações sobre a Belvo e descontinuação, consulte nossa explicação sobre Campos descontinuados.

O segundo sobrenome do titular da conta.

Exemplo: null
{
  "id": "0d3ffb69-f83b-456e-ad8e-208d0998d71d",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "internal_identification": "7e5838e4",
  "collected_at": "2022-02-09T08:45:50.406032Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "display_name": "John Doe",
  "email": "johndoe@belvo.com",
  "phone_number": "+52-XXX-XXX-XXXX",
  "address": "Carrer de la Llacuna, 162, 08018 Barcelona",
  "document_id": {
    "document_type": "CPF",
    "document_number": "235578435-S"
  },
  "business_name": null,
  "first_name": null,
  "last_name": null,
  "second_last_name": null
}

Listar proprietários

Requisição

▶️ Uso

Com o método List Owners, você pode:

  1. Listar proprietários relacionados a um link.id específico (usando o parâmetro de consulta link).
  2. Obter os detalhes de um owners.id específico (usando o parâmetro de consulta id).
  3. [Não Recomendado] Listar todos os proprietários relacionados à 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 nas 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.

🚨 Campos Obsoletos

Este recurso pode retornar campos obsoletos. Na documentação de resposta, você pode ver que um campo foi marcado como obsoleto. 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, não deve confiar neste campo.

Segurança
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
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.

link__inArray of strings(uuid)

Retorne resultados apenas para esses link.ids.

Exemplo: link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6
idstring(uuid)

Retorne informações apenas para este recurso id.

Exemplo: id=24ccab1d-3a86-4136-a6eb-e04bf52b356f
id__inArray of strings(uuid)

Retorne informações para esses ids de recurso.

Exemplo: id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6
created_atstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo nesta data (no formato YYYY-MM-DD).

Exemplo: created_at=2022-05-05
created_at__gtstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após esta data (no formato YYYY-MM-DD).

Exemplo: created_at__gt=2022-05-05
created_at__gtestring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo após ou nesta data (no formato YYYY-MM-DD).

Exemplo: created_at__gte=2022-05-04
created_at__ltstring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes desta data (no formato YYYY-MM-DD).

Exemplo: created_at__lt=2022-04-01
created_at__ltestring(date)

Retorne itens que foram atualizados pela última vez no banco de dados da Belvo antes ou na data especificada (no formato YYYY-MM-DD).

Exemplo: created_at__lte=2022-03-30
created_at__rangeArray of strings(date)<= 2 items

Retorne contas que foram atualizadas pela última vez no banco de dados do Belvo entre duas datas (no formato YYYY-MM-DD). O primeiro valor indica o início do intervalo e o segundo valor indica o final do intervalo.

Exemplo: created_at__range=2022-01-01,2022-12-31
emailstring(email)

Retorna proprietários cujo endereço de e-mail corresponde à sua consulta.

Exemplo: email=lopes.d@gmail.com
display_name__icontainsstring>= 3 characters

Retorne proprietários cujo nome completo de exibição corresponda parcialmente à sua consulta. Por exemplo, mar retornará resultados para Mark, Maria, Neymar, Remarque, e assim por diante.

Exemplo: display_name__icontains=Daniela
curl -i -X GET \
  -u <username>:<password> \
  'https://sandbox.belvo.com/api/owners/?link=8848bd0c-9c7e-4f53-a732-ec896b11d4c4&page_size=100&page=1&omit=string&fields=string&link__in=5722d0ba-69d7-42dc-8ff5-33767b83c5d6&id=24ccab1d-3a86-4136-a6eb-e04bf52b356f&id__in=6b3dea0f-be29-49d1-aabe-1a6d588642e6&created_at=2022-05-05&created_at__gt=2022-05-05&created_at__gte=2022-05-04&created_at__lt=2022-04-01&created_at__lte=2022-03-30&created_at__range=2022-01-01%2C2022-12-31&email=lopes.d%40gmail.com&display_name__icontains=Daniela'

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

Uma matriz de:

  • objetos Owner Individual (OFDA Brazil)
  • objetos Owner Business (OFDA Brazil)
  • objetos Owner Standard (Multi-Region)

🚧 Um tipo de esquema por resposta

A resposta conterá uma matriz de um dos tipos de esquema descritos acima. Em outras palavras, não haverá uma mistura de tipos de esquema na resposta.

Resposta
application/json

Exemplo de um indivíduo (OFDA Brasil).

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

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.
SchemasOperações

Balances

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

SchemasOperações

Exchanges

Uma troca é uma operação de câmbio na Rede de Open Finance do Brasil. O recurso contém detalhes das operações de câmbio, incluindo taxas de câmbio, valores em moedas locais e estrangeiras, e informações de liquidação. Cada operação de câmbio pode ter eventos históricos associados que registram quaisquer modificações no contrato original.

SchemasOperaçõ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.

SchemasOperações

Bills

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

SchemasOperações

Investments Brazil

SchemasOperações

Investment Transactions Brazil

SchemasOperaçõ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)
SchemasOperaçõ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)
SchemasOperações

Current Employments Mexico

O recurso de Empregos Atuais fornece acesso em tempo real ao status de emprego atual de indivíduos no México. Este recurso oferece informações detalhadas sobre se um indivíduo está atualmente empregado ou desempregado, juntamente com seus registros de emprego ativos.

SchemasOperações

Invoices

SchemasOperações

Tax compliance status

SchemasOperações

Tax returns

SchemasOperações

Tax retentions

SchemasOperações

Tax status

SchemasOperações

Financial Statements

SchemasOperações

Invoices Chile

SchemasOperações

Tax Status Chile

SchemasOperações

Debt Reports Chile

SchemasOperaçõ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.

SchemasOperaçõ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.

SchemasOperações

Risk Insights

SchemasOperações

Employment Metrics

SchemasOperações

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 cliente é o pagador que vai transferir fundos para sua conta bancária. Você precisa criar um cliente para receber pagamentos de entrada na conta bancária da sua organização.

Versionamento de Recursos

Este endpoint suporta versionamento a nível de recurso. Ao incluir o cabeçalho X-Belvo-API-Resource-Version: Payments-BR.V2, você pode acessar os formatos de requisição e resposta mais recentes (V2). Se o cabeçalho não for fornecido, o formato padrão (V1) será utilizado. Consulte a documentação da API para detalhes sobre as diferenças entre as versões.

Operações

Bank Accounts (Brazil)

Para receber pagamentos de entrada na conta bancária da sua organização, é necessário 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).
Versionamento de Recursos

Este endpoint suporta versionamento a nível de recurso. Ao incluir o cabeçalho X-Belvo-API-Resource-Version: Payments-BR.V2, você pode acessar os formatos de requisição e resposta mais recentes (V2). Se o cabeçalho não for fornecido, o formato padrão (V1) será utilizado. Consulte a documentação da API para detalhes sobre as diferenças entre as versões.

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

Charges (Brazil)

Você pode usar o recurso Charges para obter detalhes sobre uma única cobrança ou listar todas as cobranças associadas a uma intenção de pagamento.

Operações

Payment Intents (Brazil)

Uma intenção de pagamento é um ponto único de acesso para criar pagamentos usando qualquer método de pagamento oferecido pela Belvo.

Uma intenção de pagamento 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.

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
Copyright © 2020-2025 Belvo. All rights reserved