v1

latestOpenAPI 3.0.22026-08-061464031.4 MB
Owners

Get an owner's details

Get the details of a specific owner.

{% admonition type="info" %} This resource may return deprecated fields. Please check the response documentation for more information. {% /admonition %}

get/api/owners/{id}/

Path parameters

idstring uuid required

The owner.id you want to get detailed information about.

Query parameters

omitstring

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.

fieldsstring

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.

Response

Ok

OR
OR

Example response

{
  "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"
      }
    ]
  }
}