Cadastra cliente.

post

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

🔒
Autenticação necessária
Esta API utiliza autenticação via e-mail e token nos headers da requisição.
Consulte o tutorial completo antes de fazer sua primeira chamada:
Como autenticar nas APIs do CV CRM (v1 — E-mail e Token)

Cliente é uma pessoa física ou jurídica que pode se tornar proprietário de uma unidade.
Essa integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo documento existe ou não no Construtor de Vendas. Se já existir uma pessoa cadastrada com o mesmo documento, essa API irá atualizar os dados solicitados na requisição, se não irá cadastrá-los.

Obs: Para esta verificação, o documento pode ser tanto CPF quanto CNPJ, ambos devem ser documentos válidos. Somente será aceito um cadastro por CPF e CNPJ.

Recent Requests

Time	Status	User Agent
Retrieving recent requests…

Loading…

Body Params

Requisição JSON para cadastro de um cliente.

Dados no formato JSON do cliente a ser cadastrado.

idpessoa_int

string

required

Identificador no sistema legado da pessoa a ser cadastrada.

nome

string

required

Nome da pessoa.

documento_tipo

string

required

Tipo do documento (CPF ou CNPJ).

documento

string

required

Documento da pessoa.

data_nasc

string

Data de nascimento da pessoa.

string

RG da pessoa.

rg_orgao_emissor

string

Órgão emissor do RG.

mae

string

Nome da mãe da pessoa.

pai

string

Nome do pai da pessoa.

cep

string

length ≤ 8

CEP do endereço da pessoa.

bairro

string

Bairro em que a pessoa reside.

numero

string

Número da residência da pessoa.

endereco

string

Endereço da pessoa.

complemento

string

Complemento para o endereço da pessoa.

naturalidade

string

Naturalidade da pessoa.

cidade

string

Cidade em que a pessoa reside.

estado

string

UF do estado em que a pessoa reside.

sexo

string

Identificação de gênero da pessoa. Valores aceitos: M - Masculino; F - Feminino; NDI - Não Desejo Informar.

telefone

string

required

length ≤ 15

Telefone para contato da pessoa.

ddi_telefone

string

DDI do telefone para contato da pessoa.

profissao

string

Profissão da pessoa.

string

required

E-mail para contato da pessoa.

celular

string

length ≤ 15

Celular para contato da pessoa.

ddi_celular

string

DDI do celular para contato da pessoa.

renda_familiar

number

Renda mensal da família.

observacoes

string

Observações relevantes sobre a pessoa.

estado_civil

integer

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

data_casamento

string

Data de casamento (se for casado).

reconhecimento_firma

string

Assinatura, reconhecimento de firma.

país

string

País de Nascimento.

idclassificacao

integer

Cliente VIP ou Não VIP.

rg_data_emissao

string

Data de emissão do RG informado.

data_primeira_habilitacao_cnh

string

Data da primeira CNH.

data_fim_validade_cnh

string

Data de validade CNH.

idlogradouro

string

Logradouro do cliente.

tipo_residencia

string

length ≤ 3

Tipo da residência que o cliente mora. Array de valores aceitos: PCF - Própria com financiamento; PCQ - Própria quitada; CF - Cedida/Funcional; ALU - Alugada; CP - Com parentes; OT - Outros.

valor_aluguel

number

Valor do aluguel (caso more de aluguel).

tempo_residencia

integer

Tempo que mora na residência (informar em meses).

referencia_nome

string

Nome da referência para contato.

referencia_telefone

string

length ≤ 15

Telefone da referência para contato.

ddi_referencia_telefone

string

DDI do telefone da referência para contato.

referencia_parentesco

string

Parentesco da referência para contato.

possui_bem

string

Informar se possui algum bem. S - Sim; N - Não.

quais_bens

string

Se sim, quais são os bens que possui.

situacao_do_bem

string

length ≤ 2

Situação dos bens informados. Valores aceitos: QU - Quitado; FI - Financiado.

valor_do_bem

number

Valor do bem informado.

valor_fgts

number

Valor do FGTS.

numero_pis

string

Número do PIS.

