v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Credit Request

Step 1 - Signup match

Signup match

  • Register users and receive feedback from credit products with the highest chance of approval(may return an error if the user is already registered)
  • NOTE: Client_id is blocked if this call is made to the same CPF more than 20 times in the same day
  • Faça a inscrição de usuários e receba o retorno dos produtos de crédito com maior chance de aprovação(pode retornar erro se o usuário já estiver registrado)
  • OBS: Client_id é bloqueado caso esta chamada seja realizada para o mesmo CPF acima de 20 vezes no mesmo dia
post/v2.1/process/signup

Request body

cpfstring required

Document number, only numbers

Número do documento, apenas números

namestring required

Name of user

Nome do usuário

birthdaystring date required

Birhday, format (yyyy-mm-dd)

Data de nascimento, formato (aaaa-mm-dd)

emailstring required

Valid email

Email válido

phonestring required

Valid cellphone with DDD, only numbers

Telefone celular válido com DDD, apenas numeros

zipCodestring required

Valid zip code, only numbers

CEP válido do usuário, apenas números

education'NAO_ALFABETIZADO' | 'ENSINO_FUNDAMENTAL_INCOMPLETO' | 'ENSINO_FUNDAMENTAL_COMPLETO' | 'ENSINO_MEDIO_INCOMPLETO' | 'ENSINO_MEDIO_COMPLETO' | 'ENSINO_SUPERIOR_INCOMPLETO' | 'ENSINO_SUPERIOR_COMPLETO' | 'POS_GRADUACAO' required

Nível de escolaridade

banksstring required

Bancos

Clique no link a seguir para visualizar os bancos <a href="https://developers.easycredito.com.br/enum/bank.json" target="_blank">https://developers.easycredito.com.br/enum/bank.json</a>

occupation'APOSENTADO_PENSIONISTA' | 'AUTONOMO' | 'EMPRESARIO' | 'PROFISSIONAL_LIBERAL' | 'ASSALARIADO' | 'FUNCIONARIO_PUBLICO' | 'DESEMPREGADO' required

Ocupação

incomenumber required

User income, only numbers

Renda do usuário, apenas números

hasCreditCardboolean

Has credit card

O usuário informou possuir cartão de crédito em seu nome

hasRestrictionboolean

Has overdue debts

O usuário informou possuir restrições em seu nome

hasOwnHouseboolean

Has own house

O usuário informou possuir casa própria em seu nome

hasVehicleboolean

Has vehicle

O usuário informou possuir veículo em seu nome

hasAndroidboolean

Has android

O usuário informou possuir celular android em seu nome

Example request

{
  "products": [
    {
      "type": "LOAN",
      "value": 7000,
      "installments": 12
    }
  ]
}

Response

Pipeline

idstring

ID do processo

status'SIGNUP_ANALISIS' | 'SIGNUP_COMPLETED' | 'SIGNUP_DENIED' | 'PROPOSAL_ANALISIS' | 'PROPOSAL_CREATED' | 'PROPOSAL_DENIED'

Status do processo

cpfinteger

CPF do usuario

namestring

Nome do usuario

dateCreatedstring

Data criação do processo

lastUpdatedstring

Ultima atualização do processo

Example response

{
  "matches": [
    {
      "product_id": 684984,
      "name": "EMPRÉSTIMO PESSOAL",
      "logo": "url",
      "minValue": 500,
      "maxValue": 50000,
      "minInstallment": 12,
      "maxInstallment": 36,
      "monthlyTax": 0.059
    }
  ],
  "proposals": [
    {
      "customerServiceNumber": "20190805062216",
      "type": "loan",
      "product": "EMPRÉSTIMO PESSOAL",
      "hasDocuments": false,
      "lastStatus": "EM_ANALISE_OPERACIONAL",
      "dateCreated": "2019-08-05T21:22:19Z",
      "lastUpdated": "2019-08-05T21:22:22Z",
      "value": 50000,
      "installments": 36,
      "monthlyTax": 0.059,
      "installmentsValue": 3490.77,
      "iofValue": 1652.59988,
      "grossValue": 51652.6,
      "firstPaymentDate": "2019-09-04T21:22:16Z",
      "cet": 1.052660058382551,
      "releasedDate": "2019-08-05T21:22:16Z"
    }
  ]
}