API Reference

Loan Application Overview

The loan application process enables users to apply for loans efficiently, guiding them through key steps to ensure a smooth and transparent experience.


Loan Application Workflow

1. Loan Information

End users start the application by accessing detailed loan information, including:

  • The type of loan (e.g., fixed-term or line of credit).
  • Key terms such as maximum Loan-to-Value Ratio (LVR), interest rates, and loan duration, default etc.
Block Earner Loan Information Example

Block Earner Loan Information Example


2. User Input

In this step, users provide critical details to customize their loan:

  • Security Selection: Specify the type of security (e.g., BTC, ETH) to be used for the loan.
  • Borrow Amount: Enter the desired loan amount. Based on this, the system calculates:
    • Estimated security requirements based on the maximum LVR.
    • Monthly repayment amounts for fixed-term loans.
  • Users can adjust the LVR to see how it impacts the security requirements and loan terms.
👩🏻‍💻

API for calculation

Block Earner - Line of Credit - Borrow Amount Example

Block Earner - Line of Credit - Borrow Amount Example

Block Earner - Fixed Term - Borrow Amount Example

Block Earner - Fixed Term - Borrow Amount Example


📘

Skip locking security at application time

For added flexibility (some users don't want to touch their security until they are application is approved), users can submit loan applications without immediately supplying security. In such cases, end users are required to supply the security after the credit assessment is approved

💻

User applyFor to indicate whether the user has locked security

For Block Earner to understand whether the end user has locked his security of not, you can use the applyFor field in Create a loan application. There are 2 options for this field:

  • CREDIT_ASSESSMENT: Block Earner will only assess the user's loan application. If the application is in CREDIT_ASSESMENT status, the application will be not included in the next reckoning even the application is approved.
  • FULL_APPROVAL: The user is ready for full approval as soon as he passed the credit assessment. The application will be included in the reckoning once getting the approval.

❗An application can only be updated from CREDIT_ASSESSMENT to FULL_APPROVAL. It can't be updated the other way around

3. Loan Questionnaire

Users complete a short questionnaire to confirm:

  • Their address and contact information.
  • Relevant details about their personal and financial situation.

4. Loan Agreement

👩🏻‍💻

API for agreement

Use Preview Loan Agreement to display it to the end user before he can submit the application

The loan agreement is generated in HTML format to provide a user-friendly, easily readable document for display. It includes all critical loan details, such as:

  • Borrow amount and loan type.
  • Repayment schedule and terms.
  • Interest rate and applicable fees (e.g., origination fee).
  • Security requirements, including the type and amount of collateral.

This format ensures users can review the agreement seamlessly on any platform before proceeding with the loan application.

Block Earner Loan Agreement Example

Block Earner Loan Agreement Example

5. Confirm Bank Details

Users are prompted to confirm or update their bank account details where the approved loan funds will be deposited.

6. 2FA Verification (Optional)

For enhanced security, Block Earner requires two-factor authentication (2FA) to verify the user’s identity and finalize the application. It's a recommended step on the Business side but not required on applying Block Earner.

7. Collecting Consent

Before completing the application, users must review and agree to all terms and conditions (T&Cs) associated with the loan.

This step ensures that users fully understand the loan terms and formally accept them, completing the application process.

8. Upload Document

For business loan application or Fixed Term Loan Application, user is required to upload supporting document. You can use Get Upload Link to get a link and POST the document to the link. Currently only PDF format is supported.

👩🏻‍💻

API for new loan application

Use Create a loan application to submit the application

Apply for a Line of Credit Loan Diagram


Apply for a Fixed Term Loan Diagram


📘

Key difference between Fixed Term and Line of Credit

The main difference between the 2 flows lies in the calculation part in the beginning.

Line of Credit uses Get projected interest EP to get the estimated interest for the full term while Fixed Term uses Get Repayment Schedule EP to get the full repayment plan information including the interest information.

It's also mandatory for fixed term loan to provide income proof (e.g. Payslip) so that the serviceability can be assessed properly.

Get notified about loan application decision

You will receive a wehook notification Loan Application Update when there is a result about the loan application, whether it's being APPROVED or DECLINED.

❗️

An important note is that only the application with FULL_APPROVAL in applyFor field will be included in the reckoning after being approved. If the loan is still in CREDIT_ASSESSMENT status, it means the end user is not ready to settle the loan yet. Block Earner relies on business to notify us when the user is ready for the settlement in the next reckoning.


The approved loan application with FULL_APPROVAL status will be included in the next pre-reckoning report. Please seen more details about Reckoning here.

Get loan details

Once the reckoning is completed, user is able to see the loan status. You can get the loan details by either Get loans or Get loan information. The EPs should return all information about an opened loan.

It worth mentioning that for user to access all the agreement easily, you can use Get loan agreements EP to get all the loan agreement generate for a loan (including open loan and redraws).