Borrower Home

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

Campo

Tipo

Obrigatório

Descrição

cpf

string

Sim

CPF do cliente sem formatação

fullName

string

Sim

Nome completo do cliente

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

monthlyIncome

double

Sim

Renda mensal do cliente (sem aspas, em reais)

maritalStatus

string

Sim

Estado civil

nationality

string

Sim

Nacionalidade

optIns

object

Sim

Whatsapp Option

Consulte as optins

stableUnion

boolean

Sim

É uma união estável

authorizationTerms

string

Sim

Texto utilizado como aceite para consultas ao BACEN.

professionalInfo

object

Sim

Dados profissionais do borrower
Consulte o objeto do professionalInfo

residence

object

Não

Dados sobre endereço do borrower

Preencher apenas se não residir no collateral

Consulte o objeto do residence

spouse

object

Não

Caso queira informar, consulte o objeto do spouse


Relação de estados civis

Estado civilDescrição
SINGLESolteiro
MARRIEDCasado
DIVORCEDDivorciado
SEPARATEDSeparado
WIDOWERViúvo

Exemplo do objeto JSON

{
  "borrower": {
    "cpf": "08853500666",
    "fullName": "Lucas Ramos",
    "email": "[email protected]",
    "birthDate": "1990-10-10",
    "cellphone": "234567898",
    "cellphoneCode": "11",
    "maritalStatus": "MARRIED",
    "stableUnion": true,
    "optIns": {
      "email": false,
      "whatsApp": false,
      "sms": false
    },
    "authorizationTerms": "O cliente autorizou a consulta de informações a seu respeito mantidas no Sistema de Informações (SCR) organizado pelo Banco Central do Brasil.",
    "nationality": "Brasil",
    "professionalInfo": {
      "professionalStatus": "CLT",
      "monthlyIncome": 100000,
      "description": "Descricao",
      "jobTitle": "Adestrador(a)",
      "startedAt": "2020-10-01"
    },
    "spouse": {
      "fullName": "Joseane Campos",
      "email": "[email protected]",
      "birthDate": "1990-10-10",
      "cellphone": "345678987",
      "cellphoneCode": "12",
      "cpf": "48313729007",
      "nationality": "Brasil",
      "isCosigner": true,
      "professionalInfo": {
        "professionalStatus": "CLT",
        "monthlyIncome": 100000,
        "description": "Descricao",
        "jobTitle": "Adestrador(a)",
        "startedAt": "2020-10-01"
      }
    },
    "residence":{
      "address":"Avenida Leonardo da Vinci",
      "number":"123",
      "city":"São Paulo",
      "complement": "Casa",
      "state":"SP",
      "neighborhood":"Vila Guarani (Z Sul)",
      "postalCode":"04313001",
      "country":"BR"
    }
  }
}