Guides
API Reference

1 - Introduction

Suggest Edits

What Is the SCD solution?

The EasyCredito Credit API (SCD/CCB) is a complete and robust infrastructure solution designed for the formalization from end-to-end credit operations. The solution operates under the Brazilian Central Bank (BCB) regulation, based on the Resolution 5.050/2022. We would like to emphasize two concepts that our solution is focused:

SCD (Direct Credit Society): It is a type of financial institution authorized by the Central Bank of Brazil to perform credit operations, such as loans and financing, exclusively through an electronic platform with its own capital. EasyCredito operates as an SCD, providing the regulatory and technological foundation for the operations.

CCB (Bank Credit Note): It is one of the many credit instrument that formalizes the loan operation between the creditor and the borrower. This document, generated in PDF format through a flexible template, contains all the details of the transaction—such as amounts, rates, terms, and installments—and has legal validity as an extrajudicial enforceable instrument.



Frequently Asked Questions (FAQ)

Integration & Authentication

  1. What are the prerequisites to start integrating with EasyCrédito’s API?
    The partner company must be registered by EasyCrédito's team. It is also necessary to configure the credit products, register the operational users, and provide an HTML template for the CCB. Additionally, the use of a static IP address is mandatory to ensure secure requests.

  2. How does the authentication process work?
    Authentication uses JWT and is done via the /auth/token endpoint, which generates a Bearer Token. This token must be included in the Authorization header of all subsequent requests. There are two levels of access: Admin and User.

  3. What is the difference between Admin and User levels?
    The Admin level is used by EasyCrédito for platform administration. The User level is used by the partner company's operators to perform day-to-day operations, such as simulations, customer registration, and disbursements.

  4. Is it mandatory to use a static IP for API requests?
    Yes. A static IP is required so EasyCrédito can apply strict security policies, ensuring that requests originate only from authorized and trusted sources.


Products & Proposals

  1. Can I register more than one credit product under my company?
    Yes. A single company can register multiple credit products, each with its own rules and rates, such as personal loans and vehicle financing.
  2. What happens if a proposal expires due to lack of approval?
    If the contract is not submitted or approved within the deadline, the proposal will expire automatically, and the credit will not be disbursed.

CCB & Formalization

  1. Can I customize the CCB template?
    Yes. The partner may provide an HTML template, which will be used to generate the PDF version of the CCB. This allows full customization of layout, clauses, and branding but will be submitted to compliance and credit committee for approval.
  2. How is the CCB PDF generated?
    The CCB is generated automatically based on the HTML template provided. The API fills in the operation data and returns the contract in Base64 format.
  3. Does the CCB need to be digitally signed by the borrower?
    Yes. The signed version of the CCB must be submitted through the API in order to proceed with disbursement and registration.

Documentation & KYC

  1. What documents are required for the KYC process?
    The mandatory documents include: selfie, ID document, proof of address, and the signed CCB.
  2. How are documents linked to a specific proposal?
    Documents are submitted through a specific endpoint that automatically links them to the corresponding credit proposal.

Disbursement

  1. Where do the disbursed funds come from?
    Funds are debited from the partner’s wallet account. EasyCrédito does not use its own capital to fund operations.
  2. What happens if there are insufficient funds in the wallet account?
    If the wallet balance is insufficient, disbursement operations will be paused until the account is replenished.

Registration & Assignment

  1. Is CCB registration performed automatically?
    Yes. After disbursement, the CCB is automatically submitted for registration. No manual request is necessary.
  2. Is the assignment of the CCB to the partner also automatic?
    Yes. After registration, the assignment of the CCB is also performed automatically. No manual interaction is required.

Updated 10 days ago