Borrower Auto Offer

Esta seção descreve as propriedades do objeto Borrower para o simulador de ofertas, que representa os dados pessoais de quem solicita o empréstimo.\


Recomendações importantes Autorização Bacen e WhatsappOption

Veja as recomendações referente ao envio das informações de Autoriação Bacen (bacenAuthorization):



Informações sobre os campos do payload


Request Body

Campo

Tipo

Obrigatório

Descrição

cpf

string

Sim

CPF do cliente sem formatação

email

string

Sim

Email do cliente

cellphoneCode

string

Sim

Código de área com 2 dígitos

cellphone

string

Sim

Número de celular do cliente

birthDate

date (YYYY-MM-DD)

Sim

Data de nascimento do cliente, o cliente precisa ter no minimo 18 anos e máximo 74 anos.

postalCode

string

Sim

CEP do cliente

monthlyIncome

double

Sim

Renda mensal do cliente (sem aspas, em reais)

professionalStatus

string

Sim

Situação profissional do cliente.

Consulte as informações profissionais

timeOfEmployment

string

Sim

Tempo de trabalho.

Para atividades profissionais SELF_EMPLOYED (Autônomo) ou FREELANCER (Profissional Liberal), o campo timeOfEmployment é obrigatório.

Consulte as informações profissionais

bacenAuthorization

object

Sim

Objeto utilizado para criação do payload de autorização do Bacen. Consulte as informações do objeto aqui


Exemplo do objeto JSON

{
  "borrower": {
        "cpf": 12345678900,
        "email": "[email protected]",
        "cellphoneCode": "31",
        "cellphone": "999999999",
        "birthDate": "1991-01-29",
        "postalCode": "91770552",
        "monthlyIncome": 12345.6,
        "professionalStatus": "SELF_EMPLOYED",
        "timeOfEmployment": "BETWEEN_TWO_AND_THREE_YEARS",
        "bacenAuthorization": {
          "authorizationTerms": "Eu autorizo ...",
          "bacenAuthorizedAt": "2023-11-13 15:44:00",
          "userAgent": "Firefox",
          "userIp": "169.658.56.98"
        }
    }
}