Criar Cliente
POST /customer/create
HTTP
POST /customer/create HTTP/1.1
Host: {{URL}}
Content-Type: application/json
Accept: application/json
Authorization: Bearer {{token}}
Rota unica para criação de cliente.
O objeto endereco
não é obrigatório, caso não seja enviado, o cliente será criado sem endereço.
Atributos para criação de cliente
Campo | Tipo | Descrição | Obrigatório |
---|---|---|---|
nome_completo | string | Nome completo do cliente. | ✓ |
cpf | string | CPF do cliente, necessário ser um CPF válido. | ✓ |
data_nascimento | string | Data de nascimento do cliente, o formato deverá ser AAAA-MM-DD. | ✓ |
sexo | string | Sexo do cliente, valores válidos são "Masculino" ou "Feminino". | ✓ |
estado_civil | string | Estado civil do cliente, valores válidos são "Solteiro", "Casado", "Separado", "Divorciado" ou "Viúvo". | ✗ |
nacionalidade | string | País de origem do cliente, exemplo: "Brasil". | ✓ |
celular | string | Número de celular do cliente, o formato deverá ser (99) 99999-9999. | ✓ |
telefone_fixo | string | Número de telefone fixo do cliente, o formato deverá ser (99) 9999-9999. | ✗ |
string | Email do cliente, deve ser um email válido. | ✓ | |
profissao | string | Profissão do cliente. Exemplo: "Outros" | ✓ |
salario | number | Salário do cliente, o formato deverá ser o valor direto em formato de inteiro, exemplo: 165200 para R$1.652,00. Caso não tenha, pode ser enviado 0 | ✓ |
trabalhando | boolean | Flag para informar se o cliente está trabalhando ou não. | ✗ |
servidor_publico | boolean | Flag para informar se o cliente é servidor público ou não. | ✗ |
pep | boolean | Flag para informar se o cliente é uma pessoa politicamente exposta ou não. | ✗ |
afastado | boolean | Flag para informar se o cliente está afastado ou não. | ✗ |
medicamento | boolean | Flag para informar se o cliente está tomando algum medicamento ou não. | ✗ |
medicamento_descricao | string | Descrição dos medicamentos que o cliente está tomando, caso aplicável. | ✗ |
e_analfabeto | boolean | Flag para informar se o cliente é analfabeto ou não. | ✗ |
endereco | object | Este é o objeto referente aos dados de endereço do cliente. | ✓ |
endereco.cep | string | CEP do endereço do cliente, o formato deverá ser XXXXXXXX. | ✓ |
endereco.endereco | string | Endere ço do cliente, exemplo: "Rua A". | ✓ |
endereco.numero | number | Número do endereço do cliente, exemplo: 13. | ✓ |
endereco.bairro | string | Bairro do endereço do cliente, exemplo: "Veneza". | ✓ |
endereco.cidade | string | Cidade do endereço do cliente, exemplo: "Belo Horizonte". | ✓ |
endereco.estado | string | Estado do endereço do cliente, o formato deverá ser a abreviação do estado, exemplo: MG. | ✓ |
endereco.complemento | string | Complemento do endereço do cliente, exemplo: "Apto 101". | ✗ |
Requisição
Body
{
"cliente": {
"nome_completo": "Whitney Crist",
"cpf": "44346175678",
"data_nascimento": "1998-04-17T00:00:00.000Z",
"sexo": "Masculino",
"estado_civil": "Solteiro",
"nacionalidade": "Brasil",
"celular": "(31) 99714-6206",
"telefone_fixo": null,
"email": "Khalid20@example.net",
"profissao": "Vendedores Ambulantes de Produtos Não Comestíveis",
"salario": 141200,
"trabalhando": true,
"servidor_publico": false,
"pep": false,
"afastado": false,
"medicamento": false,
"medicamento_descricao": null,
"e_analfabeto": false
},
"endereco": {
"cep": "31810547",
"endereco": "Rua A",
"numero": 13,
"bairro": "Veneza",
"cidade": "Belo Horizonte",
"estado": "MG",
"complemento": null
}
}
Resposta
201
[
{
id: 4391036,
alterado_por: 'vendas.online@vileve.com.br',
criado_em: '2025-06-25T16:22:53.327Z',
alterado_em: '2025-06-25T16:22:53.327Z',
nome_completo: 'Lucas Mayer',
cpf: '65458423747',
data_nascimento: '1998-04-17',
celular: '(31) 99714-6206',
telefone_fixo: null,
email: 'Ryleigh7@example.org',
salario: 141200,
trabalhando: true,
servidor_publico: false,
pep: false,
afastado: false,
medicamento: false,
medicamento_descricao: null,
key_cliente: null,
status: 'NOVO',
e_analfabeto: false,
codigo_jave: null,
cargo_politico: null,
id_endereco: null,
ecommerce_customer_id: null,
},
];
Errors
Código | Referência | Explicação |
---|---|---|
400 | BAD REQUEST | O servidor não processará a solicitação devido a algo que é percebido como sendo um erro do cliente. Este é um erro genérico. |
401 | UNAUTHORIZED | O servidor não autorizou a requisição. Access Token inválido. |
403 | FORBIDDEN | O servidor não autorizou a requisição. O Access Token não possui permissão para acessar o recurso. |
404 | NOT FOUND | O servidor não encontrou o recurso ou não está disposto a divulgar sua existência. |
422 | UNPROCESSABLE ENTITY | O servidor não conseguiu processar as informações contidas na requisição. |