Atualizar cadastro da pessoa

Esse endpoint permite uma atualização dos dados cadastrais de uma Pessoa.

Parâmetros da URL

• person_id: ID (uuid) da Pessoa cadastrada que terá os dados atualizados.

Parâmetros da Requisição

• name (string): O nome completo da pessoa.

• personType (string): O tipo da pessoa. Possíveis valores: NATURAL, LEGAL.

• documents (object): Objeto contendo as 'keys' das URLs 'pre-signed' dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress).

• idDocument (object): Objeto para detalhar o documento de identificação que esta sendo enviado.

  • issueDate (string, obrigatório): Data de emissão do documento.

  • issuer (string, obrigatório): Orgão responsável pela emissão do documento.

  • number (string, obrigatório): Número do documento.

  • type (string, obrigatório): Tipo do documento. Valores aceitos: CNH, PASSPORT, RG, RNE.

• birthDate (string): Data de nascimento no formato "AAAA-MM-DD".

• motherName (string): Nome da mãe.

• pep (boolean): Campo para indica se a pessoa é politicamente exposta.

• emailAddress (string): Endereço de e-mail para contato com a pessoa cadastrada.

• phone (object): Objeto contendo os dados do telefone de contato.

  • countryCode (string): Código do país.

  • areaCode (string): Código de área.

  • number (string): Número do telefone.

• address (object): Objeto contendo detalhes do endereço de cadastro.

  • streetNumber (string): Número do endereço informado.

  • streetName (string): Nome da rua.

  • postalCode (string): Código de CEP para o endereço.

  • district (string): Campo para informar o bairro.

  • city (string): Nome da cidade.

  • stateCode (string): Código da UF para o estado do endereço.

  • countryCode (string): Código do país.

  • extraInfo (string): Complemento do endereço.

• fundManagerId (string/uuid v4): ID do gestor do Fundo, se aplicável.

• fundSecuritizerId (string/uuid v4): ID da securitizadora do Fundo, se aplicável.

• fundAdministratorId (string/uuid v4): ID do Admnistrador do Fundo, se aplicável.

• representatives (object): Objeto contendo os detalhes dos representantes. Deve ser enviado quando o tipo da Pessoa for jurídica (LEGAL).

Objeto "representatives"

• role (string): O tipo do relacionamento. Valores aceitos: PARTNER, MANAGER, PROXY, OTHER, EMPLOYEE.

• taxpayerId (string): O número do documento CPF para identificação da Pessoa.

• fullName (string): Nome do representante.

• documents (object): Objeto contendo as 'keys' das URLs 'pre-signed' dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress).

• idDocument (object): Objeto para detalhar o documento de identificação que esta sendo enviado.

  • issueDate (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.

• birthDate (string): Data de nascimento no formato "AAAA-MM-DD".

• motherName (string): Nome da mãe.

• pep (boolean): Campo para indica se a pessoa é politicamente exposta.

• signContract (boolean): Indica se a pessoa é representante e pode assinar pela Empresa.

• emailAddress (string): Endereço de e-mail para contato com a pessoa cadastrada.

• phone (object): Objeto contendo os dados do telefone de contato.

  • countryCode (string): Código do país no formato "+99".

  • areaCode (string): Código de área.

  • number (string): Número do telefone.

• address (object): Objeto contendo detalhes do endereço de cadastro.

  • streetNumber (string): Número do endereço informado.

  • streetName (string): Nome da rua.

  • postalCode (string): Código de CEP para o endereço.

  • district (string): Campo para informar o bairro.

  • city (string): Nome da cidade.

  • stateCode (string): Código da UF para o estado do endereço.

  • countryCode (string): Código do país.

  • extraInfo (string): Complemento do endereço.

Resposta

A resposta da requisição será um JSON representando o retorno obtido para os campos enviados.

Em caso de sucesso será retornado um status_code "200-OK". Em caso de falha será retornado um código 40x com a mensagem indicativa do erro.

{
  "personType": "NATURAL",
  "name": "<string>",
  "emailAddress": "<email>",
  "phone": {
    "countryCode": "+87",
    "areaCode": "<string>",
    "number": "<string>"
  },
  "address": {
    "streetName": "<string>",
    "streetNumber": "<string>",
    "postalCode": "56087609",
    "district": "<string>",
    "city": "<string>",
    "stateCode": "<string>",
    "countryCode": "<string>",
    "extraInfo": "<string>"
  },
  "fundManagerId": "<uuid>",
  "fundSecuritizerId": "<uuid>",
  "fundAdministratorId": "<uuid>",
  "birthDate": "8941-17-40",
  "motherName": "<string>",
  "pep": "<boolean>",
  "idDocument": {
    "type": "CLASS_ID",
    "number": "<string>",
    "issuer": "<string>",
    "issueDate": "5663-53-43"
  },
  "documents": {
    "proofOfAddress": "<string>",
    "identification": "<string>"
  }
}