This section outlines a typical workflow for integrating the MAXINTEGRATE API to facilitate a loan application process on your website.

Initiating a Loan Application

Your website should feature a prominent "Apply for a Loan" button or a similar call to action. When a borrower clicks this button, the following sequence of API calls and actions should occur:

1. User Login:

   • Call the login method.

   • Action: Capture and store the successful response data for use in subsequent API calls.

   • Error Handling: Note any error information returned.

2. Cashbox Pre-selection (if login is successful):

   • If the login is successful, call the cashbox_preselect method.

   • Action: Capture and store the successful response data for use in subsequent API calls.

3. Client Search:

   • Call the client_search method.

   • Error Handling: Note any error information returned.

4. New Client / Existing Client Flow:

   • If the client does not exist:

     • Employer Search: Call the employer_search method.

     • Employer Creation (if employer does not exist): If the employer is not found, call the employer_create method.

       • Error Handling: Note any error information returned during employer search or creation.

     • Payback Type List: Call the payback_type_list method to retrieve available payback methods.

       • Error Handling: Note any error information returned.

     • Client Creation: Call the client_create method.

       • Error Handling: Note any error information returned.

     • ID Document Upload: Call the file_upload method to upload the client's ID document.

       • Error Handling: Note any error information returned.

   • If the client exists:

     • Client Update (Optional): You may call the update_client method to update client information.

       • Error Handling: Note any error information returned.

5. Document Uploads for Client:

   • Call the file_upload method for the following documents:

     • Payslip

     • Bank statement

   • Error Handling: Note any error information returned for each upload.

6. Credit Check:

   • Call the credit_check method.

   • Error Handling: Note any error information returned.

7. Loan Application Details (if credit check is successful):

   • Client Budget: If the credit check is successful, call the client_budget method.

     • Error Handling: Note any error information returned.

   • Client Budget Items: Call the client_budget_items method.

     • Error Handling: Note any error information returned.

   • Loan Purpose List: Call the loan_purpose_list method to retrieve available loan purposes.

     • Action: The information from this call will be used in subsequent methods.

     • Error Handling: Note any error information returned.

   • Loan Product List: Call the loan_product_list method to retrieve available loan products.

     • Action: The information from this call will be used in subsequent methods.

     • Error Handling: Note any error information returned.

   • Create Loan Application: Call the create_loan_application method.

     • Error Handling: Note any error information returned.

Loan Activation and Management

Upon successful creation of the loan application:

1. Loan Activation:

   • The loan application can be activated using an OTP (One-Time PIN).

     • Error Handling: Note any error information returned during OTP activation.

   • OR

   • The loan can be activated manually.

2. Document Signing:

   • The active loan documentation can be signed.

   • Error Handling: Note any error information returned.

3. Loan Repayment

1. The Allps DebiCheck can be triggered

4. Loan Payout

1. The Allps payout to a wallet or bank account can be triggered

5. Loan Status Inquiry:

• A dedicated method is available to search for a specific loan and view its:

• Status
  

• Amount repayable

• Amount outstanding

• Settlement amount

• Error Handling: Note any error information returned.

Third-Party Payments

To add third-party payment information to a loan:

1. Beneficiary List: Call the beneficiary_list method.

   • Error Handling: Note any error information returned.

2. Third-Party Claim: Call the third_party_claim method.

   • Error Handling: Note any error information returned.