Skip to main content

Fetch Enrollee Details

GET 
/v1/enrollees/single-enrollee

Fetch details of a single enrollee using its id or insurance_no

Request​

Query Parameters

    id integer

    The id of the enrollee. it is required if the insurance_no is not supplied

    insurance_no string

    The insurance number of the enrollee. it is required if the id is not supplied

    include_dependants boolean

    An optional boolean value to indicate if the dependants of the enrollee should be included in the response. Defaults to false

Responses​

Success

Schema
    message string

    Information on response

    data object

    Information on the enrollee requested

    id integer

    This is the ID of the enrollee.

    insurance_no string
    firstname string
    lastname string
    middlename string
    sex string
    parent_insurance_no string
    status string
    email string
    phone string
    plan object

    Enrollees current plan

    id integer
    name string
    company object

    Enrollees company

    id integer
    name string
    valid_until string
    photo object

    Enrollees profile image

    preview_url string

    A thumbnail rendering of enrollee photo

    full_url string

    Enrollee full image

    primary_provider object

    Enrollees primary provider

    code string

    Code used to identify the provider for your Insurer

    id integer
    name string
    insurer object

    Enrollees HMO

    code string

    Code used to identify the Insurer for your provider

    id integer
    name string
Loading...