Consent Services APIs

OTP Whitelist

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

Endpoints for managing OTP whitelist requests for beneficiaries.

Create an OTP whitelist request

POST

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

/patients/otp-whitelists

Create an OTP whitelist request for a patient via multipart/form-data submission.

Related documentation: Create OTP Whitelist Request

Create an OTP whitelist request › 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

Create an OTP whitelist request › Request Body

beneficiary_cr_id

string

Patient client registry number. Example value is dummy data.

Example: CR2594484249725-2

reason_type

string · enum

Reason type for the OTP whitelist request.

Enum values:

OTHER

OLD

AMPUTEE

EXPIRED

MEDICAL_CONDITION

BIOMETRIC_FAILURE

CHILD_BELOW_7_YEARS

MENTALLY_UNSTABLE

Example: BIOMETRIC_FAILURE

reason

string

Reason text for the OTP whitelist request.

Example: Patient's fingerprints could not be captured after multiple attempts.

biometric_attempts

string

Number of biometric attempts already made.

Example: 3

facility_fr_code

string

Facility registry code.

Example: FID-47-108521-3

object[]

Attachment metadata, sent as a JSON-encoded string in the multipart form. Each entry's file_field_name references a separate binary file part in the same request.

Create an OTP whitelist request › Responses

OTP whitelist request created successfully

object[]

beneficiaryCrId

string

beneficiaryName

string

facilityFrCode

string

facilityName

string

guid

string

reason

string

reasonType

string

reviewedByUser

string

reviewerResponseNotes

string[]

status

string

POST/patients/otp-whitelists

curl --request POST \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/patients/otp-whitelists \
  --header 'Content-Type: multipart/form-data' \
  --form beneficiary_cr_id=CR2594484249725-2 \
  --form reason_type=OTHER \
  --form 'reason=Patient'\''s fingerprints could not be captured after multiple attempts.' \
  --form biometric_attempts=3 \
  --form facility_fr_code=FID-47-108521-3 \
  --form 'attachments={"document_title":"Support doc","document_type":"MEDICAL_REPORT","file_field_name":"attachments_file_blob"}'

shell

Example Request Body

{
  "beneficiary_cr_id": "CR2594484249725-2",
  "reason_type": "OTHER",
  "reason": "Patient's fingerprints could not be captured after multiple attempts.",
  "biometric_attempts": "3",
  "facility_fr_code": "FID-47-108521-3",
  "attachments": [
    {
      "document_title": "Support doc",
      "document_type": "MEDICAL_REPORT",
      "file_field_name": "attachments_file_blob"
    }
  ]
}

json

Example Responses

{
  "attachments": [
    {
      "contentType": "contentType",
      "description": "description",
      "guid": "guid",
      "uploadedFile": "uploadedFile"
    }
  ],
  "beneficiaryCrId": "beneficiaryCrId",
  "beneficiaryName": "beneficiaryName",
  "facilityFrCode": "facilityFrCode",
  "facilityName": "facilityName",
  "guid": "guid",
  "reason": "reason",
  "reasonType": "reasonType",
  "reviewedByUser": "reviewedByUser",
  "reviewerResponseNotes": [
    "string"
  ],
  "status": "status"
}

json

application/json

Callback for OTP whitelist request for a particular patient or a given guid

GET

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

/patients/otp-whitelists/callback

Get a list of OTP whitelist requests related to a particular patient

Related documentation: Get OTP Whitelist Request

Callback for OTP whitelist request for a particular patient or a given guid › query Parameters

beneficiary_cr_id

string

Patient client registry number. Example value is dummy data.

Example: CR2594484249725-2

guid

string

OTP Whitelist guid

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

facility_fr_code

string

Facility registry code

Example: FID-47-108521-3

Callback for OTP whitelist request for a particular patient or a given guid › 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

Callback for OTP whitelist request for a particular patient or a given guid › Responses

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

GET/patients/otp-whitelists/callback

curl --request GET \
  --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/patients/otp-whitelists/callback

shell

Example Responses

{
  "count": 0,
  "currentPage": 0,
  "endIndex": 0,
  "next": "next",
  "pageSize": 0,
  "previous": "previous",
  "results": [
    {
      "beneficiaryCrId": "beneficiaryCrId",
      "beneficiaryName": "beneficiaryName",
      "biometricsAttempt": 0,
      "created": "created",
      "facilityFrCode": "facilityFrCode",
      "facilityName": "facilityName",
      "guid": "guid",
      "reason": "reason",
      "reasonType": "reasonType",
      "reviewedByUser": "reviewedByUser",
      "reviewerResponseNotes": [
        {
          "responseNotes": "responseNotes"
        }
      ],
      "status": "status"
    }
  ],
  "startIndex": 0,
  "totalPages": 0
}

