Skip to main content

Create/Update An Enrollee

POST 
/v1/enrollees

Create or Update A Single Enrollee. Note: This feature is only available to HMOs/Insurers.

Request​

Query Parameters

    update_if_exists boolean

    If true, update an existing enrollee with the same insurance number. If false, return a duplicate validation message.

Body

required
    insurance_no stringrequired

    The insurance number of the enrollee. This must be a unique value.

    alternate_insurance_no string

    An alternate insurance number for the enrollee.

    firstname stringrequired

    The first name of the enrollee.

    lastname stringrequired

    The last name of the enrollee.

    phone string

    The phone number of the enrollee.

    email email

    The email address of the enrollee.

    sex string

    The gender of the enrollee.

    address string

    The address of the enrollee.

    birthdate date

    The birthdate of the enrollee.

    status stringrequired

    Possible values: [AA, IA, SX, XX, PP, WP]

    The status of the enrollee. The code is what is expected. Possible values are: AA (ACTIVE), IA (IN-ACTIVE), SX (SUSPENDED), XX (TERMINATED), PP (PENDED), WP (WAITING PERIOD).

    parent_insurance_no string

    The insurance number of the principal enrollee if the enrollee is a dependant.

    parent_relationship string

    The relationship between the enrollee and the principal enrollee.

    photo_base64_string string

    A base64 encoded image string.

    plan object

    The Insurance plan for the enrollee.

    id integer

    The Id as exists on curacel, ignore if you don't have it.

    code string

    The unique identifier of this plan on your Insurer ERP. Required if 'name' is absent.

    name string

    Name of the plan. Required if 'code' is absent.

    create_if_not_found boolean

    Create the plan record if it doesn't exist. Code and name must be supplied if true.

    client_id integer

    The id of the HMO client.

    primary_provider_id integer

    The id of the primary provider.

    primary_provider_code string

    The code of the primary provider.

    middle_name string

    The middle name of the enrollee.

    staff_number string

    The staff number of the enrollee.

    parent object

    The principal enrollee to which a dependant is attached.

    id integer

    The id of the principal enrollee. Either this id or principal's insurance no is required to create a dependant enrollee.

    insurance_no string

    The insurance number of the principal enrollee. This must be a unique value. Either this or principal ID is required to create a dependant enrollee.

Responses​

Success

Schema
    enrollee_id integer
Loading...