Endpoint for creating authorizations using biometrics or OTP.
Create 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.
Related documentation: Start Visit Workflow, Biometrics Integration
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 | |
| type = object · requires: interventions, is_biometrics_discharge_authorization, is_emergency +5 more |
patient_idThe patient's Client Registry identifier. Dummy example — obtain a real value from the Patient Search API.
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
authCodeauthorizationReasonauthorizationTypeauthorizingDeviceOsbeneficiarybeneficiaryCodebeneficiaryJoinDatebeneficiaryNamebeneficiaryNumberbeneficiarySchemebenefitTypebiometricMatchLogIdcreated_bydateAuthorizedekycTokenendDateexpiryguardianguididisBiometricsDischargeAuthorizationisCompleteisElectiveisEmergencyisOpenlabelneedsPreauthnotesoverallPreauthFinalisedparentAuthorizationparentTypeproviderproviderFidproviderNamerequestedBysessionTypeshaGuidshaVerificationRequestIdstatustokenupdated_byworkStationId