O lead contém os dados básicos de um cliente para realização de simulações e pré-análise nos bancos. Se desejar, você pode visitar o passo a passo de como criar uma simulação na nossa documentação. O texto descreve o processo da criação de um lead.

Se não existir o lead desejado com associação a loja informada, ele pode ser criado conforme descrito nesse manual.

Nas requisições dos leads, é necessário adicionar o header Store-Id com o ID da loja utilizada.

📘
Dados obrigatórios do lead
Devido ao fato de cada banco possuir seus próprios critérios de análise, a obrigatoriedade dos dados do lead varia de banco para banco.
Sendo assim, recomenda-se a leitura do documento campos obrigatórios por banco no cadastro do lead, para identificar as informações exigidas por cada banco no processo de simulação.

📘
Campos de nome atípico no corpo da requisição
É importante observar que existem 3 campos do lead que precisam ser informados com nomes diferentes no corpo da requisição. Os campos são:

gender (Gênero);

occupation (Ocupação);

profession (Profissão);

No corpo da requisição, essas informações são enviadas nos respectivos campos:

retrieve_gender;

retrieve_occupation;

retrieve_profession;

🚧
Domínio dos campos retrieve_gender, retrieve_occupation e retrieve_profession
Os campos:

retrieve_gender (domínio: gender)

retrieve_occupation (domínio: occupation)

retrieve_profession (domínio: profession)

Devem ser preenchidos com um credere_identifier existente no respectivo domínio. Todos os domínios do lead podem ser obtidos na listagem de domínios do lead.

Exemplo de corpo da requisição

{
  "lead": {
    "address": {
      "city": "Natal",
      "complement": "Edif Corporate Tower Edif Center-Trade",
      "district": "Lagoa Nova",
      "number": "3700, Sala 409 Bloco A",
      "state": "RN",
      "street": "Av Amintas Barros",
      "zip_code": "59075-810"
    },
    "cpf_cnpj": "000.000.000-00",
    "name": "Client name",
    "birthdate": "1970-01-01",
    "phone_number": "(84) 90000-0000",
    "email": "cliente@email.com",
    "retrieve_gender": "F",
    "retrieve_occupation": "11",
    "retrieve_profession": "administrador",
    "monthly_income": 900000,
    "has_cnh": true
  }
}

200200

400400