Guides
API Reference

2.1 APIs, Authentication

Below are the main methods available in the Credit API (SCD/CCB), including their respective endpoints and a brief description of each operation’s purpose. This section serves as a quick reference guide for available API calls.

Suggest Edits

Base URLs

For authentication methods, use the base URL:
https://auth.easycredito.com.br

For all other API methods, use the following base URL:
https://api-scd.easycredito.com.br

Authentication

Authentication is the first step in using the API. It generates a Bearer token that must be included in the header of all subsequent requests. There are two levels of authentication depending on the operation.

User Authentication

  • Method: POST
  • Endpoint: /auth/token
  • Description: Generates an access token.
    For User-level, use the operator credentials created for your company.

Credit Operation (User)

With the user token, the operator can perform the full credit origination flow.

Loan Simulation

  • Method: POST
  • Endpoint: /simulations
  • Description: Performs a credit simulation based on the provided amount, term, and interest rate, returning the installment values.

Register Borrower

  • Method: POST
  • Endpoint: /customers
  • Description: Registers or updates the data of a new borrower (end customer) on the platform.

Create Credit Proposal

  • Method: POST
  • Endpoint: /proposals
  • Description: Creates a new credit proposal, linking a borrower to a credit product and defining the loan conditions.

Generate CCB

  • Method: GET
  • Endpoint: /proposals/{proposalId}/ccb-pdf-base64
  • Description: Generates the final Bank Credit Note (CCB) document in PDF format, based on the predefined template. The file is returned encoded in Base64.

Submit KYC Documents

  • Method: POST
  • Endpoint: /documents/{proposal_id}/documents
  • Description: Allows submission of the borrower’s documents, which are linked to the credit proposal for analysis and auditing purposes.
    The required KYC documents are:
  • SELFIE
  • ID (Government-issued ID)
  • PROOF_ADDRESS
  • PROOF_INCOME
  • PROOF_OWNERSHIP

Submit Signed CCB

  • Method: POST
  • Endpoint: /proposals/{proposalId}/documents
  • Description: This endpoint is also used to upload the signed CCB document from the borrower.

Initiate Disbursement

  • Method: POST
  • Endpoint: /proposals/{proposal_id}/disburse
  • Description: Initiates the process of transferring the credit amount from the partner’s "wallet account" (FIDC/partner) to the borrower’s account via Pix. Subject to processing times.

Updated 10 days ago