json

application/json

Get OTP Contact Minors Biometrics

Create an OTP whitelist request

POST

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

/patients/otp-whitelists

Create an OTP whitelist request for a patient via multipart/form-data submission.

Related documentation: Create OTP Whitelist Request

Create an OTP whitelist request › 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

Create an OTP whitelist request › Request Body

beneficiary_cr_id

string

Patient client registry number. Example value is dummy data.

Example: CR2594484249725-2

reason_type

string · enum

Reason type for the OTP whitelist request.

Enum values:

OTHER

OLD

AMPUTEE

EXPIRED

MEDICAL_CONDITION

BIOMETRIC_FAILURE

CHILD_BELOW_7_YEARS

MENTALLY_UNSTABLE

Example: BIOMETRIC_FAILURE

reason

string

Reason text for the OTP whitelist request.

Example: Patient's fingerprints could not be captured after multiple attempts.

biometric_attempts

string

Number of biometric attempts already made.

Example: 3

facility_fr_code

string

Facility registry code.

Example: FID-47-108521-3

object[]

Attachment metadata, sent as a JSON-encoded string in the multipart form. Each entry's file_field_name references a separate binary file part in the same request.

Create an OTP whitelist request › Responses

OTP whitelist request created successfully

object[]

beneficiaryCrId

string

beneficiaryName

string

facilityFrCode

string

facilityName

string

guid

string

reason

string

reasonType

string

reviewedByUser

string

reviewerResponseNotes

string[]

status

string

curl --request POST \ --url https://ilm-dev.dha.go.ke/uat-middleware/api/v1/patients/otp-whitelists \ --header 'Content-Type: multipart/form-data' \ --form beneficiary_cr_id=CR2594484249725-2 \ --form reason_type=OTHER \ --form 'reason=Patient'\''s fingerprints could not be captured after multiple attempts.' \ --form biometric_attempts=3 \ --form facility_fr_code=FID-47-108521-3 \ --form 'attachments={"document_title":"Support doc","document_type":"MEDICAL_REPORT","file_field_name":"attachments_file_blob"}'

{ "beneficiary_cr_id": "CR2594484249725-2", "reason_type": "OTHER", "reason": "Patient's fingerprints could not be captured after multiple attempts.", "biometric_attempts": "3", "facility_fr_code": "FID-47-108521-3", "attachments": [ { "document_title": "Support doc", "document_type": "MEDICAL_REPORT", "file_field_name": "attachments_file_blob" } ] }

{ "attachments": [ { "contentType": "contentType", "description": "description", "guid": "guid", "uploadedFile": "uploadedFile" } ], "beneficiaryCrId": "beneficiaryCrId", "beneficiaryName": "beneficiaryName", "facilityFrCode": "facilityFrCode", "facilityName": "facilityName", "guid": "guid", "reason": "reason", "reasonType": "reasonType", "reviewedByUser": "reviewedByUser", "reviewerResponseNotes": [ "string" ], "status": "status" }

Callback for OTP whitelist request for a particular patient or a given guid

GET

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

/patients/otp-whitelists/callback

Get a list of OTP whitelist requests related to a particular patient

Related documentation: Get OTP Whitelist Request

Callback for OTP whitelist request for a particular patient or a given guid › query Parameters

beneficiary_cr_id

string

Patient client registry number. Example value is dummy data.

Example: CR2594484249725-2

guid

string

OTP Whitelist guid

Example: 3f2504e0-4f89-41d3-9a0c-0305e82c3301

facility_fr_code

string

Facility registry code

Example: FID-47-108521-3

Callback for OTP whitelist request for a particular patient or a given guid › 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

Callback for OTP whitelist request for a particular patient or a given guid › Responses

count

integer

currentPage

integer

endIndex

integer

next

string

pageSize

integer

previous

string

object[]

startIndex

integer

totalPages

integer

{ "count": 0, "currentPage": 0, "endIndex": 0, "next": "next", "pageSize": 0, "previous": "previous", "results": [ { "beneficiaryCrId": "beneficiaryCrId", "beneficiaryName": "beneficiaryName", "biometricsAttempt": 0, "created": "created", "facilityFrCode": "facilityFrCode", "facilityName": "facilityName", "guid": "guid", "reason": "reason", "reasonType": "reasonType", "reviewedByUser": "reviewedByUser", "reviewerResponseNotes": [ { "responseNotes": "responseNotes" } ], "status": "status" } ], "startIndex": 0, "totalPages": 0 }