v1

latestOpenAPI 3.0.0Apache 2.02026-07-263079321.1 MB
Credit Request

Step 1 - Simple signup

Simple signup

  • Make sign up of users (can return error if user already registered)
  • NOTE: Client_id is blocked if this call is made to the same CPF more than 20 times in the same day
  • Realiza o cadastro de usuários (pode retornar erro caso o usuario já esteja cadastrado)
  • OBS: Client_id é bloqueado caso esta chamada seja realizada para o mesmo CPF acima de 20 vezes no mesmo dia
post/v2.1/process/simple_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

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

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"
    }
  ]
}