Consultar pessoas cadastradas

Este endpoint permite a consulta de uma lista de pessoas associadas ao Originador, facilitando a integração de sistemas para acesso e manipulação de dados relacionados.

Parâmetros da Requisição

Não é necessário o envio de nenhum dado no corpo da requisição.

Resposta

A resposta para a requisição é um JSON no seguinte formato:

{
    "content": {
      "type": "array",
      "items": {}
    },
    "total_pages": {
      "type": "integer"
    },
    "total_elements": {
      "type": "integer"
    },
    "has_next": {
      "type": "boolean"
    }
  }
}

Campos da resposta:

• content: Um objeto contendo uma lista das pessoas cadastradas para o Originador. Dependendo da quantidade de registros esse objeto será retornado paginado.
  
• total_pages: O número total de páginas retornadas para a consulta executada.
  
• total_elements: O número total de registros retornados.
  
• has_next: Campo do tipo "boolean" para indicar se tem mais páginas a serem consultadas.
  

Objeto "content" (lista de Pessoas)

• id (string/uuid): ID do item "pessoa".
  
• full_name (string): O nome completo da pessoa.
  
• taxpayer_id (string): O número do documento CPF para identificação da Pessoa.
  
• id_document (object): Objeto para detalhar o documento de identificação que está sendo enviado.
  • issue_date (string): Data de emissão do documento.
    
  • issuer (string): Orgão responsável pela emissão do documento.
    
  • number (string): Número do documento.
    
  • type (string): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE.
    
• sex (string): Gênero da pessoa, referente as características anatômicas. Valores aceitos: FEMALE, MALE, OTHER.
  
• nationality (string): A nacionalidade da pessoa cadastrada.
  
• birth_date (string): Data de nascimento no formato "AAAA-MM-DD".
  
• occupation (string): Cargo ou principal ocupação de trabalho.
  
• marital_status (string): Estado cívil no âmbito legal. Valores aceitos: DIVORCED, MARRIED, OTHER, SEPARATED, SINGLE, WIDOWED
  
• marital_property_system (string): O tipo de comunhão de bens adotado para o casamento. Valores aceitos: FINAL_COMMUNION, FULL_COMMUNION, NO_COMMUNION, PARTIAL_COMMUNION
  
• pep (boolean): Campo para indica se a pessoa é politicamente exposta.
  
• email_address (string): Endereço de e-mail para contato com a pessoa cadastrada.
  
• phone (object): Objeto contendo os dados do telefone de contato.
  • country_code (string): Código do país.
    
  • area_code (string): Código de área.
    
  • number (string): Número do telefone.
    
• address (object): Objeto contendo detalhes do endereço de cadastro.
  • street_number (int): Número do endereço informado.
    
  • street_name (string): Nome da rua.
    
  • postal_code (string): Código de CEP para o endereço.
    
  • district (string): Campo para informar o bairro.
    
  • city (string): Nome da cidade.
    
  • state_code (string): Código da UF para o estado do endereço.
    
  • country_code (string): Código do país.
    
• external_bank_account (object): Objeto contendo os dados bancários para depósito.
  • bank_code (string): Código do banco.
    
  • bank_account (string): Número da conta
    
  • bank_account_digit (string): Dígito do número da conta.
    
  • bank_branch (string): Número da agência.
    
  • bank_account_type (string): Tipo da conta bancária.
    
  • ispb_code (string): Código ISPB relacionado ao banco da conta informada.
    
• pix (object): Objeto contendo os dados de uma chave PIX.
  • key (string): Chave PIX.
    
  • key_type (string): Tipo da chave PIX. Valores aceitos: ALEATORY_KEY, EMAIL, PHONE_NUMBER, TAXPAYER_ID
    
• spouse_full_name (string): Nome do cônjuge.
  
• originator (object): Objeto contendo os dados do Originador.
  • id (string/UUID): ID de cadastro do Originador.
    
  • legal_name (string): Nome/Razão Social do Originador.
    
• created_at (datetime): Data/Hora do cadastro no formato ISO 8601. Ex.: 2024-06-05T10:34:08.957Z.
  
• spouse_taxpayer_id (string): Documento de identificação do cônjuge.
  
• spouse_date_of_birth (string): Data de nascimento do cônjuge.
  
• birthplace (string): Naturalidade, local de nascimento.
  
• monthly_income (float): Renda mensal estimada.
  
• employer (string): Area de atuação.