Hyprime Insurance

This section describes how to manage Hyprime insurance from Hygeia on your integration.

Certain properties obtain their values from supplementary endpoints. Refer to the Auxiliary page for a list of these additional endpoints.

Buy Hyprime Insurance

Use this endpoint to buy Hyprime health insurance for your customers.

POST https://api.mycover.ai/v1/products/hygeia/buy-hyprime

Request Body

NameTypeDescription

gender*

string

Customer's gender

image_url*

String

Image URL of the customer

first_name*

string

Customer's legal first name

last_name*

string

Customer's legal last name

email*

string

Customer's valid email address

dob*

string

Customer's valid date of birth

phone*

string

Customer's valid phone number

bought_for_self*

boolean

This is used to identify who the customer is buying for. It can be for a beneficiary, or themselves (true, false)

buyer_first_name

string

First name of the person paying for the plan

buyer_last_name

string

Last name of the person paying for the plan

buyer_email

string

Email address of the person paying for the plan

buyer_phone

string

Phone number of the person paying for the plan

buyer_gender

string

Gender of the person paying for the plan

product_id*

string

Product ID of the insurance plan

{
   "responseCode":1,
   "responseText":"Purchase Successful",
   "data":{
      "policy":{
         "first_name":"Demetrius",
         "last_name":"Conrad",
         "email":"wizox@mailinator.com",
         "phone":"+1 (259) 532-3948",
         "dob":"2021-12-01",
         "customer_id":"a0c6de74-b6d8-4f51-a2b0-ea40d6593997",
         "buyer_id":"a0c6de74-b6d8-4f51-a2b0-ea40d6593997",
         "product_id":"96774c1a-f062-4ace-9831-ef7f8ff47c69",
         "product_category_id":"9d78bc79-3fa8-447d-b688-e42c1c6838a0",
         "distributor_id":"76d5970a-d46b-43df-beb3-8f3117b7a60f",
         "provider_id":"e58026b0-f861-4b9d-9c45-5ae5c9ecf000",
         "activation_date":"2022-03-12T13:52:45",
         "start_date":"2022-03-12T13:52:45",
         "expiration_date":"2022-04-11T13:52:45",
         "meta":{
            "memberId":"1672574"
         },
         "active":true,
         "genius_price":"2000.00",
         "market_price":"2000.00",
         "profit":400,
         "purchase_id":"a990884c-815a-45b4-974b-000f9fd7b218",
         "submitted_to_provider":true,
         "id":"65c8aedb-e6ed-4335-9282-916ec2940623",
         "created_at":"2022-03-11T11:53:18.081Z",
         "updated_at":"2022-03-11T11:53:18.081Z"
      }
   }
}
Sample Request Payload
{
   "dob":"2021-12-01",
   "gender":"Male",
   "first_name":"Demetrius",
   "image_url":"https://s3.eu-west-2.amazonaws.com/staging.mycover.ai/88fd3732-6527-4bb3-abf3-81a96d564030-demetrius_conrad_1647003155333_screenshot-2021-08-16-at-3.58.28-pm.png",
   "last_name":"Conrad",
   "email":"wizox@mailinator.com",
   "phone":"+2349271662623",
   "product_id":"96774c1a-f062-4ace-9831-ef7f8ff47c69"
}

View Hyprime Hospitals

Call this API to list all the hospitals supported by Hyprime.

GET https://api.mycover.ai/v1/products/hygeia/plan/hyprime/hospitals

Certain properties obtain their values from supplementary endpoints. Refer to the Auxiliary page for a list of these additional endpoints.

Last updated