Sign in

v1

latestOpenAPI 3.0.02026-07-264636241.7 MB
Cliente

Cadastra cliente.

🔒 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.

post/v1/cadastros/clientes

Headers

emailstring required
Example:email@email.com

E-mail de autenticação para cadastro de cliente.

tokenstring required
Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de cliente.

Request body

idpessoa_intstring required

Identificador no sistema legado da pessoa a ser cadastrada.

nomestring required

Nome da pessoa.

documento_tipostring required

Tipo do documento (CPF ou CNPJ).

documentostring required

Documento da pessoa.

data_nascstring

Data de nascimento da pessoa.

rgstring

RG da pessoa.

rg_orgao_emissorstring

Órgão emissor do RG.

maestring

Nome da mãe da pessoa.

paistring

Nome do pai da pessoa.

cepstring

CEP do endereço da pessoa.

bairrostring

Bairro em que a pessoa reside.

numerostring

Número da residência da pessoa.

enderecostring

Endereço da pessoa.

complementostring

Complemento para o endereço da pessoa.

naturalidadestring

Naturalidade da pessoa.

cidadestring

Cidade em que a pessoa reside.

estadostring

UF do estado em que a pessoa reside.

sexostring

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

telefonestring required

Telefone para contato da pessoa.

ddi_telefonestring

DDI do telefone para contato da pessoa.

profissaostring

Profissão da pessoa.

emailstring required

E-mail para contato da pessoa.

celularstring

Celular para contato da pessoa.

ddi_celularstring

DDI do celular para contato da pessoa.

renda_familiarnumber

Renda mensal da família.

observacoesstring

Observações relevantes sobre a pessoa.

estado_civilinteger

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_casamentostring

Data de casamento (se for casado).

reconhecimento_firmastring

Assinatura, reconhecimento de firma.

paísstring

País de Nascimento.

idclassificacaointeger

Cliente VIP ou Não VIP.

rg_data_emissaostring

Data de emissão do RG informado.

data_primeira_habilitacao_cnhstring

Data da primeira CNH.

data_fim_validade_cnhstring

Data de validade CNH.

idlogradourostring

Logradouro do cliente.

tipo_residenciastring

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_aluguelnumber

Valor do aluguel (caso more de aluguel).

tempo_residenciainteger

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

referencia_nomestring

Nome da referência para contato.

referencia_telefonestring

Telefone da referência para contato.

ddi_referencia_telefonestring

DDI do telefone da referência para contato.

referencia_parentescostring

Parentesco da referência para contato.

possui_bemstring

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

quais_bensstring

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

situacao_do_bemstring

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

valor_do_bemnumber

Valor do bem informado.

valor_fgtsnumber

Valor do FGTS.

numero_pisstring

Número do PIS.

banco_nomestring

Nome do banco.

banco_agenciastring

Agência bancária.

banco_contastring

Conta bancária.

banco_nome_titularstring

Nome do titular da conta.

banco_tipo_docstring

Tipo de documento usado na conta do banco.

banco_cpf_titularstring

CPF do titular da conta (caso possua).

banco_cnpj_titularstring

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_observacoesstring

Observações relevantes.

trabalho_nome_empresastring

Nome da empresa em que o cliente trabalha.

trabalho_data_admissaostring

Data de admissão na empresa.

remuneracao_brutanumber

Remuneração bruta.

remuneracao_liquidanumber

Remuneração líquida.

trabalho_cepstring

CEP da empresa.

idlogradouro_trabalhostring

Logradouro da empresa.

trabalho_enderecostring

Endereço da empresa.

trabalho_bairrostring

Bairro da empresa.

trabalho_numerostring

Número do endereço da empresa.

complemento_trabalhostring

Complemento do endereço da empresa

trabalho_idestadostring

UF do estado da empresa.

trabalho_idcidadestring

Nome da cidade da empresa.

trabalho_telefonestring

Telefone de contato da empresa.

ddi_trabalho_telefonestring

DDI do telefone de contato da empresa.

trabalho_emailstring

E-mail de contato da empresa.

senhastring

Senha de acesso.

confirmastring

Confirmação da senha de acesso.

disponivelstring

Informa se a pessoa está ativa no painel.

politicamente_expostastring

Informe se a pessoa é politicamente exposta.

pretende_utilizar_fgtsstring

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

insc_estadualstring

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

insc_municipalstring

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

valor_faturamento_mensal_pjnumber

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

valor_lucro_liquido_mensal_pjnumber

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

valor_contas_receber_pjnumber

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

valor_estoque_pjnumber

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

valor_instalacoes_pjnumber

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

valor_moveis_pjnumber

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

valor_inicial_pjnumber

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

reservas_pjstring

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

concorrentes_diretos_pjstring

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

despesas_fixas_mensais_pjstring

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

predio_proprio_pjstring

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

valor_aluguel_mes_pjnumber

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

principais_clientes_pjstring

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

cnhstring

Informa o numero da CNH

cnh_orgao_emissorstring

Orgão Emissor

cnh_data_emissaostring

Informa da data de Emissão

passaportestring

