Criar uma pessoa do tipo "física"
Esse endpoint deve ser utilizado para cadastrar uma Pessoa do tipo física, usando um nº de CPF como identificador.
Parâmetros do Body
-
name (string, obrigatório): O nome completo da pessoa.
-
person_type (string, obrigatório): O tipo da pessoa, informar o valor como "NATURAL" para o cadastro de uma pessoa física. Possíveis valores: NATURAL, LEGAL.
-
taxpayer_id (string, obrigatório): O número do documento CPF para identificação da Pessoa.
-
documents (object, obrigatório): Objeto contendo as 'keys' das URLs 'pre-signed' dos documentos de identificação (documentIdentification) e comprovante de endereço (proofOfAddress).
-
id_document (object, obrigatório): 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.
-
-
birth_date (string, obrigatório): Data de nascimento da Pessoa a ser cadastrada no formato "AAAA-MM-DD".
-
mother_name (string, obrigatóri): Nome da mãe.
-
pep (boolean, obrigatório): Campo para indica se a pessoa é politicamente exposta.
-
email_address (string, obrigatório): Endereço de e-mail para contato com a pessoa cadastrada.
-
phone (object, obrigatório): 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, obrigatório): Objeto contendo detalhes do endereço de cadastro.
-
street_number (string): 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.
-
extra_info (string): Complemento do endereço.
-
-
fund_manager_id (string/uuid v4): ID do gestor do Fundo, se aplicável.
-
fund_securitizer_id (string/uuid v4): ID da securitizadora do Fundo, se aplicável.
-
fund_administrator_id (string/uuid v4): ID do Admnistrador do Fundo, se aplicável.
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.
- id (string/uuid v4): ID gerado para o cadastro realizado da Pessoa física.
Exemplo de JSON:
{
"id": ""
}
Request
- Base URLhttps://sandbox.platform.credit.celcoin.com.br
- URLhttps://sandbox.platform.credit.celcoin.com.br/escrow/api/persons
- Authnone declared
Headers
Request body
Example request
{
"taxpayer_id": "89399190099",
"birth_date": "1999-10-21",
"name": "(Obrigatório) Celcoin Sandbox",
"mother_name": "ana maria",
"email_address": "teste@teste.com",
"pep": false,
"phone": {
"country_code": "+55",
"area_code": "11",
"number": "970291614"
},
"address": {
"city": "São Paulo",
"country_code": "BRZ",
"district": "Parque Fongaro",
"state_code": "SP",
"street_name": "Rua Antônio Gomes Ferreira",
"postal_code": "04257100",
"street_number": "89",
"extra_info": "311A"
},
"documents": {
"proof_of_address": "58634c4d-b25c-4ebb-910a-b1bb36e62a80",
"document_identification": "58634c4d-b25c-4ebb-910a-b1bb36e62a80"
},
"representatives": [],
"person_type": "NATURAL",
"business_type": "OTHERS"
}Response
OK
Changes
No recorded changes to this operation across all 1 revision of this API.