Avibra Integration API
1.0.2
  • 1.0.2
  • 1.0.1
Home
Home
1.0.2
  • 1.0.2
  • 1.0.1
1.0.2
  • 1.0.2
  • 1.0.1
    • Avibra
      • Change Log
      • Embedded UX/UI
      • Security
        • Authentication API
        • LinkToken API
      • Benefits
        • Get Benefits With Status
      • User Management
        • Create User
        • Update User
        • Cancel User
        • Prefil User
        • Upgrade/Downgrade User
      • Webhook
        • Webhook API (provided by partner)
      • Export Data
        • Open API Spec
    • Schemas
      • Schemas
        • eventInfo
        • userInfo
        • addressInfo
        • benefitwithstatusInfo
        • benefitwithstatusInfos
        • errorInfo
        • updateuserInfo
        • linktokenInfo
        • linktokenesponseInfo
        • accesstokenInfo
        • getbenefitInfo
        • userofferInfos
        • offerInfo
        • offerInfos
        • currentofferdetailsInfo
        • offers
        • prefillInfo
        • moredetail
        • moredetails
    Home
    Home
    1.0.2
    • 1.0.2
    • 1.0.1
    1.0.2
    • 1.0.2
    • 1.0.1

    Avibra

    Avibra Integration#

    Avibra offers API integration for authentication, benefit visualization, enrollment and cancellation of user benefits—enabling a seamless experience with minimal engineering effort from our partners.
    The full experience can be managed through the first four integration sections(Embedded UX/UI, Security, Benefits, User Management); the Webhook section is optional, depending on your desired level of customization.
    SectionDescription
    Embedded UX/UIThe Avibra Embedded UX/UI offers a streamlined interface for user onboarding and benefit utilization.
    SecurityAPI are used to establish a handshake with Avibra and securely access the Avibra Embedded UX/UI using a link token.
    BenefitsAPI enables benefit visualization for users, whether pre- or post-enrollment with Avibra.
    User ManagementAPI facilitates user enrollment into the Avibra ecosystem.
    WebhookThis optional partner-provided API allows for real-time notifications about users’ account status and benefits activity.
    💡
    The Avibra API is organized around REST. The API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP responses.

    API Protocols#

    The Avibra API uses GET, POST, DELETE verbs to communicate and HTTP response codes to indicate status and errors. The Avibra API is served over HTTPS TLS v1.1+ to ensure data privacy; HTTP and HTTPS with TLS versions below 1.1 are not supported.

    API Environment#

    testing: Test your integration with live credentials; you will need to request access before you can access our sandbox environment
    production: Production API environment
    Modified at 2025-05-23 16:37:13
    Next
    Change Log