Informa o numero do Passaporte

passaporte_orgao_emissorstring

Informa o orgão Emissor

passaporte_data_emissaostring

Data de emissão do passaporte

grau_instrucaostring

Informa o grau de Intrução

segmento_razaostring

Informa o Segmento/Ramo

tagsstring[]
remover_tagsstring[]

Example request

{
  "idpessoa_int": "9",
  "nome": "Joselino Augusto dos Santos",
  "documento_tipo": "cpf",
  "documento": "64239558811",
  "data_nasc": "2018-01-06",
  "rg": "35129640",
  "rg_orgao_emissor": "SSP-SE",
  "mae": "Maria dos Santos",
  "pai": "Pedro dos Santos",
  "cep": "49000000",
  "bairro": "Farolandia",
  "numero": "959",
  "endereco": "Av. Adel Nunes",
  "complemento": "Bloco H",
  "naturalidade": "Aracajuano",
  "cidade": "Aracaju",
  "estado": "SE",
  "sexo": "M",
  "telefone": "79999999999",
  "ddi_telefone": "+55",
  "profissao": "Analista",
  "email": "joselino@email.com",
  "celular": "79988888888",
  "ddi_celular": "+55",
  "renda_familiar": 750000,
  "observacoes": "Cliente divorciado a espera da certidão de divórcio, precisará alterar os dados futuramente",
  "estado_civil": 1,
  "data_casamento": "2018-08-11",
  "reconhecimento_firma": "Joselino Augusto",
  "país": "Brasil",
  "idclassificacao": 3,
  "rg_data_emissao": "2020-05-10",
  "data_primeira_habilitacao_cnh": "2020-05-10",
  "data_fim_validade_cnh": "2020-05-10",
  "idlogradouro": "Rua",
  "tipo_residencia": "ALU",
  "valor_aluguel": 1300,
  "tempo_residencia": 50,
  "referencia_nome": "Mária de Fátima",
  "referencia_telefone": "11988884444",
  "ddi_referencia_telefone": "+55",
  "referencia_parentesco": "Filha",
  "possui_bem": "S",
  "quais_bens": "Moto",
  "situacao_do_bem": "QU",
  "valor_do_bem": 17000,
  "valor_fgts": 50000,
  "numero_pis": "20769258963",
  "banco_nome": "NuBank",
  "banco_agencia": "001",
  "banco_conta": "54321",
  "banco_nome_titular": "Joselino Augusto",
  "banco_tipo_doc": "CPF",
  "banco_cpf_titular": "48563297702",
  "banco_cnpj_titular": "23192867000191",
  "banco_observacoes": "A conta receberá um upgrade para Platinum em breve.",
  "trabalho_nome_empresa": "Construtor de Vendas",
  "trabalho_data_admissao": "2020-10-08",
  "remuneracao_bruta": 4000,
  "remuneracao_liquida": 3800,
  "trabalho_cep": "08598363",
  "idlogradouro_trabalho": "Rua",
  "trabalho_endereco": "Alameda dos Anjos",
  "trabalho_bairro": "Luz",
  "trabalho_numero": "253",
  "complemento_trabalho": "10° andar",
  "trabalho_idestado": "SP",
  "trabalho_idcidade": "São Paulo",
  "trabalho_telefone": "11856398632",
  "ddi_trabalho_telefone": "+55",
  "trabalho_email": "exemplo@email.com",
  "senha": "012345678",
  "confirma": "012345678",
  "disponivel": "Ativo",
  "politicamente_exposta": "S",
  "pretende_utilizar_fgts": "S",
  "insc_estadual": "123.987.283.874",
  "insc_municipal": "657943-7",
  "valor_faturamento_mensal_pj": 50000,
  "valor_lucro_liquido_mensal_pj": 200000,
  "valor_contas_receber_pj": 14000,
  "valor_estoque_pj": 130000,
  "valor_instalacoes_pj": 970032,
  "valor_moveis_pj": 530400,
  "valor_inicial_pj": 1000000,
  "reservas_pj": "Exemplo de reservas",
  "concorrentes_diretos_pj": "Exemplo de concorrentes",
  "despesas_fixas_mensais_pj": "Exemplo de despesas fixas",
  "predio_proprio_pj": "N",
  "valor_aluguel_mes_pj": 2000,
  "principais_clientes_pj": "Exemplo de principais clientes",
  "cnh": "0002345678",
  "cnh_orgao_emissor": "SSP SE",
  "cnh_data_emissao": "2020-05-10",
  "passaporte": "004554565645",
  "passaporte_orgao_emissor": "SSP SE",
  "passaporte_data_emissao": "2020-05-10",
  "grau_instrucao": "Mestrado",
  "segmento_razao": "Segmento",
  "tags": [
    "Bom pagador",
    "Cliente Premium"
  ],
  "remover_tags": [
    "Bom pagador",
    "Cliente Premium"
  ]
}

Response

Cadastro de cliente realizado com sucesso.

codigostring
mensagemstring

Example response

{
  "codigo": "200",
  "mensagem": "Cliente cadastrado com sucesso."
}