Skip to main content
POST
Preview Pre-auth Bundle

Authorizations

Authorization
string
header
required

The API requires a Bearer token (JWT) for authentication.

Headers

X-Pt-Id
string

Eka User ID (OID)

X-Partner-Pt-Id
string

Partner User ID

X-Hip-Id
string

Partner HIP ID

Body

application/json
abha_number
string
required
member_id
string
required
payer_id
string
required

Required identifiers

request_type
string
required

"InitialRequest" | "FollowUp" | "Enhancement"

accident_info
object

Accident details (optional conditional form section)

admission_type
string

The NDHM claim-type code: "OPD", "IPD", or "EMR". Defaults to "OPD".

auth_type
string

Beneficiary authentication. AuthType "consent" (default) sends the Authentication Consent Questionnaire response (Consent) and OMITS the biometric X-Token; "biometric" sends UserToken as the X-Token. The payer requires one or the other.

case_number
string

An OPTIONAL override for the pre-auth case / intimation number sent as Claim.identifier. PMJAY does not issue a case number at eligibility or pre-auth, so this is normally left blank and a random UUID is generated. Provide it only if a specific value must be used (e.g. resubmission/enhancement referencing an earlier pre-auth).

clinical_notes
string

Authentication Consent Questionnaire response

diagnosis
object[] | null

Clinical (form inputs)

documents
object[]

Documents (file uploads from form)

estimated_amount
number
hfr_facility_id
string
hospital_address
string
hospital_name
string
items
object[]

NHCX procedure items with stratification (preferred over ServiceCodes in the NHCX flow).

participant_id
string

set server-side from auth token

patient_details
object
planned_end_date
null | string<date-time>
planned_start_date
null | string<date-time>

ISO 8601 — parsed from frontend datetime-local

priority
string

"normal" | "urgent" | "stat"

procedure_codes
string[]
product_id
string

NHCX plan identifiers — used to auto-enrich Items from the plan DB.

product_name
string
provider_id
string

Provider & patient (auto-populated by SDK from store; optional for backward compat)

provider_name
string
remarks
string
service_breakdown
object[]

Cost estimate (auto-filled from package)

service_codes
string[] | null

Procedure & dates (form inputs)

treating_doctor
object

Care team (form inputs)

user_token
string

biometric User Token (30-min), used when AuthType=biometric

Response

OK

{key}
any