Consent Services APIs

Get OTP Contact

Endpointhttps://ilm-dev.dha.go.ke/uat-middleware/api/v1

Endpoints for retrieving beneficiary contact details.

Get patient contacts

GET

https://ilm-dev.dha.go.ke/uat-middleware/api/v1

/patients/contacts

Retrieves a list of contacts associated with a patient

Related documentation: Get Beneficiary Valid Contact

Get patient contacts › query Parameters

patient_id

string · required

Patient's client registry ID. Example value is dummy data.

Example: CR2594484249725-2

Get patient contacts › Responses

count

integer

object[]

GET/patients/contacts

curl --request GET \
  --url 'https://ilm-dev.dha.go.ke/uat-middleware/api/v1/patients/contacts?patient_id=%3Cstring%3E'

shell

Example Responses

{
  "count": 0,
  "results": [
    {
      "active": true,
      "contactType": "contactType",
      "contactValue": "contactValue",
      "id": 0,
      "isConfirmed": true
    }
  ]
}

json

application/json

Send OTP OTP Whitelist