Voila-Api-Docs
OverviewHow it worksAPI Reference
OverviewHow it worksAPI Reference

    Overview#

    The Voila API enables partners to submit leads directly into the Voila system.
    This API layer is designed to receive, validate, and process partner lead data in a secure and scalable manner.

    How it Works#

    1.
    Partner Onboarding
    Partners are onboarded offline with basic details. After onboarding, each partner is provided with a Client Key and Client Secret.
    2.
    Authentication
    Every API request from a partner must include both X-Client-Key and X-Client-Token.
    The X-Client-Token is generated using the SHA256 HMAC algorithm.
    The token is created by hashing the value
    X-Client-Key:X-Client-Secret using X-Client-Secret as the HMAC secret (salt).
    This token is used by Voila to authenticate partner requests and ensure secure data submission.
    3.
    Asynchronous Processing
    Lead requests are processed asynchronously.
    Partners are not required to wait for the processing to complete.
    Each request is tracked using a unique identifier returned by Voila.

    API Reference#

    Create Lead#

    The Create Lead API allows partners to submit basic lead details to the Voila system.

    Lead Creation Flow#

    The partner submits basic lead details using the Create Lead API.
    Once Voila receives the request, it immediately returns a unique UUID.
    This UUID acts as a tracking identifier for future reference.
    Lead processing continues asynchronously in the background.
    The returned UUID can be used to track the request status using the Get Request Details API.
    API Reference
    For complete request and response details, refer to the official API reference:
    Create Lead API Reference

    Get Request Details#

    After submitting a lead using the Create Lead API, partners can use the returned UUID
    to retrieve the status and details of the request.

    Purpose#

    The Get Request Details API allows partners to:
    Check whether a submitted lead request has been processed
    Retrieve the current status of the request
    Fetch relevant response details associated with the request
    This API is especially useful since lead processing is handled asynchronously.
    API Reference
    For complete request and response details, refer to the official API reference:
    Get Request Details API Reference
    Built with