Criação de Proposta com Processamento Automático

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 prazos e valores solicitados.

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

Como enviar uma solicitações de empréstimo

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

Request HTTP POST

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.
`urgency`	string	Não	Urgência do empréstimo Opções: `ONE_MONTH`, `TWO_MONTHS`, `SIX_MONTHS` ou `JUST_SEARCHING`
`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
`metadata`	object	Não	As informações disponibilizadas nesse campo são necessárias para o rastreamento da informação e análise de dados.
`collateral`	object	Sim	Dados da garantia do solicitante do empréstimo. Consulte o objeto do collateral

Exemplo de Request e Response

curl --location '{{url_base}}/proposals/home' \
--header 'Authorization: Bearer {{access-token}}' \
--header 'Accept: application/vnd.creditas.v2+json' \
--header 'Content-Type: application/json;charset=UTF-8' \
--data-raw '{
    "productType": "HOME_REFI",
    "purpose": "OTHERS",
    "borrower": {
        "maritalStatus": "STABLE_UNION",
        "nationality": "Brasileiro",
        "professionalInfo": {
            "professionalStatus": "BUSINESSMAN",
            "monthlyIncome": 7700
        },
        "fullName": "Person Deletetion",
        "email": "[email protected]",
        "gender": "MALE",
        "birthDate": "1986-09-12",
        "cellphone": "982614582",
        "cellphoneCode": "11",
        "postalCode": "05055000",
        "cpf": "51002260051",
        "optIns": {
            "email": false,
            "WhatsApp": false,
            "sms": false
        },
        "authorizationTerms": "oijhcidwjndeijcniew iojcndijnd ijncdwij nijwncw ijcn njicdj",
        "residence": {
            "value": 200000.0,
            "debt": 0,
            "realEstateType": "HOUSE",
            "address": "Av. Engenheiro Luís Carlos Berrini",
            "number": "325",
            "city": "São Paulo",
            "complement": "12o andar",
            "state": "SP",
            "neighborhood": "Brooklin Paulista",
            "postalCode": "04571010",
            "country": "Brasil"
        },
        "spouse": {
            "maritalStatus": "STABLE_UNION",
            "nationality": "Brasileiro",
            "professionalInfo": {
                "professionalStatus": "BUSINESSMAN",
                "startedAt": "1986-09-12",
                "monthlyIncome": 7700,
                "jobTitle": "Contador(a)",
                "company": {
                    "cnpj": "55.168.235/0001-89",
                    "revenue": "300"
                },
                "description": "professionalDescription teste"
            },
            "fullName": "Na minha mão funcina",
            "email": "[email protected]",
            "gender": "MALE",
            "birthDate": "1986-09-12",
            "cellphone": "982614582",
            "cellphoneCode": "11",
            "postalCode": "05055000",
            "cpf": "51002260051"
        }
    },
    "conditions": {
        "installment": {
            "term": 3
        }
    },
    "intendedCredit": {
        "currency": "BRL",
        "amount": 50000
    },
    "collateral": {
        "value": 200000.0,
        "debt": 0,
        "realEstateType": "HOUSE",
        "address": "Av. Engenheiro Luís Carlos Berrini",
        "number": "325",
        "city": "São Paulo",
        "complement": "12o andar",
        "state": "SP",
        "neighborhood": "Brooklin Paulista",
        "postalCode": "04571010",
        "country": "Brasil",
        "hasDeed": "YES",
        "owners": [
            "SPOUSE"
        ]
    }
}'

HTTP/1.1 201 OK
Content-Type: application/json; charset=UTF-8
Accept-Version: v1

{
    "id": "B2B-DBC79D7F-E5D7-45B9-B9DD-A60C2561EA06",
    "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

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