v1

latestOpenAPI 3.0.02026-07-264636241.7 MB

Corretor

Cadastra corretor PJ.

🔒 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 CNPJ deve ser válido. Somente será aceito um cadastro por CNPJ.

post/cadastros/corretores/pessoa-juridica

Headers

emailstring required

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

Example:email@email.com

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

tokenstring required

Token para autenticação do usuário em cadastro de corretor pessoa jurídica

Example:79d965e5027b7423423f2471824e799949c75f9ce

Token de autenticação para cadastro de corretor PJ.

Request body

idcorretor_intstring

Identificador do Corretor PJ no sistema legado.

documentostring required

Documento CNPJ do Corretor.

razao_socialstring required

Razão social do Corretor.

nome_fantasiastring required

Nome fantasia do Corretor.

data_nascstring required

Data de registro.

inscricao_estadualstring

Inscrição Estadual do Corretor PJ.

representante_nomestring

Nome representante do Corretor.

representante_ddi_telefonestring

DDI do Telefone do representante.

representante_telefonestring required

Telefone do representante.

representante_emailstring required

E-mail do representante.

representante_documentostring

Documento do representante.

cepstring

CEP do corretor PJ.

logradourostring

Logradouro do Endereço do corretor PJ.

enderecostring

Endereço do corretor PJ.

bairrostring

Bairro do corretor PJ.

numerostring

Número do Endereço do corretor PJ.

complementostring

Complemento do corretor PJ.

estadostring

Estado do corretor PJ.

cidadestring

Cidade do corretor PJ.

emailstring required

E-mail do corretor PJ.

idimobiliaria_intstring

Identificador da imobiliária que o corretor PJ é vinculado no sistema legado.

idimobiliariainteger

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

notificar_novos_leadsstring required

Informar o Aviso das notificações do Lead para corretor PJ.

receber_email_leads_a_vencerstring required

Informar o Recebimento de e-mail dos leads à vencer.

crecistring required

CRECI do Corretor PJ.

tipo_contastring

Tipo de Conta do Corretor PJ.

bancostring

Nome do banco do Corretor PJ.

nome_agenciastring

Nome da Agência do Corretor PJ.

numero_agenciastring

Número da Agência do Corretor PJ.

digito_agenciastring

Dígito da Agência do Corretor PJ.

numero_contastring

Número da Conta do Corretor PJ.

digito_contastring

Dígito da Conta do Corretor PJ.

ativo_loginstring

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

Example request

{
  "idcorretor_int": "34437",
  "documento": "56015306000176",
  "razao_social": "Corretor MCM",
  "nome_fantasia": "MCM corretor",
  "data_nasc": "1993-08-11",
  "inscricao_estadual": "74952482-0",
  "representante_nome": "Teste representante",
  "representante_ddi_telefone": "+55",
  "representante_telefone": "79999995541",
  "representante_email": "exemplo@email.com",
  "representante_documento": "31620513048",
  "cep": "49042-270",
  "logradouro": "Rua",
  "endereco": "Rua A-1",
  "bairro": "Atalaia",
  "numero": "12345",
  "complemento": "Próximo ao hospital",
  "estado": "São Cristóvão",
  "cidade": "SE",
  "email": "exemplo@email.com",
  "idimobiliaria_int": "5",
  "idimobiliaria": 5570,
  "notificar_novos_leads": "S",
  "receber_email_leads_a_vencer": "S",
  "creci": "123456",
  "tipo_conta": "C",
  "banco": "Banco XYZ",
  "nome_agencia": "Ag. teste",
  "numero_agencia": "25841",
  "digito_agencia": "1",
  "numero_conta": "87451",
  "digito_conta": "3",
  "ativo_login": "S"
}

Response

Cadastro de corretor PJ realizado com sucesso.

codigostring

mensagemstring

Example response

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