Skip to main content
Skip table of contents

Guideline

The diagram below meticulously depicts the seamless workflow for lead conversion and the intricacies of partner backend interactions within the Muse Finance ecosystem. The process unfolds through strategic interactions with the Muse Finance API, orchestrating the efficient management of leads, notifications, and backend processes.


Sequence Diagram - Muse Finance API.png

The Journey from Lead to Release of Funds in a Supply Finance Agreement


Steps

Step 1: Submit a Lead

Description

  1. Initiate the Journey: Embark on the process by submitting a new lead to the Muse Finance API through a well-crafted POST request to /leads.

  1. Discover Lead Insights: Optionally, delve deeper into lead insights by making a GET request to /leads and retrieve a comprehensive list of leads.

  1. Dynamic Scoring and Notifications (Optional): If the partner has opted for webhook notifications and the lead undergoes scoring, the system triggers a notification, ensuring a dynamic and responsive environment.

  1. Regular Lead Checks: If webhook notifications are not opted for, the partner needs to perform regular lead checks by making GET requests to /leads for updated information.

  1. Validation and Confirmation: Receive a prompt 201 Created response, affirming the successful submission and validation of the lead.


Step 2: Convert a Lead

Description

  1. Transformational Process: Propel the lead along its journey by initiating the conversion process using a POST request to /leads/{leadId}/convert.

  1. Acknowledgement of Success: Bask in the affirmation of success as a 201 Created response acknowledges the successful conversion, paving the way for further actions.


Step 3: Webhooks Subgraph

Description

With Webhook

  1. Intricacies of System Interaction: Engage in meticulous interactions with the Muse Finance API, orchestrating a symphony of webhooks to notify and respond to relevant events within the system.

  1. Real-time Intelligence: Stay informed with real-time intelligence as webhooks notify significant events such as lead conversions and other pivotal activities.

Without Webhook

  1. Partner Decision: Partners have the option not to utilise webhooks for real-time notifications.

  1. Regular Checks for Lead Updates:

    • Action: Engage in meticulous interactions with the Muse Finance API by making periodic GET requests to /leads.

    • Purpose: Orchestrate a systematic approach to obtain lead updates and relevant information.

    • Timing: Asynchronously check for lead conversions and other pivotal activities.

  1. Strategic Decision-Making: Empower the partner with real-time intelligence by staying informed about significant events such as lead conversions through regular API checks.


Step 4: Partner Backend Workflow

Submit Supplier Information

Description:

  1. Commence Backend Processes: Ignite the backend workflow by initiating a POST request to /supplier, and submitting essential supplier information.

  1. Backend Processing: Delve into backend processes, leveraging the supplied information for further backend operations and enhancements.

Submit Funds Request

Description

  1. Backend Continuation: Seamlessly continue the backend workflow with a POST request to /fundsRequest, setting in motion the funds request process.

  1. Awaiting Responsiveness: Relevant responses within the backend processes, ensuring a harmonious orchestration of financial transactions.


Overall Summary

The Muse Finance API serves as the central nervous system of this sophisticated orchestration, offering a robust framework for lead conversion, real-time notifications, and seamless facilitation of partner backend processes.

This API empowers partners with a suite of secure authentication mechanisms, ensuring the confidentiality and integrity of data.

Strategic adherence to the specified endpoints for each action guarantees a harmonious integration, fostering an ecosystem where partners can confidently navigate lead management, receive real-time insights, and orchestrate backend workflows with precision.

JavaScript errors detected

Please note, these errors can depend on your browser setup.

If this problem persists, please contact our support.