banco_nome

string

Nome do banco.

banco_agencia

string

Agência bancária.

banco_conta

string

Conta bancária.

banco_nome_titular

string

Nome do titular da conta.

banco_tipo_doc

string

length ≤ 4

Tipo de documento usado na conta do banco.

banco_cpf_titular

string

length ≤ 11

CPF do titular da conta (caso possua).

banco_cnpj_titular

string

length ≤ 14

CNPJ do titular da conta (caso possua). Não informar caso o tipo seja CPF, só informar se for CNPJ, o mesmo vale para o CPF.

banco_observacoes

string

Observações relevantes.

trabalho_nome_empresa

string

Nome da empresa em que o cliente trabalha.

trabalho_data_admissao

string

Data de admissão na empresa.

remuneracao_bruta

number

Remuneração bruta.

remuneracao_liquida

number

Remuneração líquida.

trabalho_cep

string

length ≤ 8

CEP da empresa.

idlogradouro_trabalho

string

Logradouro da empresa.

trabalho_endereco

string

Endereço da empresa.

trabalho_bairro

string

Bairro da empresa.

trabalho_numero

string

Número do endereço da empresa.

complemento_trabalho

string

Complemento do endereço da empresa

trabalho_idestado

string

UF do estado da empresa.

trabalho_idcidade

string

Nome da cidade da empresa.

trabalho_telefone

string

length ≤ 15

Telefone de contato da empresa.

ddi_trabalho_telefone

string

DDI do telefone de contato da empresa.

trabalho_email

string

E-mail de contato da empresa.

senha

string

Senha de acesso.

confirma

string

Confirmação da senha de acesso.

disponivel

string

Informa se a pessoa está ativa no painel.

politicamente_exposta

string

Informe se a pessoa é politicamente exposta.

pretende_utilizar_fgts

string

Informa se pretende utilizar o FGTS. S - Sim; N - Não.

insc_estadual

string

Informa a inscrição estadual (apenas para pessoas jurídicas).

insc_municipal

string

Informa a inscrição municipal (apenas para pessoas jurídicas).

valor_faturamento_mensal_pj

number

Informa o valor de faturamento mensal em R$ (apenas para pessoas jurídicas).

valor_lucro_liquido_mensal_pj

number

Informa o valor do lucro líquido mensal em R$ (apenas para pessoas jurídicas).

valor_contas_receber_pj

number

Informa o valor de contas à receber em R$ (apenas para pessoas jurídicas).

valor_estoque_pj

number

Informa o valor do estoque em R$ (apenas para pessoas jurídicas).

valor_instalacoes_pj

number

Informa o valor das instalações em R$ (apenas para pessoas jurídicas).

valor_moveis_pj

number

Informa o valor dos móveis em R$ (apenas para pessoas jurídicas).

valor_inicial_pj

number

Informa o valor do capital inicial em R$ (apenas para pessoas jurídicas).

reservas_pj

string

Informa as reservas (apenas para pessoas jurídicas).

concorrentes_diretos_pj

string

Informa os concorrentes diretos na praça (apenas para pessoas jurídicas).

despesas_fixas_mensais_pj

string

Informa as despesas fixas mensais (apenas para pessoas jurídicas).

predio_proprio_pj

string

Informa se é prédio próprio S ou N (apenas para pessoas jurídicas).

valor_aluguel_mes_pj

number

Informa o valor do aluguel/mês em R$ (apenas para pessoas jurídicas).

principais_clientes_pj

string

Informa os principais clientes (apenas para pessoas jurídicas).

cnh

string

Informa o numero da CNH

cnh_orgao_emissor

string

Orgão Emissor

cnh_data_emissao

string

Informa da data de Emissão

passaporte

string

Informa o numero do Passaporte

passaporte_orgao_emissor

string

Informa o orgão Emissor

passaporte_data_emissao

string

Data de emissão do passaporte

grau_instrucao

string

Informa o grau de Intrução

segmento_razao

string

Informa o Segmento/Ramo

200Cadastro de cliente realizado com sucesso.

400Requisição de cadastro de cliente inválida!