API Reference

GET insurance beneficiaries

URL: {{base_url}}/providers/{{provider-id}}/clients/{{client-id}}/beneficiaries?search=Michael

Search value can be: first_name, last_name, mr_number, email, or mobile of a patient account benefactor

{
    "success": true,
    "message": "Operation successful",
    "meta": {
        "current": 1,
        "page_size_query": "page_size",
        "next": null,
        "previous": null,
        "page_size": 50,
        "total": 1
    },
    "results": [
        {
            "id": 17xxx,
            "uuid": "bd263af9-c255-476f-90c3-68f05dd31ad3",
            "account": xxxxxx,
            "patient": xxxxx,
            "mr_number": "NMC-xxxx",
            "mobile": "+23324xxx3",
            "email": "[email protected]",
            "relationship": "DEPENDENT",
            "is_active": true,
            "first_name": "Michael  Laryea",
            "last_name": "Adjei",
            "other_names": null,
            "policy_name": "20%",
            "contribution_type": "COINSURANCE",
            "managing_organization": "xxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxxd",
            "health_policy": "20%",
            "out_of_pocket_limit_currency": "GHS",
            "contribution_value": "20.00",
            "contribution_currency": "GHS",
            "birth_date": "xxxx-xx-xx",
            "card_no": "4xx/3xxxx66",
            "policy_holder": "BENJAMIN ADJEI",
            "period_start": "xxxx-01-01",
            "period_end": "xxxx-09-xx",
            "gender": "MALE"
        }
    ]
}