> ## Documentation Index > Fetch the complete documentation index at: https://ekacare-mintlify-697c363f.mintlify.site/llms.txt > Use this file to discover all available pages before exploring further. # Get Started > Complete implementation guide for the ABHA[Ayushman Bharat Digital Mission] SDK # ABHA SDK - Implementation This guide provides everything you need to integrate the ABHA SDK into your application. ## Overview The ABHA SDK allows you to integrate flows—such as Create ABHA, Login, Profile KYC, Consent Management, and Scan & Share—into your healthcare application, while offering customizable theme options. It provides: * **Create ABHA**: Create a new ABHA using Mobile or Aadhaar. * **Login with ABHA**: Login to your exisiting ABHA using PHR Address, ABHA number, Aadhaar number or Mobile number. * **ABHA Consent Management**: Manage Consent requests raised by healthcare providers to share medical records securely. * **ABHA Profile KYC**: Get your ABHA address KYC verified. * **ABHA Scan & Share**: Get your Appointments Booked through ABHA. * **Customizing the Theme**: Customize the ABHA SDK colors to match your application's branding. ## Installation ### Prerequisites * A modern web browser. * Your domain must be whitelisted with Eka Care to avoid CORS(Cross-Origin Resource Sharing) error. (Contact Eka Care to request API access and domain whitelisting.) * A valid HTML container element where the SDK will mount. ### Setup Add the following HTML and script tags to your webpage: For staging/dev environments, replace the SDK URLs with: * **JS:** `https://unpkg.com/@eka-care/abha-stg/dist/sdk/abha/js/abha.js` * **CSS:** `https://unpkg.com/@eka-care/abha-stg/dist/sdk/abha/css/abha.css` ```html theme={null} ABHA SDK Integration

ABHA SDK Demo

