v1
latestOpenAPI 3.0.22026-08-061464031.4 MBList owners
▶️ Usage
With the List Owners method, you can:
- List owners related to a specific link.id (using the link query parameter).
- Get the details of a specific owners.id (using the id query parameter).
- [Not Recommended] List all owners related to your Belvo account (without using any query parameters).
📖 Pagination
This method returns a paginated response (default: 100 items per page). You can use the page_size query parameter to increase the number of items returned to a maximum of 1000 items. You can use the page query parameter to navigate through the results. For more details on how to navigate Belvo's paginated responses, see our <a href="https://developers.belvo.com/docs/belvo-pagination-tips" target="_blank">Pagination Tips</a> article.
🔦 Filtering Responses
Please see the query list below for a list of fields that you can filter your responses by. For more information on how to use filters, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> article.
🚨 Deprecated Fields
This resource may return deprecated fields. In the response documentation you may see that a field has been marked as deprecated. This means that this field is no longer maintained by the Belvo team. You may still receive data for this field depending on the institution, however, you should not rely on this field.
Query parameters
The link.id you want to filter by.
ℹ️ We highly recommend adding the link.id filter in order to improve your performance.
Indicates how many results to return per page. By default we return 100 results per page.
ℹ️ The minimum number of results returned per page is 1 and the maximum is 1000. If you enter a value greater than 1000, our API will default to the maximum value (1000).
A page number within the paginated result set.
Omit certain fields from being returned in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.
Return only the specified fields in the response. For more information, see our <a href="https://developers.belvo.com/docs/searching-and-filtering" target="_blank">Filtering responses</a> DevPortal article.
Return results only for these link.ids.
[ "5722d0ba-69d7-42dc-8ff5-33767b83c5d6" ]
Return information only for this resource id.
Return information for these resource ids.
[ "6b3dea0f-be29-49d1-aabe-1a6d588642e6" ]
Return items that were last updated in Belvo's database on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database after or on this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before this date (in YYYY-MM-DD format).
Return items that were last updated in Belvo's database before or on this date (in YYYY-MM-DD format).
Return accounts that were last updated in Belvo's database between two dates (in YYYY-MM-DD format). The first value indicates the start of the range and the second value indicates the end of the range.
[ "2022-01-01", "2022-12-31" ]
Returns owners whose email address match your query.
Return owners whose full display name partially matches your query. For example, mar will return results for Mark, Maria, Neymar, Remarque, and so on.
Response
Ok
Example response
{
"count": 130,
"next": "https://sandbox.belvo.com/api/{endpoint}/?link=1bd948f7-245d-4313-b604-34d1044cb908page=2",
"results": [
{
"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": "Jack Oswald White",
"social_name": "O Piadista",
"birth_date": "1988-07-15",
"marital_status": "SINGLE",
"marital_status_additional_info": "It's complicated",
"gender": "FEMALE",
"companies_id": [
"01773247000103"
],
"is_local_resident": true,
"document_id": {
"document_type": "CPF",
"document_number": "235578435-S"
},
"additional_documents": [
{
"type": "DRIVERS_LICENSE",
"type_additional_info": "Learner's licence",
"number": "DL-7896829-7",
"check_digit": "7",
"issue_date": "2019-01-01",
"expiration_date": "2019-01-01",
"country_of_issuance": "CAN",
"additional_info": "The document has water damage"
}
],
"nationalities": [
{
"info": "CAN",
"documents": [
{
"type": "DRIVERS_LICENSE",
"number": "DL-7896829-7",
"issue_date": "2019-01-01",
"expiration_date": "2019-01-01",
"country_of_issuance": "CAN",
"additional_info": "The document has water damage"
}
]
}
],
"email": "johndoe@belvo.com",
"emails": [
{
"is_main": true,
"email": "homen_morcego@gmail.com"
}
],
"address": "Carrer de la Llacuna, 162, 08018 Barcelona",
"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"
}
],
"phone_number": "+52-XXX-XXX-XXXX",
"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"
}
],
"filiations": [
{
"type": "MOTHER",
"civil_name": "Bruce Wayne",
"social_name": "The Dark Knight"
}
],
"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
}
},
"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": "Alfred Thaddeus Pennyworth",
"social_name": "Alfred Pennyworth",
"document_number": "73677831148"
}
],
"products": [
{
"type": "SAVINGS_ACCOUNT",
"subtype": "CONJUNTA_SIMPLES",
"agency": "6272",
"clearing_code": "001",
"number": "24550245",
"check_digit": "7"
}
],
"salary_portability_requests": [
{
"employer_name": "ACME Inc.",
"portability_approval_date": "2024-04-01"
}
],
"payroll_accounts": [
{
"employer_name": "ACME Inc.",
"account_opening_date": "2024-04-01"
}
]
}
}
]
}