Esta seção descreve as propriedades do objeto Borrower, 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 (authorizationTerms) e WhatsappOption (optIns):



Informações sobre os campos do payload


Request Body

CampoTipoObrigatórioDescrição
cpfstring SimCPF do cliente sem formatação
fullNamestringSimNome completo do cliente
emailstringSimEmail do cliente
cellphoneCodestringSimCódigo de área com 2 dígitos
cellphonestringSimNúmero de celular do cliente
birthDatedate (YYYY-MM-DD)SimData de nascimento do cliente, o cliente precisa ter no minimo 18 anos e máximo 74 anos.
postalCodestringSimCEP do cliente
monthlyIncomedouble SimRenda mensal do cliente (sem aspas, em reais)
professionalStatusstringSimSituação profissional do cliente.

Consulte as informações profissionais
jobTitlestringNãoProfissão do cliente.

Caso queira informar, consulte as informações profissionais
timeOfEmploymentstringNãoTempo de trabalho.

Caso queira informar, consulte as informações profissionais
authorizationTermsstringSimTexto utilizado como aceite para consultas ao BACEN.
bankDetailsobject NãoDados bancários do borrower para propostas de auto.
Consulte o objeto do bankDetails

Exemplo do payload

{
  "borrower": {
        "cpf": 12345678900,
        "fullName": "Lead Complete Name",
        "email": "[email protected]",
        "cellphoneCode": "31",
        "cellphone": "999999999",
        "birthDate": "1991-01-29",
        "postalCode": "91770552",
        "monthlyIncome": 12345.6,
        "professionalStatus": "SELF_EMPLOYED",
        "jobTitle": "Açougueiro(a)",
        "timeOfEmployment": "BETWEEN_TWO_AND_THREE_YEARS",
        "authorizationTerms": "Eu autorizo...",
        "optIns": {
          "whatsApp": true
        }
    }
}