Documentação B2B

Borrower — Proposal

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

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

Para criar uma proposta na Creditas, é necessário a autorização do cliente para consulta ao Bacen (authorizationTerms). Sem essa autorização, o cliente não avança na esteira. Já o opt-in do Whatsapp (optIns) é necessário para que consigamos enviar comunicações sobre o processo diretamente no telefone do cliente, o que facilita a negociação e agiliza a esteira de contratação.

Por isso, recomendamos que ambas as autorizações sejam enviadas no header da requisição.


2. Implementação Técnica

2.1. 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

E-mail 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

authorizationTerms

string

Sim

Texto de aceite para consultas ao BACEN. Consulte as instruções do que precisa ser enviado nas propriedades do objeto Autorização Bacen.

optIns

boolean

Sim

Informação de consentimento do usuário sobre as comunicações via Whatsapp, e-mail, e SMS. Consulte aqui as propriedades desse objeto de optIn.


2.2. Exemplo do objeto JSON

{
  "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",
        "authorizationTerms": "Eu autorizo...",
        "optIns": {
          "whatsApp": true
        }
    }
}