Documentação B2B

Borrower — Offer

Esta seção descreve as propriedades do objeto borrower para a geração da Simulação Assertiva. Os campos solicitados neste objeto são referentes às informações pessoais de quem solicita o empréstimo.

❗️
  • Este objeto não é o mesmo que será usado posteriormente (Borrower — Proposals).
  • Neste objeto, especificamente, os dados do solicitante para o empréstimo são reduzidos para que possamos criar uma Simulação Assertiva (oferta) com a menor quantidade de dados possíveis.

Request Body

Campo

Tipo

Obrigatório

Descrição

cpf

string

Sim

CPF do cliente sem formatação

birthDate

date (YYYY-MM-DD)

Sim

Data de nascimento do cliente

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 opções válidas em informações profissionais

cellphoneCode

string

Não

Código de área com 2 dígitos

cellphone

string

Não

Número de celular do cliente

email

string

Não

E-mail do cliente

bacenAuthorization

object

Não

Autorização fornecida pelo cliente para realização da consulta Bacen. Consulte as propriedades desse objeto Autorização Bacen


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"
        }
    }
}