Endpoint for creating authorizations using biometrics or OTP.
Retrieve an existing authorization
Retrieves an existing authorization for a patient using the provided token, beneficiary code, and GUID.
query Parameters
tokenAuthorization token linked to the patient's consent.
guidUnique identifier (GUID) of the authorization record.
beneficiary_codeThe beneficiary's identifier code.
Retrieve an existing authorization › Responses
Authorization retrieved successfully
authCodeauthorizationReasonauthorizationTypeauthorizingDeviceOsbeneficiarybeneficiaryCodebeneficiaryJoinDatebeneficiaryNamebeneficiaryNumberbeneficiarySchemebenefitTypebiometricMatchLogIdcreatedByNamecreated_bydateAuthorizedekycTokenendDateendedViaexpiryguardianguididisBiometricsDischargeAuthorizationisCompleteisElectiveisEmergencyisOpenlabelneedsPreauthnotesoverallPreauthFinalisedparentAuthorizationparentTypepayerNamepayerSladeCodeproviderproviderFidproviderNamerequestedBysessionTypeshaGuidshaVerificationRequestIdstatustokenupdated_byworkStationIdCreate a new authorization (OTP or biometrics)
Creates a new authorization by capturing patient consent via OTP or biometrics. Use the OTP strategy for standard outpatient and inpatient consent; use the biometrics strategy (eKYC or fingerprint) when the facility has a registered hardware agent. The same endpoint is used across claims creation and consent workflows.
Create a new authorization (OTP or biometrics) › Request Body
Decision Table
| Variant | Matching Criteria |
|---|---|
| type = object · requires: patient_id, service_type, otp +1 more | |
| type = object · requires: agent_id, authorizing_device_os, ekyc_provider_id +9 more |
patient_idThe patient's Client Registry identifier.
service_typeType of service being authorized.
otpOne-time password delivered to the patient's registered phone number.
interventionsList of intervention codes for the services being requested in this visit.
Create a new authorization (OTP or biometrics) › Responses
Authorization created successfully
authCodeauthorizationReasonauthorizationTypeauthorizingDeviceOsbeneficiarybeneficiaryCodebeneficiaryJoinDatebeneficiaryNamebeneficiaryNumberbeneficiarySchemebenefitTypebiometricMatchLogIdcreatedByNamecreated_bydateAuthorizedekycTokenendDateendedViaexpiryguardianguididisBiometricsDischargeAuthorizationisCompleteisElectiveisEmergencyisOpenlabelneedsPreauthnotesoverallPreauthFinalisedparentAuthorizationparentTypepayerNamepayerSladeCodeproviderproviderFidproviderNamerequestedBysessionTypeshaGuidshaVerificationRequestIdstatustokenupdated_byworkStationId