Consent Services APIs

Send OTP

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

Endpoints for sending OTP to beneficiaries.

Send a visit OTP to the beneficiary

POST

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

/claims/otp

Sends a one-time password to the beneficiary's registered contact, used to authorize starting a visit in the OTP flow.

Related documentation: Send OTP

Send a visit OTP to the beneficiary › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Send a visit OTP to the beneficiary › Request Body

Request payload for sending OTP to patient. All fields are required and validated.

intervention_codes

string[] · required

List of SHA intervention codes for the services being authorized in this visit.

Example: ["SHA-18-005"]

patient_id

string · required

The beneficiary's Client Registry identifier (dummy example).

Example: CR2594484249725-2

contact_id

integer

Identifier of the specific registered contact to which the OTP should be sent. When omitted, the beneficiary's primary confirmed contact is used. This ID can be obtained from the Get Beneficiary Contacts endpoint.

Example: 1

Send a visit OTP to the beneficiary › Responses

OTP sent successfully

Standard success response format for all successful operations.

object

@Description Response data payload containing operation details @Example {"status": "success"}

message

string

@Description Success message describing the operation result @Example "Visit has been successfully started"

POST/claims/otp

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/claims/otp \
  --header 'Content-Type: application/json' \
  --data '
{
  "contact_id": 1,
  "intervention_codes": [
    "string"
  ],
  "patient_id": "CR2594484249725-2"
}
'

shell

Example Request Body

{
  "contact_id": 1,
  "intervention_codes": [
    "string"
  ],
  "patient_id": "CR2594484249725-2"
}

json

Example Responses

{
  "data": {},
  "message": "message"
}

json

application/json

Send a discharge OTP to the beneficiary

POST

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

/claims/otp/discharge

Sends a one-time password to the beneficiary's registered contact, used to authorize discharging the patient in the OTP flow.

Related documentation: Send Discharge OTP

Send a discharge OTP to the beneficiary › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Send a discharge OTP to the beneficiary › Request Body

consent_token

string · required

Consent token issued when the visit was authorized, required to authorize the discharge OTP (dummy example).

Example: K5HLPJVDNV

patient_id

string · required

The beneficiary's Client Registry identifier (dummy example).

Example: CR2594484249725-2

Send a discharge OTP to the beneficiary › Responses

OTP sent successfully

Standard success response format for all successful operations.

object

@Description Response data payload containing operation details @Example {"status": "success"}

message

string

@Description Success message describing the operation result @Example "Visit has been successfully started"

POST/claims/otp/discharge

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/claims/otp/discharge \
  --header 'Content-Type: application/json' \
  --data '
{
  "consent_token": "K5HLPJVDNV",
  "patient_id": "CR2594484249725-2"
}
'

shell

Example Request Body

{
  "consent_token": "K5HLPJVDNV",
  "patient_id": "CR2594484249725-2"
}

json

Example Responses

{
  "data": {},
  "message": "message"
}

json

application/json

Status Callbacks Get OTP Contact

Send a visit OTP to the beneficiary

POST

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

/claims/otp

Sends a one-time password to the beneficiary's registered contact, used to authorize starting a visit in the OTP flow.

Related documentation: Send OTP

Send a visit OTP to the beneficiary › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Send a visit OTP to the beneficiary › Request Body

Request payload for sending OTP to patient. All fields are required and validated.

intervention_codes

string[] · required

List of SHA intervention codes for the services being authorized in this visit.

Example: ["SHA-18-005"]

patient_id

string · required

The beneficiary's Client Registry identifier (dummy example).

Example: CR2594484249725-2

contact_id

integer

Example: 1

Send a visit OTP to the beneficiary › Responses

OTP sent successfully

Standard success response format for all successful operations.

object

@Description Response data payload containing operation details @Example {"status": "success"}

message

string

@Description Success message describing the operation result @Example "Visit has been successfully started"

Send a discharge OTP to the beneficiary

POST

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

/claims/otp/discharge

Sends a one-time password to the beneficiary's registered contact, used to authorize discharging the patient in the OTP flow.

Related documentation: Send Discharge OTP

Send a discharge OTP to the beneficiary › Headers

X-Facility-Id

string

Facility Registry (FR) code identifying the facility. Required when authenticating with a service-account token.

Example: FID-47-115307-8

X-Facility-Id-Type

string

Type of identifier supplied in X-Facility-Id. Currently only fr-code is supported.

Example: fr-code

Send a discharge OTP to the beneficiary › Request Body

consent_token

string · required

Consent token issued when the visit was authorized, required to authorize the discharge OTP (dummy example).

Example: K5HLPJVDNV

patient_id

string · required

The beneficiary's Client Registry identifier (dummy example).

Example: CR2594484249725-2

Send a discharge OTP to the beneficiary › Responses

OTP sent successfully

Standard success response format for all successful operations.

object

@Description Response data payload containing operation details @Example {"status": "success"}

message

string

@Description Success message describing the operation result @Example "Visit has been successfully started"