v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Corretor

Cadastra corretor.

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

Essa integração coleta informações de requisições realizadas por sistemas legados e verifica se o dado inserido no campo documento ou idcorretor_int (identificador do sistema legado) existe ou não no Construtor de Vendas. Se já existir um corretor cadastrado com o mesmo documento ou identificador, essa API irá atualizar os dados solicitados na requisição, senão irá cadastrá-los. Obs: Para esta verificação, o documento CPF deve ser válido. Somente será aceito um cadastro por CPF.

post/cadastros/corretores

Headers

emailstring required

E-mail para autenticação do usuário em cadastro de corretor

Example:email@email.com

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

tokenstring required

Token para autenticação do usuário em cadastro de corretor

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de corretor.

Request body

idcorretor_intstring

Identificador do Corretor no sistema legado.

documentostring required

Documento CPF do Corretor.

nomestring required

Nome do Corretor.

sexostring required

Sexo do Corretor.

data_nascstring required

Data de nascimento do Corretor.

data_emissao_rgstring

Data de emissão do RG do Corretor.

ddi_telefonestring

DDI do Telefone do Corretor.

telefonestring required

Telefone do Corretor.

cepstring

CEP do corretor.

logradourostring

Logradouro do Endereço.

enderecostring

Endereço do Corretor.

bairrostring

Bairro do Corretor.

numerostring

Número do Endereço do Corretor.

complementostring

Complemento do Corretor.

cidadestring

Cidade do Corretor.

estadostring

Estado do Corretor.

crecistring required

CRECI do Corretor.

notificar_novos_leadsstring required

Informar o Aviso das notificações do Lead.

tipo_contastring

Tipo de Conta.

bancostring

Nome do banco.

nome_agenciastring

Nome da Agência.

numero_agenciastring

Número da Agência.

digito_agenciastring

Dígito da Agência.

numero_contastring

Número da Conta.

digito_contastring

Dígito da Conta.

cpf_favorecidostring

Documento do Favorecido da Conta.

nome_favorecidostring

Nome do Favorecido da Conta.

idimobiliaria_intstring

Identificador da imobiliária que o corretor é vinculado.

idimobiliariainteger

Identificador da imobiliária que o corretor é vinculado no CV.

emailstring required

E-mail do Corretor.

ativo_loginstring

Informa se poderá se relacionar com outras funcionalidades (S ou N).

removerstring

Identificador do corretor que deseja remover. Só informar caso queira remover.

Example request

{
  "idcorretor_int": "34437",
  "documento": "83158526042",
  "nome": "José Aberlado",
  "sexo": "M",
  "data_nasc": "1993-08-11",
  "data_emissao_rg": "2020-01-01",
  "ddi_telefone": "+55",
  "telefone": "79999995541",
  "cep": "49042-270",
  "logradouro": "Rua",
  "endereco": "Rua A-1",
  "bairro": "Atalaia",
  "numero": "12345",
  "complemento": "Próximo ao hospital",
  "cidade": "Aracaju",
  "estado": "SE",
  "creci": "123456",
  "notificar_novos_leads": "S",
  "tipo_conta": "C",
  "banco": "Banco XYZ",
  "nome_agencia": "Ag. teste",
  "numero_agencia": "25841",
  "digito_agencia": "1",
  "numero_conta": "87451",
  "digito_conta": "3",
  "cpf_favorecido": "31620513048",
  "nome_favorecido": "José Abelardo",
  "idimobiliaria_int": "5",
  "idimobiliaria": 5577,
  "email": "exemplo@email.com",
  "ativo_login": "S",
  "remover": "0"
}

Response

Cadastro de corretor realizado com sucesso.

codigostring

mensagemstring

Example response

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