v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Customers | Dados

Obtém os dados de qualificação da pessoa natural

Método para obter registros de qualificação da pessoa natural mantidos na instituição transmissora.

PERMISSÃO NECESSÁRIA: CUSTOMERS_PERSONAL_QUALIFICATIONS_READ

get/baas/v1/open/dat/customers/personal/qualifications

Query parameters

pageinteger

Número da página que está sendo requisitada

page-sizeinteger

Quantidade total de registros por páginas

Response

Dados de qualificação da pessoa natural obtidos com sucesso

Example response

{
  "data": [
    {
      "updateDateTime": "2021-05-21T08:30:00Z",
      "personalId": "578-psd-71md6971kjh-2d414",
      "brandName": "Organização A",
      "companiesCnpj": [
        "01773247000103"
      ],
      "occupationCode": "RECEITA_FEDERAL",
      "occupationDescription": "01234567",
      "informedIncome": {
        "frequency": "MENSAL",
        "amount": 100000.04,
        "currency": "BRL",
        "date": "2021-05-21"
      },
      "informedPatrimony": {
        "amount": 610000,
        "currency": "BRL",
        "year": 2018
      }
    }
  ],
  "links": {
    "self": "https://api.banco.com.br/open-banking/api/v2/resource",
    "first": "https://api.banco.com.br/open-banking/api/v2/resource",
    "prev": "https://api.banco.com.br/open-banking/api/v2/resource",
    "next": "https://api.banco.com.br/open-banking/api/v2/resource",
    "last": "https://api.banco.com.br/open-banking/api/v2/resource"
  },
  "meta": {
    "totalRecords": 1,
    "totalPages": 1,
    "requestDateTime": "2021-05-21T08:30:00Z"
  }
}