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

Embedded UX/UI

The Avibra Embedded UX/UI offers a streamlined interface for user onboarding and benefit utilization.

Embedded Onboarding Flow:#

Screenshot 2025-04-10 at 2.31.59 PM.png
Staging Sample URL:
https://avibra.com/benefits-staging/{{partnername}}/{{campaign}}/{{userid}}
Production Sample URL:
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}
{{}} – Indicates dynamic parameters.
ParameterDescription
{{partnername}}partnername will be provided by Avibra.
{{campaign}}Offers finalized by Avibra and Partner. 'campaign' will be provided by Avibra
{{userid}}This field represents the user’s ID in the partner’s system.

Passing pre-fill data using url parameter 'data'#

Screenshot 2025-04-10 at 2.34.38 PM.png
Partners can pass pre-filled data for the registration page using the 'data' parameter in the URL. The data will be transmitted in Base64-encoded format.
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}&data=dataencrypted
Please note that query string parameters are appended to the Embedded UX/UI URL using the '&' sign, rather than the '?' commonly used in other URLs.
ParameterDescription
database 64 encoded prefill data to be passed in url. data is encoded json object - { "firstname": "Test", "lastname": "Test", "email": "abcd1278@yopmail.com", "zipcode": "85001", "dob": "03/03/1983". field in JSON are optional. Partner can send field available to them or field they want to pass.

Securing URL with Link Token#

To secure the URL, Partner can pass 'linktoken' url parameter.
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}&linktoken={{lintoken}}&isbaas=true&inapp=true
ParameterDescription
linktokenpartner can generate linktoken parameter by user using linktoken API from Security section.

Personalized landing page based on user age and location#

Screenshot 2025-04-10 at 2.36.06 PM.png
User will be presented with personalized benefits based on their age and location.
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}&linktoken={{lintoken}}&isbaas=true&inapp=true&data=dataencrypted&age=45&zipcode=08830
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}&linktoken={{lintoken}}&isbaas=true&inapp=true&data=dataencrypted&age=45&state=NJ
ParameterDescription
ageCurrent Age of user.
zipcode Or stateCurrent Residential Zipcode or State (Abbreviation) of user.

Avibra Dashboard#

Screenshot 2025-04-10 at 4.33.06 PM.png
Once users successfully register with Avibra, the Avibra Dashboard is hosted by our partners. Users will utilize this dashboard to use and manage their benefits. Partner will use the same link mentioned below to launch the home screen.
Staging Sample URL:
https://avibra.com/benefits-staging/{{partnername}}/{{campaign}}/{{userid}}
Production Sample URL:
https://avibra.com/benefits/{{partnername}}/{{campaign}}/{{userid}}
Modified at 2025-04-10 23:26:55
Previous
Avibra
Next
Security