Insurer Clients

Add an Insurer Client

post/v1/clients

Request

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

Request body

namestring required

The name of the Client.

phonestring

The phone number of the Client.

emailstring required

The email address of the Client.

addressstring

The address of the Client.

citystring

The city of the Client.

selected_lga_idinteger

The ID of the Local Government Area of the Client.

selected_state_idinteger

The ID of the State of the Client.

selected_country_idinteger

The ID of the Country of the Client.

status'active' | 'inactive' | 'terminated' required

The status of the Client. Possible values are: active, inactive, terminated.

client_codestring

Client code for the insurer client record.

id_from_hmostring

Optional insurer-provided reference ID for the client.

hmo_plan_idsinteger[] required

This is an array HMO/Insurer Plan IDs associated with the Client.

registration_datestring

The date of registration of the Client, in the format YYYY-MM-DD.

other_business_typestring

The relationship between the enrollee and the principal enrollee.

other_business_sectorstring

A base64 encoded image string.

generate_credentialsboolean

If true, a new user account would also be created for the with a temporary password. Credentials would be forwarded in a mail notification.

Response

Success Message

Changes

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