There are three main integration flows available with Business Score.
API only integration
With the API only integration, you will first need to create and prequalify the company. Once the company qualifies for funding, you can create an application against that company.
API Flow:
-
Create application
https://business-score.readme.io/reference/partnerapiapplicationcontroller_createapplication -
Prequalify the company
https://business-score.readme.io/reference/partnerapicompanycontroller_prequalify- If the company does not meet minimum lending criteria, an auto rejection can be triggered, automating the initial decision.
- If the business qualifies, you can proceed to create to upload required documents (bank statement)
-
Upload documents for the company (created in the application step)
https://business-score.readme.io/reference/partnerapicompanycontroller_createdocument -
Submit application (request offers)
https://business-score.readme.io/reference/partnerapiapplicationcontroller_requestoffers
Application/Offer Status Monitoring:
There are three ways to monitor the status of the application and offers:
-
Get application status for all applications
https://business-score.readme.io/reference/partnerapicompanycontroller_fetchapplicationstatuses -
Get application status for one application/company
https://business-score.readme.io/reference/partnerapicompanycontroller_getapplicationstatus -
Use webhooks to monitor application and offer status
https://business-score.readme.io/reference/webhooks- Offers are generated by lenders integrated on our backend; manual lender offers are also supported.
When a webhook notification indicates a new offer or application status update, call the API for application or offer status as needed:
-
Get offers by application ID
https://business-score.readme.io/reference/partnerapiapplicationcontroller_getapplicationoffers -
Get status by company ID
https://business-score.readme.io/reference/partnerapicompanycontroller_getapplicationstatus
Widget Integration
With this option, you can embed the widget.js
on any page where you want the application flow to appear. Business Score handles the UI, client interactions, and back-and-forth communication directly.
Key documentation:
- How widget.js works: https://business-score.readme.io/reference/how-widgetjs-works
- Installation and execution: https://business-score.readme.io/reference/installation-and-execution
API + Widget Integration
This hybrid flow combines the strengths of both approaches.
- Initial client onboarding happens via the API, so you can pre-fill application details using information you already hold.
- The client then continues the lending journey through the widget, where they can complete their application, review lender offers, accept an offer, and proceed to drawdown.
Code sample for this approach:
https://business-score.readme.io/reference/code-samples