v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Pessoas

Cadastra uma pessoa.

🔒 Autenticação necessária

Esta API utiliza Bearer Token no header Authorization. Consulte o tutorial completo antes de fazer sua primeira chamada: Como autenticar nas APIs do CV CRM (v3+ — Bearer Token)

Cadastra uma nova pessoa no sistema. O documento (CPF ou CNPJ) deve ser único e válido. Telefone e celular recebem DDI +55 automaticamente caso não informado e possuam 10 ou 11 dígitos.

post/v3/cadastros/pessoas

Request body

nomestring required

Nome completo da pessoa.

codigointernostring

Código interno da pessoa no sistema legado.

documentostring required

CPF ou CNPJ da pessoa (somente dígitos).

documentoTipo'cpf' | 'cnpj' required

Tipo do documento. Valores aceitos: cpf, cnpj.

dataNascstring date

Data de nascimento (formato YYYY-MM-DD).

rgstring

RG da pessoa.

rgOrgaoEmissorstring

Órgão emissor do RG.

rgDataEmissaostring date

Data de emissão do RG (formato YYYY-MM-DD).

sexo'M' | 'F' | 'NDI' | 'A'

Gênero da pessoa. Valores aceitos: M - Masculino; F - Feminino; NDI - Não Desejo Informar; A - Ambos.

emailstring email required

E-mail para contato.

telefonestring required

Telefone para contato. DDI +55 é adicionado automaticamente para números com 10 ou 11 dígitos.

celularstring

Celular para contato. DDI +55 é adicionado automaticamente para números com 10 ou 11 dígitos.

rendaFamiliarnumber

Renda familiar mensal em R$.

estadoCivilinteger

Estado civil. Valores aceitos: 1 - Casado(a) comunhão parcial; 2 - Divorciado(a); 3 - Separado(a); 4 - Solteiro(a); 5 - Viúvo(a); 6 - Outro(s); 7 - União estável; 8 - Casado(a) comunhão total; 9 - Casado(a) separação total; 10 - Participação final nos aquestos; 11 - Separação obrigatória de bens.

dataCasamentostring date

Data de casamento (formato YYYY-MM-DD).

paisstring

País de residência. Aceita ID numérico, nome ou sigla ISO (ex: BR).

estadostring

Estado de residência. Aceita ID numérico, nome ou UF.

cidadestring

Cidade de residência. Aceita ID numérico ou nome.

logradourostring

Logradouro do endereço. Aceita ID numérico ou nome.

cepstring

CEP do endereço (8 dígitos).

enderecostring

Endereço de residência.

bairrostring

Bairro de residência.

numerostring

Número do endereço.

complementostring

Complemento do endereço.

naturalidadestring

Naturalidade da pessoa.

filiacaoPaistring

Nome do pai.

filiacaoMaestring

Nome da mãe.

profissaostring

Profissão da pessoa.

observacoesstring

Observações sobre a pessoa.

inscEstadualstring

Inscrição estadual (pessoas jurídicas).

inscMunicipalstring

Inscrição municipal (pessoas jurídicas).

ativoLoginboolean

Define se a pessoa pode realizar login no portal.

idclassificacaointeger

ID da classificação (ex: VIP).

dataPrimeiraHabilitacaoCnhstring date

Data da primeira habilitação CNH (formato YYYY-MM-DD).

dataFimValidadeCnhstring date

Data de validade da CNH (formato YYYY-MM-DD).

trabalhoNomeEmpresastring

Nome da empresa em que trabalha.

trabalhoCepstring

CEP da empresa.

trabalhoEnderecostring

Endereço da empresa.

trabalhoBairrostring

Bairro da empresa.

trabalhoNumerostring

Número do endereço da empresa.

complementoTrabalhostring

Complemento do endereço da empresa.

trabalhoEstadostring

Estado da empresa. Aceita ID numérico, nome ou UF.

trabalhoCidadestring

Cidade da empresa. Aceita ID numérico ou nome.

logradouroTrabalhostring

Logradouro da empresa. Aceita ID numérico ou nome.

trabalhoTelefonestring

Telefone da empresa.

Example request

{
  "nome": "Joselino Augusto dos Santos",
  "codigointerno": "CLI-001",
  "documento": "64239558811",
  "documentoTipo": "cpf",
  "dataNasc": "1990-06-15",
  "rg": "35129640",
  "rgOrgaoEmissor": "SSP-SE",
  "rgDataEmissao": "2010-05-03",
  "sexo": "M",
  "email": "joselino@email.com",
  "telefone": "79999999999",
  "celular": "79988888888",
  "rendaFamiliar": 5000,
  "estadoCivil": 4,
  "dataCasamento": "2018-08-11",
  "pais": "Brasil",
  "estado": "SE",
  "cidade": "Aracaju",
  "logradouro": "Rua",
  "cep": "49000000",
  "endereco": "Av. Adel Nunes",
  "bairro": "Farolândia",
  "numero": "959",
  "complemento": "Bloco H",
  "naturalidade": "Aracajuano",
  "filiacaoPai": "Pedro dos Santos",
  "filiacaoMae": "Maria dos Santos",
  "profissao": "Analista",
  "observacoes": "Cliente aguardando certidão de divórcio.",
  "inscEstadual": "123.987.283.874",
  "inscMunicipal": "657943-7",
  "ativoLogin": true,
  "idclassificacao": 3,
  "dataPrimeiraHabilitacaoCnh": "2010-05-03",
  "dataFimValidadeCnh": "2030-05-03",
  "trabalhoNomeEmpresa": "Construtor de Vendas",
  "trabalhoCep": "01310100",
  "trabalhoEndereco": "Av. Paulista",
  "trabalhoBairro": "Bela Vista",
  "trabalhoNumero": "1000",
  "complementoTrabalho": "10° andar",
  "trabalhoEstado": "SP",
  "trabalhoCidade": "São Paulo",
  "logradouroTrabalho": "Avenida",
  "trabalhoTelefone": "1133334444"
}

Response

Pessoa cadastrada com sucesso.

statusstring

codeinteger

Example response

{
  "status": "success",
  "code": 201,
  "data": {
    "id": 123
  }
}