With Belvo's Open Finance Data Aggregation (OFDA) product for Brazil, you can retrieve the owner information for an individual.

For each individual, you receive:

Core information about the individual (names, birth date, marital status, and contact information).
ID document and nationality details.
Information regarding their financial profile (including occupation, declared income, and current wealth).
Information regarding any products they have at the institution.

Core Owner (Individual) Information

{
  "id": "c749315b-eec2-435d-a458-06912878564f",
  "link": "30cb4806-6e00-48a4-91c9-ca55968576c8",
  "internal_identification": "7e5838e4",
  "collected_at": "2019-09-27T13:01:41.941Z",
  "created_at": "2022-02-09T08:45:50.406032Z",
  "display_name": "Jack Oswald White",
  "social_name": "O Piadista",
  "birth_date": "1988-07-15",
  "marital_status": "SINGLE",
  "marital_status_additional_info": "It's complicated",
  "gender": "MALE",
  "companies_id": [
    "01773247000103"
  ],
  "is_local_resident": true,
  "document_id": {}, // See the dedicated document_id section
  "additional_documents": [], // See the dedicated additional_documents section
  "nationalities": [], // See the dedicated nationalities section
  "email": "[email protected]",
  "emails": [], // See the dedicated emails section
  "address": "Carrer de la Llacuna, 162, 08018 Barcelona",
  "addresses": [], // See the dedicated addresses section
  "phone_number": "+52-XXX-XXX-XXXX",
  "phone_numbers": [], // See the dedicated phone_numbers section
  "filiations": [],  // See the dedicated filiations section
  "financial_profile": {},  // See the dedicated financial_profile section
  "financial_relation": {} // See the dedicated financial_relation section
}

