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):

Veja as novas opções para enviar dados bancários para propostas de auto no Borrower



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
monthlyIncomedouble SimRenda mensal do cliente (sem aspas, em reais)
maritalStatusstringSimEstado civil
nationalitystringSimNacionalidade
optInsobjectSimWhatsapp Option

Consulte as optins
stableUnionbooleanSimÉ uma união estável
authorizationTermsstringSimTexto utilizado como aceite para consultas ao BACEN.
professionalInfoobject SimDados profissionais do borrower
Consulte o objeto do professionalInfo
residenceobjectNãoDados sobre endereço do borrower

Preencher apenas se não residir no collateral

Consulte o objeto do residence
spouseobjectNãoDados do cônjuge para
Obrigatório se stableUnion for true ou maritalStatus igual a MARRIED
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"
    }
  }
}