Cadastra uma pessoa.

post

https://{dominiodocliente}.cvcrm.com.br/api/v1/v3/cadastros/pessoas

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.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Dados da pessoa a ser cadastrada.

nome

string

required

Nome completo da pessoa.

codigointerno

string

Código interno da pessoa no sistema legado.

documento

string

required

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

documentoTipo

string

enum

required

Tipo do documento. Valores aceitos: cpf, cnpj.

Allowed:

dataNasc

date

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

string

RG da pessoa.

rgOrgaoEmissor

string

Órgão emissor do RG.

rgDataEmissao

date

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

sexo

string

enum

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

Allowed:

string

required

E-mail para contato.

telefone

string

required

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

celular

string

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

rendaFamiliar

number

Renda familiar mensal em R$.

estadoCivil

integer

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.

dataCasamento

date

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

pais

string

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

estado

string

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

cidade

string

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

logradouro

string

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

cep

string

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

endereco

string

Endereço de residência.

bairro

string

Bairro de residência.

numero

string

Número do endereço.

complemento

string

Complemento do endereço.

naturalidade

string

Naturalidade da pessoa.

filiacaoPai

string

Nome do pai.

filiacaoMae

string

Nome da mãe.

profissao

string

Profissão da pessoa.

observacoes

string

Observações sobre a pessoa.

inscEstadual

string

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

inscMunicipal

string

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

ativoLogin

boolean

Define se a pessoa pode realizar login no portal.

idclassificacao

integer

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

dataPrimeiraHabilitacaoCnh

date

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

dataFimValidadeCnh

date

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

trabalhoNomeEmpresa

string

Nome da empresa em que trabalha.

trabalhoCep

string

CEP da empresa.

trabalhoEndereco

string

Endereço da empresa.

trabalhoBairro

string

Bairro da empresa.

trabalhoNumero

string

Número do endereço da empresa.

complementoTrabalho

string

Complemento do endereço da empresa.

trabalhoEstado

string

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

trabalhoCidade

string

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

logradouroTrabalho

string

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

trabalhoTelefone

string

Telefone da empresa.

Responses

201Pessoa cadastrada com sucesso.

400Dados inválidos ou documento já cadastrado.

500Erro inesperado.