Parameter	Type	Description	Example
id	string	Belvo's unique identifier for the current item.	0d3ffb69-f83b-456e-ad8e-208d0998d71d
link	string	The `link.id the data belongs to.	30cb4806-6e00-48a4-91c9-ca55968576c8
created_at	string (date-time)	The ISO-8601 timestamp of when the data point was created in Belvo's database.	2022-02-09T08:45:50.406032Z
collected_at	(date-time)	The ISO-8601 timestamp when the data point was collected.	2022-02-09T08:45:50.406032Z
internal_identification	string	The institution's internal identifier for the owner.	7e5838e4
display_name	string	The full name of the individual, as provided by the institution. > Non-nullable: A value must be returned by Brazil's open finance network.	Juan Kaique Cláudio Fernandes
social_name	string	The social name of the individual, as generally accepted by the country.	Jaqueline de Freitas
birth_date	string (date)	The individual's date of birth, in `YYYY-MM-DD` format. > Non-nullable: A value must be returned by Brazil's open finance network.	1989-03-23
marital_status	string	The individual's marital status. We return one of the following values: `SINGLE`, `MARRIED`, `WIDOWED`, `SEPARATED`, `DIVORCED`, `CIVIL_UNION`, or `OTHER`.	MARRIED
marital_status_additional_info	string	Additional information about the individual's marital status.	Amasiado
gender	string	The individual's gender. We return on of the following values: `FEMALE`, `MALE`, or `OTHER`	FEMALE
companies_id	array of strings	The institutions responsible for the creation and verification of the owner. > Non-nullable: A value must be returned by Brazil's open finance network.	["50685362000135"]
is_local_resident	boolean	Boolean to indicate if the individual is a local resident of the country. > Non-nullable: A value must be returned by Brazil's open finance network.	true
document_id	object	Information regarding the identification document the owner provided to the bank. Non-nullable: A value must be returned by Brazil's open finance network.	See the document_id section for details.
additional_documents	array of objects	Detailed information regarding additional documents provided to prove the individuals ID. Non-nullable: A value must be returned by Brazil's open finance network.	See the additional_documents section for details.
nationalities	array of objects	Detailed information regarding the individual's nationalities. Only required to be returned when `is_local_resident` is set to `false`.	See the nationalities section for details.
email	string	The account owner's registered email address. > Non-nullable: A value must be returned by Brazil's open finance network.	[email protected]
emails	array of objects	Additional list of emails the owner provided. > Non-nullable: A value must be returned by Brazil's open finance network.	See the emails section for details.
address	string	The account owner's registered address. > Non-nullable: A value must be returned by Brazil's open finance network.	Av Naburo Ykesaki, 1270, Marília, SP, 17500001, Brasil
addresses	array of objects	Detailed information regarding the owner's addresses. > Non-nullable: A value must be returned by Brazil's open finance network.	See the addresses section for details.
phone_number	string	The account owner's registered phone number. > Non-nullable: A value must be returned by Brazil's open finance network.	+5283920217284
phone_numbers	array of objects	Detailed information regarding the owner's phone numbers. > Non-nullable: A value must be returned by Brazil's open finance network.	See the phone_numbers section for details.
filiations	array of objects	Information regarding any familial relationships of the individual. > Non-nullable: A value must be returned by Brazil's open finance network.	See the filiations section for details.
financial_profile	object	Information regarding the financial profile of the individual.	See the financial_profile section for details.
financial_relation	object	Details regarding any additional relationship the individual has with the institution (for example, other accounts or products they have with the institution).	See the financial_relation section for details.

document_id

In the document_id object, you will receive the Brazilian identification number for the owner.

{
  "document_id": { 
    "document_type": "CPF",
    "document_number": "235578435-S"
  },
}

Parameter	Type	Description	Example
document_type	string	The type of document the owner provided to the institution to open the account. Can be ether: `CPF` (Cadastro de Pessoas Físicas), or `CNPJ` (Cadastro Nacional de Pessoas Jurídicas) Non-nullable: A value must be returned by Brazil's open finance network.	CPF
document_number	string	The document's identification number. Non-nullable: A value must be returned by Brazil's open finance network.	25872252137

additional_documents

In the additional_documents array, you can receive information regarding additional ID documents that the owner provided to the financial institution.

{
  "additional_documents": [
    {
      "type": "DRIVERS_LICENCE",
      "type_additional_info": "Learner's licence",
      "number": "DL-7896829-7",
      "check_digit": "7",
      "issue_date": "2019-01-01",
      "expiration_date": "2027-01-01",
      "country_of_issuance": "BRA",
      "additional_info": "O documento está danificado por água"
    }
  ]
}

Parameter	Type	Description	Example
type	string	The type of ID document. We return one of the following values: `DRIVERS_LICENCE`, `PASSPORT`, `ID_CARD`, `FISCAL_ID`, `FOREIGNER_REGISTRATION_CARD`, `OTHER`, or `null`	DRIVERS_LICENCE
type_additional_info	string	Additional information regarding the document type. > Note: For Business ID documents, this field must return a value from Brazil's open finance network.	Learner's licence
number	string	The ID document's number. > Non-nullable: A value must be returned by Brazil's open finance network.	DL-7896829-7
check_digit	string	The check digit of the ID document. > Non-nullable: A value must be returned by Brazil's open finance network.	7
issue_date	string (date)	The date the the ID document was issued, in `YYYY-MM-DD` format.	2019-01-01
expiration_date	string (date)	The date the the ID document expires, in `YYYY-MM-DD` format.	2027-01-01
country_of_issuance	string	The three-letter country code that issued the document (in ISO-3166 Alpha 3 format). This field must be returned when the `type` is `PASSPORT`.	BRA
additional_info	string	Additional information about the ID document.	O documento está danificado por água

nationalities

In the case that the owner does not have Brazilian nationality (is_local_resident is false) The nationalities array will contain information about the nationality of the individual (info) along with the identity document proving this nationality (documents).

{
  "nationalities": [
    {
      "info": "CAN",
      "documents": [
        {
          "type": "PASSPORT",
          "number": "PS-7896629-6",
          "issue_date": "2019-01-01",
          "expiration_date": "2029-01-01",
          "country_of_issuance": "CAN",
          "additional_info": "The document has water damage"
        }
      ]
    }
  ]
}

Parameter	Type	Description	Example
info	string	The nationality of the individual.	CAN
documents	array of objects	Additional documents the individual provided regarding their nationality.	See the documents section below.

documents

Parameter	Type	Description	Example
type	string	The type of ID document. We return one of the following values: `DRIVERS_LICENCE`, `PASSPORT`, `ID_CARD`, `FISCAL_ID`, `FOREIGNER_REGISTRATION_CARD`, `OTHER`, or `null` > Non-nullable: A value must be returned by Brazil's open finance network.	PASSPORT
number	string	The ID document's number. > Non-nullable: A value must be returned by Brazil's open finance network.	PS-7896629-6
issue_date	string (date)	The date the the ID document was issued, in `YYYY-MM-DD` format.	2019-01-01
expiration_date	string (date)	The date the the ID document expires, in `YYYY-MM-DD` format.	2027-01-01
country_of_issuance	string	The three-letter country code that issued the document (in ISO-3166 Alpha 3 format). This field must be returned when the `type` is `PASSPORT`.	CAN
additional_info	string	Additional information about the ID document.	O documento tem muitos vistos

emails

In addition to the email field in core owner information, you also receive an array of emails that the owner provided to the institution.

{
  "emails": [
    {
      "is_main": true,
      "email": "[email protected]"
    }
  ]
}

parameter name	type (format)	description	example
is_main	boolean	Indicates whether the user indicated that this is their main phone number. Note: A value must be returned by the Open Finance network.	true
email	string	The email address. Note: A value must be returned by the Open Finance network.	[email protected]

addresses

In addition to the address field in core owner information, you also receive an array of addresses that the owner provided to the institution which includes additional details.

{
  "addresses": [
    {
      "is_main": true,
      "address": "Av Naburo Ykesaki, 1270",
      "additional_info": "In between two palm trees",
      "district_name": "CENTRO",
      "town": "Brasilia",
      "town_code": "3550308",
      "state": "SP",
      "postcode": "17500001",
      "country_name": "Brasil",
      "country_code": "BRA",
      "latitude": "-23.5475000",
      "longitude": "-46.6361100"
    }
  ]
}

Parameter	Type	Description	Example
is_main	boolean	Boolean to indicate if this is the user's main address. Non-Nullable: A value must be returned by the Open Finance network.	true
address	string	The user's street address. Non-Nullable: A value must be returned by the Open Finance network.	Av Naburo Ykesaki, 1270
additional_info	string	Additional information regarding the user's address.	Fundos
district_name	string	The district of the address.	CENTRO
town	string	The user's town. Non-Nullable: A value must be returned by the Open Finance network.	Brasilia
town_code	string	The seven-digit code for the town, if applicable. For Brazil, this is the IBGE town code.	3550308
state	string	The state that the address is located in.	SP
postcode	string	The postcode of the address. Non-Nullable: A value must be returned by the Open Finance network.	17500001
country_name	string	The name of the country. Non-Nullable: A value must be returned by the Open Finance network.	Brasil
country_code	string	The three-letter country code (ISO-3166 Alpha 3 compliant).	BRA
latitude	string	The geographic latitude coordinate.	-23.5475000
longitude	string	The geographic longitude coordinate.	-46.6361100

phone_numbers

In addition to the phone_number field in core owner information, you also receive an array of phone numbers that the owner provided to the institution which includes additional details.

{
  "phone_numbers": [
    {
      "is_main": true,
      "type": "MOBILE",
      "additional_info": "This is their work mobile number.",
      "number": "29875132",
      "country_code": "351",
      "area_code": "21",
      "extension": "932"
    }
  ]
}

parameter name	type (format)	description	example
is_main	boolean	Indicates whether the user indicated that this is their main phone number. Non-Nullable: A value must be returned by the Open Finance network.	true
type	string	The type of phone number. We return one of the following values: `LANDLINE`, `MOBILE`, or `OTHER`. Note: A value must be returned by the Open Finance network.	MOBILE
additional_info	string	Additional information about the phone number.	This is their work mobile number.
number	integer	The phone number (not including the country, area, or extension codes). Note: A value must be returned by the Open Finance network.	29875132
country_code	integer	The country dialling code. For example: 351 (no +).	351
area_code	integer	The area dialling code.	21
extension	integer	The extension code.	932

filiations

In the filiations array, you can receive information regarding the owner's parental relations.

{
  "filiations": [
    {
      "type": "FATHER",
      "civil_name": "Marcelo Cláudio Fernandes",
      "social_name": "The Dark Knight"
    }
  ]
}

parameter name	type (format)	description	example
type	string	The familial relationship. We return one of the following values: `MOTHER`, `FATHER` or `null`. Note: A value must be returned by the Open Finance network.	FATHER
civil_name	string	The person's full name. Note: A value must be returned by the Open Finance network.	Marcelo Cláudio Fernandes
social_name	string	The person's social name.	Cláudio Fernandes

financial_profile

In the financial_profile array, you can receive information that the owner declared regarding their occupation, their income (informed_income), and current value of their holdings (patrimony).

{
  "financial_profile": {
    "company_id": "50685362000135",
    "occupation_code": "BRAZIL_OCCUPATION_CODE",
    "occupation_description": "01",
    "informed_income": {
      "frequency": "MONTHLY",
      "amount": 45391.89,
      "currency": "BRL",
      "date": "2020-03-19"
    },
    "patrimony": {
      "amount": 45391.89,
      "currency": "BRL",
      "year": 2020
    }
  }
}

Parameter	Type	Description	Example
company_id	string	The identifier of the company where the individual is employed.	50685362000135
occupation_code	string	The area of employment of the individual. We return one of the following values: `BRAZIL_PUBLIC_OFFICE`, `BRAZIL_OCCUPATION_CODE`, `OTHER`, or `null`	BRAZIL_OCCUPATION_CODE
occupation_description	string	Information regarding the individual's occupation.	01
informed_income	object	Information regarding the individual's reported income. > Non-nullable: A value must be returned by Brazil's open finance network.	See the informed_income section for details.
patrimony	object	Information regarding the individual's reported assets (if available).	See the patrimony section for details.

informed_income

Parameter	Type	Description	Example
frequency	string	Indicates how often the individual receives their salary. We return one of the following values: `DAILY`, `WEEKLY`, `FORTNIGHTLY`, `MONTHLY`, `BIMONTHLY`, `QUARTERLY`, `BIANNUALLY`, `ANNUALLY`, or `OTHERS`.	MONTHLY
amount	number	The reported income that the individual receives. > Non-nullable: A value must be returned by Brazil's open finance network.	45391.89
currency	string	The three-letter currency code (ISO-4217). > Non-nullable: A value must be returned by Brazil's open finance network.	BRL
date	string (date)	Date when the individual last received their salary. > Non-nullable: A value must be returned by Brazil's open finance network.	2020-03-19

patrimony

Parameter	Type	Description	Example
amount	number	The reported assets of the individual. > Non-nullable: A value must be returned by Brazil's open finance network.	45391.89
currency	string	The three-letter currency code (ISO-4217). > Non-nullable: A value must be returned by Brazil's open finance network when the `patrimony` object is available.	BRL
year	integer	The year that the reported assets applied. > Non-nullable: A value must be returned by Brazil's open finance network when the `patrimony` object is available.	2020

financial_relation

In the financial_relation object, you can receive information regarding the individuals that can access the account (procurators) as well as the products the owner has at the institution (products).

{
  "financial_relation": {
    "start_date": "2021-05-21T08:30:00Z",
    "product_services": ["CONTA_DEPOSITO_A_VISTA"],
    "product_services_additional_info": "Joint account with Robin",
    "procurators": [
      {
        "type": "LEGAL_REPRESENTATIVE",
        "civil_name": "Elza Milena Stefany Teixeira",
        "social_name": "Milena Teixeira",
        "document_number": "73677831148"
      }
    ],
    "products": [
      {
        "type": "SAVINGS_ACCOUNT",
        "subtype": "CONJUNTA_SIMPLES",
        "agency": "6272",
        "clearing_code": "001",
        "number": "24550245",
        "check_digit": "7"
      }
    ]
  }
}

Parameter	Type	Description	Example
start_date	string (date-time)	The ISO-8601 timestamp when the financial relationship between the individual and the institution started. > Non-nullable: A value must be returned by Brazil's open finance network.	2021-05-21T08:30:00Z
product_services	array of strings	A list of products that the individual has with the institution. > Non-nullable: A value must be returned by Brazil's open finance network.	["CONTA_DEPOSITO_A_VISTA"]
product_services_additional_info	string	Additional information regarding the products that the individual has.	Informações adicionais do tipo de seguro.
procurators	array of objects	Information regarding any individuals or companies that can act on behalf of the owner.	See the procurators section for details.
products	array of objects	Details regarding any additional products that the individual has with the institution.	See the products section for details.
salary_portability_requests	array of objects	Details regarding any salary portability requests that the individual has made with the institution. A salary portability is a request to transfer the individual's salary from their employer's 'payroll' bank account to another bank account. Note: Please note that the receiving bank account cannot terminate a salary portability (or be informed that it has been termnated). Only the employer's payroll bank is able to provide this information. As such, the portabilities listed here may not be up-to-date.	See the salary_portability_requests section for details .
payroll_accounts	array of objects	Details regarding any payroll bank accounts that are associated with the individual. That is, each time the indivudal has a new employer that they receive a salary from, it should be listed here. Note: Past employers may not close the payroll account for the indiviual. As such, the payroll accounts listed here may not be up-to-date.	See the payroll_accounts section for details .

procurators

Parameter	Type	Description	Example
type	string	The type of representative that can access and make changes to the account. We return one of the following values: `LEGAL_REPRESENTATIVE`, `ATTORNEY`, or `null`.	LEGAL_REPRESENTATIVE
civil_name	string	The representatives's full name. > Non-nullable: A value must be returned by Brazil's open finance network if the `procurators` field is available.	Elza Milena Stefany Teixeira
social_name	string	The person's social name.	Milena Teixeira
document_number	string	The document number of the representative. Note: For individuals, this is Brazil's CPF number. For businesses, this is Brazil's CNPJ number. > Non-nullable: A value must be returned by Brazil's open finance network if the `procurators` field is available.	73677831148

products

Parameter	Type	Description	Example
type	string	The additional products the individual has at the institution. We return one of the following values: `SAVINGS_ACCOUNT`, `CHECKING_ACCOUNT`, or `null`.	SAVINGS_ACCOUNT
subtype	string	The subtype of the product that the individual has at the institution. > Non-nullable: A value must be returned by Brazil's open finance network if the `products` field is available.	CONJUNTA_SIMPLES
agency	string	The branch code where the product was opened.	6272
clearing_code	string	The banking clearing code for the product. > Non-nullable: A value must be returned by Brazil's open finance network if the `products` field is available.	001
number	string	The account number of the product. > Non-nullable: A value must be returned by Brazil's open finance network if the `procurators` field is available.	24550245
check_digit	string	The check digit of the product's number. > Non-nullable: A value must be returned by Brazil's open finance network if the `products` field is available.	7

salary_portability_requests

Parameter	Type	Description	Example
employer_name	string	The name of the employer.	ACME Inc.
employer_id_number	string	The CPF or CNPJ of the employer.	12345678901
employer_bank_id_number	string	The CNPJ of the employer's bank.	12345678901234
employer_bank_code	string	The bank ISPB (Identificador de Sistema de Pagamentos Brasileiros) code of the employer's bank.	12345678
portability_approval_date	string (date)	The date the portability request was approved, in `YYYY-MM-DD` format.	2024-04-01

payroll_accounts

Parameter	Type	Description	Example
employer_name	string	The name of the employer.	ACME Inc.
employer_id_number	string	The CPF or CNPJ of the employer.	12345678901
employer_bank_id_number	string	The CNPJ of the employer's bank.	12345678901234
employer_bank_code	string	The bank ISPB (Identificador de Sistema de Pagamentos Brasileiros) code of the employer's bank.	12345678
account_opening_date	string (date)	The date that the salary bank account was opened, in `YYYY-MM-DD` format.	2024-04-01