Criação da proposta com garantia

As solicitações de empréstimo com imóvel em garantia, incluem dados básicos da pessoa solicitante, do imóvel dado como garantia, e dados da proposta em si, como prazo e valor solicitados.

Essa seção descreve a criação e manipulação das solicitações de refinanciamento.


Como enviar uma solicitação de empréstimo

As informações enviadas devem seguir o request headers e request body a seguir:

Request HTTP POST

Tipo de Requisição

URL

Exemplo

POST

{{url_base}}/proposals

https://api.stg.creditas.io/b2b/proposals

Request Headers

Necessário utilizar o header com token de autenticação. Consulte como funciona a autenticação Creditas.

Campo

Tipo

Obrigatório

Descrição

productType

string

Sim

HOME_REFI

purpose

string

Sim

Motivos para solicitação de empréstimo.
Consulte os motivos de empréstimo.

borrower

object

Sim

Dados pessoais do solicitante do empréstimo.
Consulte o objeto do borrower

intendedCredit

object

Sim

Informações sobre a proposta de empréstimo.
Consulte o objeto do intendedCredit

conditions

object

Sim

Condições de parcelamento do empréstimo.
Consulte o objeto do conditions

collateral

object

Sim

Dados da garantia do solicitante do empréstimo.
Consulte o objeto do collateral

Request Response

Campo

Tipo

Descrição

id

string

Id da proposta

legacyId

string

Id

productType

string

Produto referente a proposta enviada


Exemplo de Request e Response

curl --location --request POST '{{url_base}}/proposals' \
--header 'Accept: application/vnd.creditas.v1+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--header 'Authorization: Bearer {{access_token}}' \
--data-raw '{
   "productType": "HOME_REFI",
   "purpose": "INVESTMENT_IN_OWN_BUSINESS",
   "borrower": {
        "fullName": "John Doe",
        "email": "[email protected]",
        "birthDate": "1978-01-29",
        "cellphone": "99991234",
        "cellphoneCode": "11",
        "monthlyIncome": 12345.6,
        "professionalStatus": "SELF_EMPLOYED",
        "postalCode": "91770552",
        "cpf": "73005848027",
        "optIns": {
            "email": false,
            "WhatsApp": false,
            "sms": false
        }
   },
   "intendedCredit": {
            "currency": "BRL",
        "amount": 10000.0
   },
   "conditions": {
        "installment": {
            "term": 48
        }
   },
   "collateral": {
        "value": 20000,
        "debt": 0,
        "address": "Av. Paulista",
        "number": 1,
        "complement": "",
        "neighborhood": "Bela Vista",
        "city": "São Paulo",
        "state": "SP",
        "country": "BR",
        "postalCode": "00000000",
        "hasDeed": "NO",
        "realEstateType": "HOUSE"
   }
}
HTTP/1.1 201 OK
Content-Type: application/json; charset=UTF-8
Accept-Version: v1

{
    "id": "B2B-DBC79D7F-E5D7-45B9-B9DD-A60C2561EA06",
    "legacyId": "68e7e502-2e71-4c4c-a868-9c8c438fe19d",
    "productType": "HOME_REFI"
}



Possíveis Erros

Código

Mensagem

Descrição

422

Validation errors in your request

Há erros em um ou mais campos da sua request.

409

Duplicated lead

O lead enviado já possui cadastro na Creditas (usando o mesmo email ou CPF fornecido).

Exemplo de retorno com erro de validação (422)

{
  "code": "UNPROCESSABLE_ENTITY",
  "message": "Validation Error",
  "details": [
    {
      "code": "is missing",
      "target": "full_name"
    }
  ]
}



Relação de estados civis

Estado civil

Descrição

SINGLE

Solteiro

MARRIED

Casado

DIVORCED

Divorciado

SEPARATED

Separado

WIDOWER

Viúvo



Autorização Bacen (em breve)

Para otimizar a eficiência do fluxo da solicitação de empréstimo, é recomendável utilizar o fluxo de aprovação automática para consultas ao Bacen. O lead deve conceder explicitamente essa autorização através de um "aceite" e o texto utilizado para este checkbox deve ser enviado para o endpoint, junto a alguns campos necessários (headers) para evitar possíveis fraudes, de acordo com o seguinte:

Headers

Campo

Descrição

Exemplo

X-Bacen-Authorized-At

Data/hora do aceite, no formato: YYYY-MM-DDThh:mm:ss+00:00

2021-02-09T18:36:08+00:00

X-User-Agent

User-agent do navegador utilizado pelo cliente

Mozilla/5.0 (X11; Linux x86_64) AppleWebKit/537.36 (KHTML, ...

X-User-Ip

IP do cliente

192.168.15.127

Body

Campo

Descrição

authorizationTerms

Texto utilizado no aceite (e.g. checkbox) *

* Recomendamos o seguinte texto para este campo:

"Ao confirmar essa opção, você autoriza o Parceiro Creditas a consultar o SCR (Sistema de Informações de Crédito do Banco Central do Brasil) e concorda com o compartilhamento dos dados pessoais e financeiros entre eles."