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
  1. Benefits
  • Avibra
    • Change Log
    • Embedded UX/UI
    • Security
      • Authentication API
      • LinkToken API
    • Benefits
      • Get Benefits With Status
        POST
    • 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
  1. Benefits

Get Benefits With Status

POST
https://dev.avibra.com/preprod/user/benefits
Last modified:2025-06-25 16:05:41
Maintainer:Not configured

Request

Authorization
Provide your bearer token in the
Authorization
header when making requests to protected resources.
Example:
Authorization: Bearer ********************
Header Params

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

🟠400Bad Request
🟠401Unauthorized
🟠404User Not Found
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://dev.avibra.com/preprod/user/benefits' \
--header 'x-api-key;' \
--header 'Authorization: Bearer <token>' \
--header 'Content-Type: application/json' \
--data-raw '{
    "userid": "current10001",
    "age": 45,
    "state": "NJ",
    "zipcode": "08830",
    "partnername": "",
    "offername": ""
}'
Response Response Example
200 - Before Onboarding
[
    {
        "name": "ci",
        "displayname": "Critical Illness Benefits",
        "icon": "https://icons.avibra.com/2.5K+Critical+Illnes_icon.png",
        "description": "Fixed lump-sum cash benefit for covered illnesses.",
        "status": "notenrolled",
        "benefittype": "dollar",
        "deeplinkdata": "&productname=ci&producttype=dobs&redirectto=drilldown-details",
        "isselectedforswap": false,
        "swapeffectiveattimestamp": null,
        "swapexpiresattimestamp": null
    },
    {
        "name": "adnd",
        "displayname": "Accidental Death Insurance",
        "icon": "https://icons.avibra.com/20KADND.png",
        "description": "Emergency cash for you or your loved ones after a major accident.",
        "status": "notenrolled",
        "benefittype": "dollar",
        "deeplinkdata": "&productname=adnd&producttype=dobs&redirectto=drilldown-details",
        "isselectedforswap": null,
        "swapeffectiveattimestamp": null,
        "swapexpiresattimestamp": null
    },
    {
        "name": "life",
        "displayname": "$1,000 Life Insurance",
        "icon": "https://icons.avibra.com/5000LifeInsurance.png",
        "description": "Lump-sum cash benefit for your loved ones in the event of your death.",
        "status": "enrolled",
        "benefittype": "dollar",
        "deeplinkdata": "&productname=life&producttype=dobs&redirectto=drilldown-details",
        "isselectedforswap": null,
        "swapeffectiveattimestamp": null,
        "swapexpiresattimestamp": null
    }
]
Modified at 2025-06-25 16:05:41
Previous
LinkToken API
Next
User Management