Skip to main content

Add an Insurer Client

POST 
/v1/clients

Add an Insurer Client

Request​

Body

required
    name stringrequired

    The name of the Client.

    phone stringrequired

    The phone number of the Client.

    email stringrequired

    The email address of the Client.

    address stringrequired

    The address of the Client.

    city stringrequired

    The city of the Client.

    selected_lga_id integerrequired

    The ID of the Local Government Area of the Client.

    selected_state_id integerrequired

    The ID of the State of the Client.

    selected_country_id integerrequired

    The ID of the Country of the Client.

    status integerrequired

    Possible values: [1, 0, -1]

    The status of the Client. Possible values are: 1 (ACTIVE), 0 (INACTIVE), -1 (TERMINATED).

    id_from_hmo string

    This is the unique reference code of the Client generated by the Insurer. For some select insurer this code will be automatically generated by us, otherwise it needs to be provided.

    hmo_plan_ids integer[]required

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

    registration_date string

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

    other_business_type string

    The relationship between the enrollee and the principal enrollee.

    other_business_sector string

    A base64 encoded image string.

    generate_credentials boolean

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

Responses​

Success Message

Loading...