API Reference

Integrating the iBranch

Integration Development Overview

The integration process with Lendica's iBranch is designed to be straightforward, with a quick frontend setup and a more detailed backend integration. Here’s an outline of what to expect during the integration.

💭

If you have your partner credentials:

You can get the iBranch up and running quickly using this recipe.

🦉
iBranch
Open Recipe

Frontend Integration (1 day)

Start by completing the frontend integration. The code blocks in the documentation will help you quickly add iBranch to your application.

  • Once the code is added, iBranch will be fully operational in demo mode, allowing you to:
    • Use full DrawDown functionality
    • View preview PayLater and FundNow offers
      • A backend API integration will be necessary to complete PayLater and FundNow integrations
    • Simulate the application process

In this demo mode, the iBranch widget will function with mock data for testing purposes. This allows you to see how it will operate in your system and interact with the iBranch features.

With the frontend integration in place, most of the development work is done. The widget will automatically switch to using live data once the backend integration is completed.

Backend Integration (1-2 weeks)

📘

Review the Backend Integration Overview

After completing the frontend integration, the backend integration phase enables iBranch to access real-time data from your system, allowing your users to receive live financing offers based on their actual business data. This integration is crucial for providing accurate and personalized financing options through PayLater and FundNow.

During this phase:

  • Provide API Endpoints: You'll need to create and expose a set of API endpoints that Lendica can use to securely retrieve necessary data from your system, such as company information, invoices, and bills.

    • Endpoint Specifications: Refer to our Backend Integration Overview for detailed information on the expected endpoints, required functionalities, and data structures. This documentation outlines the API routes that Lendica expects its partners to provide.

  • Data Security: Ensure that all data exchanged via these endpoints is handled securely, adhering to industry standards for data protection and privacy. Implement authentication and authorization measures to protect your data.

  • Testing and Validation: We'll work collaboratively to test these endpoints. This may involve:

    • Providing Access: Supplying Lendica with access to a test or sandbox environment where we can safely perform integration tests without affecting your production data.

    • Data Verification: Ensuring that the data retrieved by Lendica matches the data in your system accurately and is up-to-date.

    • Error Handling: Implementing proper error responses for scenarios like missing data, authentication failures, or server errors.

By providing these endpoints, you enable Lendica to:

  • Fetch Real-Time Data: Access live data necessary for underwriting and generating financing offers.
  • Offer Tailored Financing Options: Provide your users with financing options that are personalized to their business's financial situation.

This backend integration is essential for enabling live offers in PayLater and FundNow, allowing your users to access real financing options based on their business data..

Note: The Backend Integration Overview documentation uses OpenAPI schema to detail the expected API routes and data structures. It's important to understand that this represents the endpoints your platform needs to provide to Lendica—not the other way around. Our goal is to establish a clear and standardized method for integration, minimizing misunderstandings and ensuring a smooth onboarding process.

By completing these two phases, your platform will be fully integrated with iBranch, offering seamless access to financing solutions directly from within your system.