API Reference

Create/Update An Enrollee

Create or Update A Single Enrollee

Log in to see full request history
Query Params
boolean

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

Body Params
string
required

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

string

An alternate insurance number for the enrollee.

string
required

The first name of the enrollee.

string
required

The last name of the enrollee.

string

The phone number of the enrollee.

string

The email address of the enrollee.

string

The gender of the enrollee.

string

The address of the enrollee.

date

The birthdate of the enrollee.

string
required

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).

string

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

string

The relationship between the enrollee and the principal enrollee.

string

A base64 encoded image string.

plan
object

The Insurance plan for the enrollee.

integer

The id of the HMO client.

integer

The id of the primary provider.

string

The code of the primary provider.

string

The middle name of the enrollee.

string

The staff number of the enrollee.

parent
object

The principal enrollee to which a dependant is attached.

Responses

400

Bad Request

401

Unauthenticated

403

Forbidden

422

Unprocessable Entity

500

Server Error

Language
Credentials
API KEY from your account dashboard
URL
Click Try It! to start a request and see the response here! Or choose an example:
application/json