``` ## Core Functions ### 1. initAbhaApp Initializes and renders the ABHA SDK in your specified container. **Parameters:** | Name | Type | Required | Description | | ---------------------------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | ----------- | -------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------------- | | `containerId` | `string` | ✅ | The HTML element ID where the SDK will mount. | | `clientId` | `string` | ✅ | Provide clientId as `ext`. | | `data` | `{`
`accessToken: string;`
`hipId: string;`
`oid?: string;`
`identifier?: string;`
`identifier_type?: string;`
`counter_id?: string;`
`consent_id?: string;`
`flow?: string;`
`orgIconUrl?: string;`
`linkToOrgIcon?: string;`
`skipABHAEnable?: boolean;`
`}` | ⚙️ Optional | Configuration data for initializing the ABHA flow.

- accessToken: Pass the access token you have generated from [Connect Login ](https://developer.eka.care/api-reference/authorization/client-login) API without the word `Bearer`.
- hipId: Pass the HFR ID you have.
- oid: Pass oid of patient if available / needed in the flow.
- identifier: Pass the login identifier value i.e. mobile number / aadhaar number / phr address / abha number.
- identifier\_type: Pass the type of identifier which you passed in `identifier` key i.e. "mobile" / "aadhaar\_number" / "phr\_address" / "abha\_number" /. If not known pass undefined.
- counter\_id: Pass the HIP code of the facility you have.
- consent\_id: Pass the consent\_id of the consent request raised.
- flow: Pass the type of flow for which you want to use SDK for i.e. `abha-kyc` for KYC flow / `consent` for Consent flow.
- orgIconUrl: Public CDN URL of the logo of your organisation url should start with https\://. [Example](https://cdn.eka.care/vagus/cl5jgf0u500070shaetqw0r5l.png)
- linkToOrgIcon: Public CDN URL of the icon representing “Link ABHA to your organisation” url should start with https\://. [Example](https://cdn.eka.care/vagus/cm6agrs5000090tfwfz984x5b.webp)
- skipABHAEnable: Pass the boolean as true if you want Skip ABHA button to be enabled on login screen.

`keys with ? are optional and needs to be passed as per flow requirement.` | | `theme` | `object` | ⚙️ Optional | Color token overrides to match your organisation's design system. All keys are optional — only supply the tokens you want to change. [Refer here](https://developer.eka.care/SDKs/web-sdk/abha-sdk/abha-sdk-theme) | | `onSuccess` | `(params: TOnAbhaSuccessParams) => void` | ✅ | Triggered when the user successfully creates or logs in to ABHA. | | `onKYCSuccess` | `(params: TOnAbhaKycSuccessParams) => void` | ⚙️ Optional | Triggered when the user KYC verified successfully. | | `onConsentSuccess` | `(params: TOnAbhaConsentSuccessParams) => void` | ⚙️ Optional | Triggered when the consent flow completes successfully. | | `onAppointmentBookedSuccess` | `(params: TOnAbhaSnSAppointmentSuccessParams) => void` | ✅ | Triggered when the Appointment is booked and token gets generated successfully. | | `onSkipAbha` | `(params: TOnSkipABHA) => void` | ⚙️ Optional | Triggered if the ABHA flow is skipped. | | `onAbhaClose` | `() => void` | ✅ | Triggered when SDK closes. | | `onError` | `(params: TOnAbhaFailureParams) => void` | ✅ | Triggered when an error occurs during the ABHA flow. | ## Callback Parameters ### onSuccess Callback The onSuccess callback is triggered when the ABHA flow completes successfully. It returns verified user details and tokens, which can be used to log in or continue the user’s session. **Callback Signature:** ```typescript theme={null} onSuccess: (params: TOnAbhaSuccessParams) => void; ``` **Type Definitions** ```typescript theme={null} type TOnAbhaSuccessParams = { response: TAuthVerifyV2Response; }; type TAuthVerifyV2Response = { skip_state: number; method: AUTH_METHOD; data?: { tokens: { sess: string; refresh: string; }; profile: TProfileRecord; }; txn_id: string; error?: { code: number; message: string; }; }; enum AUTH_METHOD { EMAIL = 1, MOBILE = 2, ABHA = 7, } type TProfileRecord = { fln: string; fn: string; mn?: string; ln?: string; gen?: "M" | "F" | "O" | "U" | undefined; // 'male' | 'female' | 'other' | 'unknown' dob?: string; mobile?: string; email?: string; uuid?: string; bloodgroup?: "" | "A+" | "A-" | "B+" | "B-" | "O+" | "O-" | "AB+" | "AB-"; pic?: string; as?: string; "dob-valid"?: boolean; "is-d"?: boolean; "is-d-s"?: boolean; "is-p"?: boolean; oid: string; at: string; type?: 1 | 2 | 3 | 4 | 5 | 6; "health-ids"?: Array; abha_number?: string; kyc_verified?: boolean; }; ``` **Parameters** | Key | Type | Description | | ---------- | ----------------------- | ---------------------------------------------------------------------------------------------------------- | | `response` | `TAuthVerifyV2Response` | The complete ABHA verification response, containing session tokens, user profile, and transaction details. | **Example:** ```javascript theme={null} const onSuccess = (params) => { console.log("ABHA Success:", params.response); const abhaNumber = params.response.data?.profile?.abha_number; const userName = params.response.data?.profile?.name; alert(`Welcome ${userName}! Your ABHA Number: ${abhaNumber}`); // Optionally pass data to native bridge if available if (window.EkaAbha) { window.EkaAbha.onAbhaSuccess(JSON.stringify(params)); } }; ``` ### onKYCSuccess Callback The onKYCSuccess callback is triggered when the ABHA KYC flow completes successfully. It returns a confirmation message indicating that the KYC has been verified. **Callback Signature:** ```typescript theme={null} onKYCSuccess: (params: TOnAbhaKycSuccessParams) => void; ``` **Type Definitions** ```typescript theme={null} type TOnAbhaKycSuccess = string; ``` **Parameters** | | Type | Description | | ------------------- | -------- | ----------------------------------------------------- | | `TOnAbhaKycSuccess` | `string` | A confirmation message from SDK post KYC verification | **Example:** ```javascript theme={null} const onKYCSuccess = (params) => { console.log("KYC verification Success:", params); alert("KYC was verified successfully!"); // Optionally pass data to native bridge if available if (window.EkaAbha) { window.EkaAbha.onAbhaKYCSuccess(params); } }; ``` ### onConsentSuccess Callback The onConsentSuccess callback is triggered when the ABHA Consent flow completes successfully. It returns a confirmation message indicating that the Consent flow ended successfully. **Callback Signature:** ```typescript theme={null} onConsentSuccess: (params: TOnAbhaConsentSuccessParams) => void; ``` **Type Definitions** ```typescript theme={null} type TOnAbhaConsentSuccessParams = string; ``` **Parameters** | | Type | Description | | ----------------------------- | -------- | ------------------------------------------------------------ | | `TOnAbhaConsentSuccessParams` | `string` | A confirmation message from SDK post Consent flow completion | **Example:** ```javascript theme={null} const onConsentSuccess = (params) => { console.log("Consent Flow completed:", params); alert("Consent flow completed successfully!"); // Optionally pass data to native bridge if available if (window.EkaAbha) { window.EkaAbha.onAbhaConsentSuccess(params); } }; ``` ### onAppointmentBookedSuccess Callback The onAppointmentBookedSuccess callback is triggered when the appointment is booked and token gets generated successfully. It returns a confirmation message indicating that the Appointment is booked. **Callback Signature:** ```typescript theme={null} onAppointmentBookedSuccess: (params: TOnAbhaSnSAppointmentSuccessParams) => void; ``` **Type Definitions** ```typescript theme={null} type TOnAbhaSnSAppointmentSuccess = string; ``` **Parameters** | | Type | Description | | ---------------------------- | -------- | ----------------------------------------------------------------- | | `onAppointmentBookedSuccess` | `string` | A confirmation message from SDK post Appointment Token generation | **Example:** ```javascript theme={null} const onAppointmentBookedSuccess = (params) => { console.log("Appointment Booked successfully!:", params); alert("Appointment Booked successfully!"); // Optionally pass data to native bridge if available if (window.EkaAbha) { window.EkaAbha.onAppointmentBookedSuccess(params); } }; ``` ### onSkipAbha Callback The onSkipAbha callback is triggered when the ABHA SDK flow is skipped. The callback is functional when skipABHAEnable is set to true in the data parameter while initializing the SDK. **Callback Signature:** ```typescript theme={null} onSkipAbha: (params: TOnSkipABHA) => void; ``` **Example:** ```javascript theme={null} const onSkipAbha = (params) => { console.log("ABHA SDK Skipped:", params); }; ``` **Type Definitions** ```typescript theme={null} type IdentifierType = | "mobile" | "aadhaar_number" | "abha_number" | "phr_address"; type TOnSkipABHA = { identifier?: string; identifier_type?: IdentifierType[]; // No default value here }; ``` **Parameters** | Key | Type | Description | | ----------------- | ------------------- | ------------------------------------------------- | | `identifier` | `string?` | It will be login identifier value filled by user. | | `identifier_type` | `IdentifierType[]?` | It will be type of login identifier. | ### onAbhaClose Callback The onAbhaClose callback is triggered when the ABHA SDK flow gets closed. **Callback Signature:** ```typescript theme={null} onAbhaClose: () => void; ``` **Example:** ```javascript theme={null} const onAbhaClose = () => { console.log("ABHA SDK Closed"); }; ``` ### onError Callback The onError callback is triggered whenever an ABHA flow fails or is interrupted. It provides details about the failure through structured parameters, allowing you to handle or forward the error appropriately (for example, to native apps or monitoring tools). **Callback Signature:** ```typescript theme={null} onError: (params: TOnAbhaFailureParams) => void; ``` **Type Definitions** ```typescript theme={null} type TOnAbhaFailureParams = { error?: string; response?: TAuthVerifyV2Response; }; type TAuthVerifyV2Response = { skip_state: number; method: AUTH_METHOD; data?: { tokens: { sess: string; refresh: string; }; profile: TProfileRecord; }; txn_id: string; error?: { code: number; message: string; }; }; enum AUTH_METHOD { EMAIL = 1, MOBILE = 2, ABHA = 7, } type TProfileRecord = { fln: string; fn: string; mn?: string; ln?: string; gen?: "M" | "F" | "O" | "U" | undefined; // 'male' | 'female' | 'other' | 'unknown' dob?: string; mobile?: string; email?: string; uuid?: string; bloodgroup?: "" | "A+" | "A-" | "B+" | "B-" | "O+" | "O-" | "AB+" | "AB-"; pic?: string; as?: string; "dob-valid"?: boolean; "is-d"?: boolean; "is-d-s"?: boolean; "is-p"?: boolean; oid: string; at: string; type?: 1 | 2 | 3 | 4 | 5 | 6; "health-ids"?: Array; abha_number?: string; kyc_verified?: boolean; }; ``` **Parameters** | Key | Type | Description | | ---------- | ------------------------ | ---------------------------------------------------------------- | | `error` | `string?` | Short description of the failure or error message. | | `response` | `TAuthVerifyV2Response?` | Partial or full API response object returned from ABHA services. | **Example:** ```javascript theme={null} const onError = (params) => { console.error("ABHA Error:", params); if (params.response?.error?.code === 1001) { alert("Authentication failed. Please try again."); } else if (params.error === "NETWORK_ERROR") { alert("Please check your internet connection."); } else { alert("Something went wrong. Please retry."); } // Forward the error to native handler if available if (window.EkaAbha) { window.EkaAbha.onAbhaFailure(JSON.stringify(params)); } }; ``` **Suggest Handling** * Always log the full error response (params) for debugging. * Display friendly error messages for known error.code values. * If params.response is present, inspect response.error.message for more detail. * If integrating with native apps, forward the serialized error object: ```javascript theme={null} window.EkaAbha.onAbhaFailure(JSON.stringify(params)); ``` ## Container Styling Ensure your container has sufficient space: ```html theme={null}

``` ## Troubleshooting ### Common Issues #### 1. SDK Not Rendering **Problem**: Nothing appears in the container. **Solution**: * Ensure containerId matches an existing HTML element. * Verify the SDK JS and CSS are correctly loaded. * Check browser console for errors. #### 2. APIs Not Being Called **Problem**: API requests are not triggered after the SDK is mounted. **Solution**: * Ensure that the accessToken is passed correctly (do not include the Bearer prefix) and that the token has not expired. * To prevent CORS-related issues, ensure that your domain is whitelisted. #### 3. Callback Not Triggered **Problem**: onSuccess, onError, onKYCSuccess, onConsentSuccess, onAbhaClose isn’t firing. **Solution**: * Make sure callbacks are passed as valid functions. * Avoid race conditions (e.g., calling before SDK fully loads). #### 4. Styling Issues **Problem**: SDK content appears misaligned or clipped. **Solution**: * Give your container a fixed height (e.g., 600px). * Ensure no parent element uses overflow: hidden.