v1

latestOpenAPI 3.0.12026-07-245303882.5 MB

Customers | Dados

Obtém os registros de identificação da pessoa natural

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

PERMISSÃO NECESSÁRIA: CUSTOMERS_PERSONAL_IDENTIFICATIONS_READ

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

Query parameters

pageinteger

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

page-sizeinteger

Quantidade total de registros por páginas

Response

Dados sobre identificação pessoa física obtidos com sucesso

Example response

{
  "data": [
    {
      "updateDateTime": "2021-05-21T08:30:00Z",
      "personalId": "578-psd-71md6971kjh-2d414",
      "brandName": "Organização A",
      "civilName": "Juan Kaique Cláudio Fernandes",
      "socialName": "Jaqueline de Freitas",
      "birthDate": "1989-03-23",
      "maritalStatusCode": "SOLTEIRO",
      "sex": "FEMININO",
      "companiesCnpj": [
        "01773247000103"
      ],
      "documents": {
        "cpfNumber": "25872252137"
      },
      "hasBrazilianNationality": true
    }
  ],
  "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"
  }
}