Enrollees

Create/Update An Enrollee

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

post/v1/enrollees

Request

  • Base URL: https://api.health.curacel.co/api
  • URL: https://api.health.curacel.co/api/v1/enrollees
  • Auth: HTTP bearer

Query parameters

update_if_existsboolean

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

Request body

insurance_nostring required

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

alternate_insurance_nostring

An alternate insurance number for the enrollee.

firstnamestring required

The first name of the enrollee.

lastnamestring required

The last name of the enrollee.

phonestring

The phone number of the enrollee.

emailstring email

The email address of the enrollee.

sexstring

The gender of the enrollee.

addressstring

The address of the enrollee.

birthdatestring date

The birthdate of the enrollee.

status'AA' | 'IA' | 'SX' | 'XX' | 'PP' | 'WP' 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 (PENDING), WP (WAITING PERIOD).

parent_insurance_nostring

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

parent_relationshipstring

The relationship between the enrollee and the principal enrollee.

photo_base64_stringstring

A base64 encoded image string.

client_idinteger

The id of the HMO client.

primary_provider_idinteger

The id of the primary provider.

primary_provider_codestring

The code of the primary provider.

middle_namestring

The middle name of the enrollee.

staff_numberstring

The staff number of the enrollee.

Response

Success

enrollee_idinteger

Changes

No recorded changes to this operation across all 1 revision of this API.