Borrower — Proposal

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

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.

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
`jobTitle`	string	Não	Profissão do cliente. Caso queira informar, consulte as informações profissionais
`timeOfEmployment`	string	Não	Tempo de trabalho. Caso queira informar, 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.
`addressNumber`	string	Não	Número do endereço do cliente
`addressComplement`	string	Não	Complemento do endereço do cliente
`bankDetails`	object	Não	Dados bancários do borrower para propostas de auto. Consulte o objeto do bankDetails

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",
        "jobTitle": "Açougueiro(a)",
        "timeOfEmployment": "BETWEEN_TWO_AND_THREE_YEARS",
        "authorizationTerms": "Eu autorizo...",
        "addressNumber": "123",
        "addressComplement": "APTO 1",
        "optIns": {
            "whatsApp": true
        }
    }
}

Veja também Borrower - Offer