Explore Our Health Insurance APIs
Discover APIs that simplify new business onboarding, policy servicing, renewals, endorsements, and claims — all in one place. Our catalogue is designed for partners, platforms, and developers to integrate seamlessly with ABHI health insurance ecosystem.
API Workflow
Experience an Accelerated and Seamless Digital Journey
Follow this API interaction sequence for a smooth onboarding experience:
-
Initiation via Product Dashboard:
The journey begins with the user accessing the Product Selection Dashboard to obtain an instant preliminary quote and select the desired product.
-
KYC Journey Kickoff:
The Start API triggers the Know Your Customer (KYC) process, with the Communication API instantly sharing the KYC link with the user.
-
KYC Completion and Data Retrieval:
Upon successful KYC completion, the system automatically retrieves verified customer details through the KYC Detail Fetch API and proceeds to generate a refined quote using the updated information.
-
Document Upload and Payment Processing:
KYC documents are seamlessly uploaded to the Document Management System via the Upload API. Upon successful completion, the integrated Payment Gateway ensures swift and secure transaction processing.
-
Final Policy Issuance:
The Full Quote API is invoked to issue the final policy, marking the completion of the digital onboarding journey.
-
Intelligent Retry Mechanism:
In case of KYC failure or drop-off, the system intelligently loops back to reinitiate the KYC process by resending the link, ensuring maximum completion rates and operational efficiency.
Integration Prerequisite
Before initiating integration with our platform, please ensure the following prerequisites are fulfilled. These steps are essential to establish a secure and reliable connection between your systems and ours.
IP Whitelisting
To maintain a secure communication channel, we require all partner server IP addresses to be whitelisted.
Please share the static IPs that will be used to access our services so they can be added to our allowlist.
Please email your IP addresses along with the developer’s full name and official email ID to xxxx@adityabirlacapital.com.
Authentication Setup
Secure access to our APIs and services through API Keys. API Keys are unique keys issued to each partner for identification and access control.Developers will receive their API key as part of the onboarding process
Credentials must be stored securely and rotated periodically as per best practices.
SSL/TLS Certificates
All data exchanged between systems must be encrypted using SSL/TLS protocols. The client should have TLS 1.2 while integrating with our platform.
Environment Access
Partners will be provided with access, each environment has distinct endpoints and credentials, which will be shared during the onboarding process.
- Sandbox/Test Environment: For development and testing purposes.
- Production Environment: Post successful testing and validation.
API Security
Authentication
Azure APIM uses subscription keys (API keys) to authenticate and authorize access to APIs. Each API consumer is issued a unique key, which must be included in the request header or query string.
Header format: Ocp-Apim-Subscription-Key: {your-key}
⚠️ Important Security Note:
Treat your API key like a password. Never expose it in client-side code, public repositories, or unsecured environments. Rotate keys regularly and use policies to restrict access.
Encryption and Decryption
Overview
AES-256 is a symmetric encryption algorithm widely used for secure data encryption. This document outlines the configuration and sample implementations using AES-256 in CBC mode with PKCS5Padding and a 16-byte Initialization Vector (IV).
Key Components
- AES-256: 256-bit symmetric key encryption algorithm
- CBC Mode: Cipher Block Chaining mode for added security
- PKCS5Padding: Padding method used to complete data blocks
- IV: 16-byte Initialization Vector (randomly generated)
Requirements
- Key: Must be 32 bytes (256 bits)
- IV: 16-byte Initialization Vector (randomly generated)
- Block Size: AES block size is always 16 bytes
- Padding: PKCS5Padding (identical to PKCS7 for AES)
- Body: IV in Base64 string prepend to encrypted payload with '.'
Security Note
Never reuse the same IV with the same key.
Always transmit IV along with the payload (concatenated with “.” ).
Overview-Encyption
Secret Key (Encryption Key): Provided statically for UAT and Production environments.
IV (Initialization Vector): Dynamically generated per request.
Encryption Details:
Algorithm: AES
Mode: CBC (Cipher Block Chaining)
Padding: PKCS5Padding
Encryption Steps
STEP 1:Convert Request Body to Bytes
byte[] textinBytes = Encoding.UTF8.GetBytes(requestBodyObject);
STEP 2: Convert the Secret Key to Bytes
byte[] Key = System.Text.Encoding.UTF8.GetBytes(Secret_Key);
Ensure the key length is appropriate for AES (32 for AES-256).
STEP 3: Generate a Random IV
byte[] IV = new byte[16];
using (var rng = new RNGCryptoServiceProvider())
{
rng.GetBytes(IV);
}
STEP 4: Encrypt the Request
Encrypt using AES, CBC mode, PKCS5Padding, Secret Key and IV.
STEP 5: Encode the Encrypted Bytes in Base64
string encryptedBase64 = Convert.ToBase64String(encryptedBytes);
STEP 6: Encode the IV in Base64
string IVBase64 = Convert.ToBase64String(IV);
STEP 7: Compose the Final Encrypted Payload
string finalPayload = IVBase64 + "." + encryptedBase64;
Final Output
<Base64(IV)>.<Base64(EncryptedPayload)>
Security Notes
- Always validate that the key is of valid length (32 bytes).
- Never reuse the IV for multiple encryptions with the same key.
- Store and transmit the IV along with the encrypted data (as done here).
Context-Decryption
You are receiving a payload formatted as:
<Base64(IV)>.<Base64(EncryptedData)>
You will need to:
- Split the string
- Decode both IV and cipher text from Base64
- Use the same Secret Key aka Encryption Key
- Decrypt using AES, CBC, PKCS7 Padding
Decryption Steps
Step 1: Split the Payload
The encrypted payload is a dot-separated string:
<Base64EncodedIV>.<Base64EncodedEncryptedData>
Use Split('.') to extract both parts:
string[] parts = encryptedPayload.Split('.');
string ivBase64 = parts[0];
string encryptedBase64 = parts[1];
Step 2: Decode Base64 Strings
byte[] iv = Convert.FromBase64String(ivBase64);
byte[] encryptedBytes = Convert.FromBase64String(encryptedBase64);
STEP 3: Convert the Secret Key to Bytes
byte[] Key = System.Text.Encoding.UTF8.GetBytes(Secret_Key);
Ensure the key length is appropriate for AES (32 for AES-256).
STEP 4: Decrypt the Response
Decrypt the encryptedBytes using:
- AES
- CBC mode
- PKCS5Padding
- Secret Key and IV
byte[] decryptedBytes = inBytes.Decrypt("Aes", Key, IV);
STEP 5: Final Output
Convert the decryptedBytes into a string and return it:
return Encoding.UTF8.GetString(decryptedBytes);
Generic Error Codes
| Code | Meaning | Description |
| 200 OK |
Success |
The request was successful and returned the expected response. |
| 404 Not Found |
Client Error |
The requested endpoint or resource does not exist. |
| 500 Internal Server Error |
Server Error |
Something went wrong on the server. |
| 429 Too Many Requests |
Client Error |
Rate limit exceeded; slow down your request frequency. |
Activ One
In a world of instant groceries and fingertip finance, accessing insurance tailored to your health & health insurance goals is equally important. Meet Activ One NXT Health Insurance Plan from Aditya Birla Health Insurance — a health insurance plan which aims to provide a seamless personalized experience to enable your journey of health insurance while rewarding you for staying healthy.
Request Payload
| Parent Node |
Field Name |
Data Type |
Data Length |
Mandatory/Non-mandatory |
Business Logic & Validations |
| Client Creation | | Object | | | |
| salutation | string | 5 | Yes | Reference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others |
| firstName | string | 250 | Yes | First name of proposer |
| middleName | string | 250 | No | Middle name of proposer |
| lastName | string | 250 | Yes | Last name of proposer |
| dateofBirth | string | - | Yes | DOB of proposer. Only MM/DD/YYYY Format will be Accepted |
| gender | string | 3 | Yes | Reference Master Value (M, F, T) |
| educationalQualification | string | 20 | No | Reference Master Value (Below Metric, Graduate, etc.) |
| pinCode | string | 25 | Yes | Pincode of Proposer |
| uidNo | string | 30 | No | UID number |
| maritalStatus | string | 10 | Yes | Reference Master Value |
| nationality | string | 200 | Yes | Reference Master Value (Indian, NRI, etc.) |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
Sample Request Payload
{
"ClientCreation": {
"salutation": "Mr",
"firstName": "Dummy",
"middleName": "",
"lastName": "Dummy",
"dateofBirth": "01/01/199",
"gender": "M",
"educationalQualification": "",
"otherEducationalQualification": "",
"emergencyContactName": "",
"emergencyContactNo": "",
"emergencyContactRelation": "",
"pinCode": "491559",
"uidNo": "XXXXXXXXXXXX",
"UIDAcknowledgementNo": "",
"maritalStatus": "Single",
"nationality": "Indian",
"occupation": "Business",
"otherOccupation": "",
"primaryEmailID": "dummy@gmail.com",
"contactMobileNo": "9XXXXXXXXX",
"stdLandlineNo": "",
"panNo": "XXXXXXXXXX",
"passportNumber": "",
"contactPerson": "ABCD ABCD",
"annualIncome": "1000000",
"remarks": "",
"startDate": "",
"endDate": "",
"IdProof": "Pan Card",
"residenceProof": "",
"ageProof": "",
"others": "",
"homeAddressLine1": "S/O: xxx HOUSE NUM 01",
"homeAddressLine2": "XXXXXX",
"homeAddressLine3": "XXXXX",
"homePinCode": 491559,
"homeArea": "",
"homeContactMobileNo": "",
"homeContactMobileNo2": "",
"homeSTDLandlineNo": "",
"homeSTDLandlineNo2": "",
"homeFaxNo": "",
"sameAsHomeAddress": "0",
"mailingAddressLine1": "House Num 01 XXXXXX",
"mailingAddressLine2": "",
"mailingAddressLine3": "",
"mailingPinCode": "491559",
"mailingArea": "",
"mailingContactMobileNo": "",
"mailingContactMobileNo2": "",
"mailingSTDLandlineNo": "",
"mailingSTDLandlineNo2": "",
"mailingFaxNo": "",
"bankAccountType": "",
"bankAccountNo": "9XXXXXXXXXXXX",
"ifscCode": "UTIB0004584",
"GSTIN": "",
"GSTRegistrationStatus": "Consumers",
"WhatsAppNo": "9XXXXXXXXX"
},
"PolicyCreationRequest": {
"Quotation_Number": "",
"Product_Code": "7200",
"Plan_Code": "SAVR",
"SumInsured_Type": "Individual",
"Policy_Tanure": "3",
"Member_Type_Code": "AH01",
"intermediaryCode": "2101502",
"AutoRenewal": "0",
"intermediaryBranchCode": null,
"agentSignatureDate": null,
"Customer_Signature_Date": null,
"businessSourceChannel": null,
"AssignPolicy": "0",
"AssigneeName": null,
"leadID": "587019499",
"Source_Name": "AXIS_NETB",
"SPID": "SP0069566554",
"TCN": "",
"CRTNO": "",
"RefCode1": "361156",
"RefCode2": "4584",
"Employee_Number": "",
"enumIsEmployeeDiscount": "",
"QuoteDate": "10/09/2024",
"IsPayment": "0",
"goGreen": "",
"Tokenized_Customer_Id": "OXXXXXXXXXXXXX",
"App_Id": "SIDDHI",
"familyDoctor": {
"fullName": "",
"qualification": "",
"emailId": "",
"RegistrationNumber": "",
"addressLine1": "",
"addressLine2": "",
"pinCode": "",
"contact_number": ""
},
"PaymentGatewayName": null,
"CKYC_Flag": "Y",
"CKYC_Number": "2XXXXXXXXXXXX",
"Hyper_verge_OPD_Status": "N",
"Digi_Locker_Verified": "N",
"KYC_Transition_Id": "AXXXXXXXXXXXXXX",
"ifPEP": "N",
"Portal_PEP": "N",
"ifAML": "N",
"ifFaceMatch": "N",
"PreIssuanceDate": null,
"PreIssuanceTime": null,
"ABGemployee": "N",
"empID": ""
},
"MemObj": {
"Member": [
{
"MemberNo": "1",
"Salutation": "Mr",
"First_Name": "Dummy",
"Middle_Name": "",
"Last_Name": "Dummy",
"Gender": "M",
"DateOfBirth": "01/01/1990",
"Relation_Code": "R001",
"Marital_Status": "Single",
"Email": "krishna@gmail.com",
"Mobile_Number": "9xxxxxxxxx",
"IdProof": "PAN CARD",
"IdProofNumber": "xxxxxxxxxx",
"height": "165.10",
"weight": "65.00",
"occupation": "Business",
"NatureOfDuty": "Architects",
"Designation": "NA",
"PrimaryMember": "N",
"nameofsurgeryifany": null,
"disabilityPercentage": null,
"PeriodOfHospIfAny": null,
"anyOtherInformation": null,
"optionalCovers": [
{
"optionalCoverName": "Tele – OPD consultation",
"optionalCoverValue": "",
"CoverPartCode": "",
"CoverPartValue": ""
},
{
"optionalCoverName": "Cancer Booster",
"optionalCoverValue": "",
"CoverPartCode": "",
"CoverPartValue": ""
}
],
"productComponents": [
{
"productComponentName": "Conditions",
"productComponentValue": "Non-Chronic"
},
{
"productComponentName": "RoomCategory",
"productComponentValue": "UPTOSI"
},
{
"productComponentName": "SumInsured",
"productComponentValue": "1000000"
},
{
"productComponentName": "Zone",
"productComponentValue": "Z003"
}
],
"Hospi_Obj": [
{
"Hospi_Title": "Mrs",
"Hospi_UserName": "ABCD ABCD",
"Hospi_DOB": "01/01/1980",
"Hospi_Gender": "F",
"Hospi_Age": "44",
"Hospi_RelationWithProposer": "R005"
}
],
"PreviousInsuranceDetails": [],
"MemberPED": [],
"MemberQuestionDetails": [],
"exactDiagnosis": null,
"dateOfDiagnosis": null,
"lastDateConsultation": null,
"detailsOfTreatmentGiven": null,
"doctorName": null,
"hospitalName": null,
"phoneNumberHosital": null,
"labReport": null,
"dischargeCardSummary": null,
"personalHabitDetail": [],
"chronicDiseaseAshma": [],
"chronicDiseaseDiabetes": [],
"chronicDiseaseHighBloodPressure": [],
"chronicDiseaseHighCholesterol": [],
"Nominee_First_Name": "SARASWATI PUSAM",
"Nominee_Last_Name": null,
"Nominee_Contact_Number": "9XXXXXXXX",
"Nominee_Home_Address": null,
"Nominee_Relationship_Code": "R005",
"whetheroccupationrequire": [],
"MemberproductComponents": null,
"ABHA_Verified": "No",
"ABHA_Number": "",
"ABHA_Address": null,
"ABHA_Consent": "No"
}
]
},
"ReceiptCreation": {}
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| PolCreationRespons | quoteNumber | String | Unique identifier for the quote |
| customerId | String | Customer's unique ID |
| Source_Name | String | Source system or channel name |
| productName | String | Name of the insurance product |
| productCode | String | Code representing the product |
| lineOfBusiness | String | Type of insurance business |
| quoteStatus | String | Status of the quote |
| quoteValidFromDate | String (Date) | Start date of quote validity |
| quoteValidToDate | String (Date) | End date of quote validity |
| policyNumber | String | Policy number |
| proposalNumber | String | Proposal number |
| policyStatus | String | Status of the policy |
| tenure | String | Duration of the policy in years |
| stpflag | String | Straight-through processing flag |
| MedicalTestInfo | String | Medical test information |
| premiumDetails | Array | Contains premium-related details |
| Premium | BasePremium | String | Original premium before discounts/loadings |
| NetPremium | String | Premium after discounts |
| ServiceTax | String | Service tax amount |
| SBC | String | Swachh Bharat Cess |
| KKC | String | Krishi Kalyan Cess |
| BMI_loading | String | Loading based on BMI |
| GrossPremium | String | Total premium before final adjustments |
| FinalPremium | String | Final payable premium |
| ErrorObject | errorCode | String | Error code |
| errormessage | String | Error message |
| ReceiptCreationResponse | errorMessage | String | Message indicating success or failure |
| errorNumber | String | Error number |
| ReceiptNumber | String | Receipt number generated |
| ReceiptAmount | String | Amount received |
| ExcessAmount | String | Excess amount if any |
Sample Response Payload
{
"PolCreationRespons": {
"quoteNumber": "QE00041441XXXXX",
"customerId": "PT8768XXXX",
"Source_Name": "AXIS_NETB",
"productName": "Activ One",
"Plan": "",
"productCode": "7200",
"lineOfBusiness": "HEALTH",
"quoteStatus": "IF",
"quoteValidFromDate": "09/11/2024",
"quoteValidToDate": "09/10/2027",
"policyNumber": "31-24-000XXXX-00",
"proposalNumber": "QE0004144XXXXX",
"policyStatus": "IF",
"tenure": "3",
"stpflag": "STP",
"premiumDetails": {
"Premium": {
"BasePremium": "36098",
"RiderAmount": "",
"NetPremium": "32488",
"ServiceTax": "5848",
"SBC": "0",
"KKC": "0",
"BMI_loading": "0.0",
"GrossPremium": "38336",
"FinalPremium": "38336",
"Discount_Amount": "3610",
"Loading_Amount": "0",
"Emi_Amount": ""
}
},
"MedicalTestInfo": "",
"errorList": {
"ErrorObject": {
"errorCode": "0",
"errormessage": ""
}
}
},
"ReceiptCreationResponse": {
"errorMessage": "Sucess ",
"errorNumber": "0",
"ReceiptNumber": "DR-23-24-0XXXXX",
"ReceiptAmount": "74392.0",
"ExcessAmount": ""
}
}
Activ Health
Do you like it when life rewards you for your hard work? How would you feel if your health insurance plan rewarded you for your efforts towards staying healthy?
Presenting the Activ Health Platinum Enhanced Plan that rewards you with up to 100% HealthReturnsTM for staying active and healthy! What is more it partners with you on your health journey with its Chronic Management Program.
Want to know something even more extraordinary? The Activ Health Platinum Enhanced Plan also provides a Sum Insured of up to ₹2 crores along with a host of exceptional benefits.
Request Payload
| Parent Node |
Field Name |
Data Type |
Data Length |
Mandatory/Non-mandatory |
Business Logic & Validations |
| Client Creation | | Object | | | |
| salutation | string | 5 | Yes | Reference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others |
| firstName | string | 250 | Yes | First name of proposer |
| middleName | string | 250 | No | Middle name of proposer |
| lastName | string | 250 | Yes | Last name of proposer |
| dateofBirth | string | - | Yes | DOB of proposer. Only MM/DD/YYYY Format will be Accepted |
| gender | string | 3 | Yes | Reference Master Value (M, F, T) |
| educationalQualification | string | 20 | No | Reference Master Value (Below Metric, Graduate, etc.) |
| pinCode | string | 25 | Yes | Pincode of Proposer |
| uidNo | string | 30 | No | UID number |
| maritalStatus | string | 10 | Yes | Reference Master Value |
| nationality | string | 200 | Yes | Reference Master Value (Indian, NRI, etc.) |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
Sample Request Payload
{
"ClientCreation": {
"salutation": "Mr",
"firstName": "dummy",
"middleName": "dummy",
"lastName": "dummy",
"dateofBirth": "22/05/1996",
"gender": "M",
"educationalQualification": "",
"pinCode": "400605",
"uidNo": "",
"maritalStatus": "Married",
"nationality": "Indian",
"occupation": "dummy",
"primaryEmailID": "dummy@gmail.com",
"contactMobileNo": "7xxxxx",
"stdLandlineNo": "0000000000",
"panNo": "AUKPG5286G",
"passportNumber": "",
"contactPerson": "",
"annualIncome": 500000,
"remarks": "dummy",
"startDate": "24/05/2021",
"endDate": "24/05/2021",
"IdProof": "",
"residenceProof": "",
"ageProof": "",
"others": "",
"homeAddressLine1": "line1",
"homeAddressLine2": "line2",
"homeAddressLine3": "line3",
"homePinCode": "400605",
"homeArea": "area",
"homeContactMobileNo": "0000000000",
"homeContactMobileNo2": "0000000000",
"homeSTDLandlineNo": "",
"homeSTDLandlineNo2": "",
"homeFaxNo": "",
"sameAsHomeAddress": 1,
"mailingAddressLine1": "line1",
"mailingAddressLine2": "line2",
"mailingAddressLine3": "line3",
"mailingPinCode": "400605",
"mailingArea": "area",
"mailingContactMobileNo": "",
"mailingContactMobileNo2": "",
"mailingSTDLandlineNo": "",
"mailingSTDLandlineNo2": "",
"mailingFaxNo": "",
"bankAccountType": "",
"bankAccountNo": "",
"ifscCode": "",
"GSTIN": "",
"GSTRegistrationStatus": "Consumers",
"IsEIAavailable": "0",
"ApplyEIA": "0",
"EIAAccountNo": "",
"EIAWith": "",
"AccountType": "",
"AddressProof": "",
"DOBProof": "",
"IdentityProof": "",
"UIDAcknowledgementNo": ""
},
"PolicyCreationRequest": {
"Quotation_Number": "21400010xxxx",
"Product_Code": 6212,
"Plan_Code": "6212100003",
"SumInsured_Type": "Individual",
"Member_Type_Code": "AH01",
"AutoRenewal": "N",
"intermediaryBranchCode": "10MHMUM02",
"agentSignatureDate": "24/05/2021",
"Customer_Signature_Date": "24/05/2021",
"businessSourceChannel": "",
"Source_Name": "Policy Bazar",
"SPID": "",
"RefCode1": "",
"RefCode2": "",
"TCN": "",
"EmployeeNumber": "",
"EmployeeDiscount": "",
"QuoteDate": "24/05/2021",
"CRTNO": "",
"IsPayment": "1",
"goGreen": 0,
"familyDoctor": {
"fullName": "",
"qualification": "",
"emailId": "",
"RegistrationNumber": "",
"addressLine1": "",
"addressLine2": "",
"pinCode": "",
"contact_number": ""
},
"leadID": "INVI1204201800xxxx",
"intermediaryCode": "2103129",
"Policy_Tanure": "1"
},
"MemObj": {
"Member": [
{
"MemberNo": 1,
"Salutation": "Mr",
"First_Name": "dummy",
"Middle_Name": "dummy",
"Last_Name": "dummy",
"Gender": "M",
"DateOfBirth": "22/05/1999",
"Relation_Code": "R001",
"Marital_Status": "Single",
"height": 167,
"weight": 72.8,
"occupation": "",
"PrimaryMember": "Y",
"optionalCovers": [
{ "optionalCoverName": "Maternity Expenses", "optionalCoverValue": "1000" },
{ "optionalCoverName": "OPD Expenses", "optionalCoverValue": "2000" }
],
"productComponents": [
{ "productComponentName": "Conditions", "productComponentValue": "Non-Chronic" },
{ "productComponentName": "SumInsured", "productComponentValue": "500000" },
{ "productComponentName": "Zone", "productComponentValue": "Z001" },
{ "productComponentName": "RoomCategory", "productComponentValue": "Single Private Room" }
],
"MemberPED": [
{ "PEDCode": "", "Remarks": "" }
],
"exactDiagnosis": "",
"dateOfDiagnosis": "24/05/2021",
"lastDateConsultation": "24/05/2021",
"detailsOfTreatmentGiven": "",
"doctorName": "",
"hospitalName": "",
"phoneNumberHosital": "",
"labReport": "",
"dischargeCardSummary": "",
"personalHabitDetail": [
{ "numberOfYears": "", "count": "", "type": "" }
],
"Nominee_First_Name": "Testtest",
"Nominee_Last_Name": "Test",
"Nominee_Contact_Number": "",
"Nominee_Home_Address": "",
"Nominee_Relationship_Code": "R009"
}
]
},
"ReceiptCreation": {
"officeLocation": "Mumbai",
"modeOfEntry": "DIRECT",
"cdAcNo": "",
"expiryDate": "",
"payerType": "Customer",
"payerCode": "",
"paymentBy": "Customer",
"paymentByName": "dummy dummy",
"paymentByRelationship": "Self",
"collectionAmount": "505197.00",
"collectionRcvdDate": "",
"collectionMode": "Online Collections",
"remarks": "",
"instrumentNumber": "403993715523677xxxxx",
"instrumentDate": "08/04/2021",
"bankName": "",
"branchName": "",
"bankLocation": "",
"micrNo": "",
"chequeType": "",
"ifscCode": "",
"PaymentGatewayName": "HDFC Pay-U Massmarket",
"TerminalID": "7600xxxx",
"cardno": ""
}
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| PolCreationRespons | quoteNumber | String | Unique identifier for the quote |
| customerId | String | Customer's unique ID |
| Source_Name | String | Source system or channel name |
| productName | String | Name of the insurance product |
| productCode | String | Code representing the product |
| lineOfBusiness | String | Type of insurance business |
| quoteStatus | String | Status of the quote |
| quoteValidFromDate | String (Date) | Start date of quote validity |
| quoteValidToDate | String (Date) | End date of quote validity |
| policyNumber | String | Policy number |
| proposalNumber | String | Proposal number |
| policyStatus | String | Status of the policy |
| tenure | String | Duration of the policy in years |
| stpflag | String | Straight-through processing flag |
| MedicalTestInfo | String | Medical test information |
| premiumDetails | Array | Contains premium-related details |
| Premium | BasePremium | String | Original premium before discounts/loadings |
| NetPremium | String | Premium after discounts |
| ServiceTax | String | Service tax amount |
| SBC | String | Swachh Bharat Cess |
| KKC | String | Krishi Kalyan Cess |
| BMI_loading | String | Loading based on BMI |
| GrossPremium | String | Total premium before final adjustments |
| FinalPremium | String | Final payable premium |
| ErrorObject | errorCode | String | Error code |
| errormessage | String | Error message |
| ReceiptCreationResponse | errorMessage | String | Message indicating success or failure |
| errorNumber | String | Error number |
| ReceiptNumber | String | Receipt number generated |
| ReceiptAmount | String | Amount received |
| ExcessAmount | String | Excess amount if any |
Sample Response Payload
{
"PolCreationRespons": {
"quoteNumber": "21400010xxxx",
"customerId": "PT005xxxxx",
"Source_Name": "Policy Bazar",
"productName": "Activ Health V2",
"Plan": "",
"productCode": "6212",
"lineOfBusiness": "HEALTH",
"quoteStatus": "UW",
"quoteValidFromDate": "24/05/2021",
"quoteValidToDate": "23/05/2022",
"policyNumber": "",
"proposalNumber": "2140001xxxxx",
"policyStatus": "UW",
"tenure": "1",
"stpflag": "NSTP",
"premiumDetails": {
"Premium": {
"BasePremium": "6046",
"NetPremium": "6046",
"ServiceTax": "1088",
"SBC": "0",
"KKC": "0",
"BMI_loading": "0.0",
"GrossPremium": "7134",
"FinalPremium": "7134"
}
},
"MedicalTestInfo": "",
"errorList": {
"ErrorObject": {
"errorCode": "0",
"errormessage": ""
}
}
},
"ReceiptCreationResponse": {
"errorMessage": "Sucess ",
"errorNumber": "0",
"ReceiptNumber": "RR-21-22-03xxxx",
"ReceiptAmount": "505197.0",
"ExcessAmount": ""
}
}
Activ Fit
If you are between 25 to 35 years of age and live a healthy & fit lifestyle, you can benefit the most from our health insurance policy a policy that rewards you for being young and staying healthy along with protecting you in times of need!
Presenting Aditya Birla Health Insurance Activ Fit plan a Health Insurance plan that is tailor-made for you, your needs, and your health goals.
With this plan, you get 10-50-100! What does that mean? 10% Upfront Good Health Discount and Early Bird Discount, 50% HealthReturnsTM and 100% Unlimited Sum Insured Refill. Read on to know more.
Request Payload
| Parent Node |
Field Name |
Data Type |
Data Length |
Mandatory/Non-mandatory |
Business Logic & Validations |
| Client Creation | | Object | | | |
| salutation | string | 5 | Yes | Reference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others |
| firstName | string | 250 | Yes | First name of proposer |
| middleName | string | 250 | No | Middle name of proposer |
| lastName | string | 250 | Yes | Last name of proposer |
| dateofBirth | string | - | Yes | DOB of proposer. Only MM/DD/YYYY Format will be Accepted |
| gender | string | 3 | Yes | Reference Master Value (M, F, T) |
| educationalQualification | string | 20 | No | Reference Master Value (Below Metric, Graduate, etc.) |
| pinCode | string | 25 | Yes | Pincode of Proposer |
| uidNo | string | 30 | No | UID number |
| maritalStatus | string | 10 | Yes | Reference Master Value |
| nationality | string | 200 | Yes | Reference Master Value (Indian, NRI, etc.) |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
Sample Request Payload
{
"ClientCreation": {
"salutation": "Mr",
"firstName": "dfgd",
"middleName": "",
"lastName": "ghjgh",
"dateofBirth": "02/03/2004",
"gender": "M",
"educationalQualification": "3",
"pinCode": "421306",
"uidNo": "",
"maritalStatus": "Single",
"nationality": "Indian",
"occupation": "CA",
"primaryEmailID": "qwer@gmail.com",
"contactMobileNo": "7xxxxxxxxx",
"stdLandlineNo": null,
"panNo": "",
"passportNumber": null,
"contactPerson": "xcvxc",
"annualIncome": "1000000",
"remarks": null,
"startDate": null,
"endDate": null,
"IdProof": "Others",
"residenceProof": null,
"ageProof": "itrtur",
"others": null,
"homeAddressLine1": "36343",
"homeAddressLine2": "",
"homeAddressLine3": null,
"homePinCode": null,
"homeArea": null,
"homeContactMobileNo": null,
"homeContactMobileNo2": null,
"homeSTDLandlineNo": null,
"homeSTDLandlineNo2": null,
"homeFaxNo": null,
"sameAsHomeAddress": "1",
"mailingAddressLine1": null,
"mailingAddressLine2": null,
"mailingAddressLine3": null,
"mailingArea": null,
"mailingContactMobileNo": null,
"mailingContactMobileNo2": null,
"mailingSTDLandlineNo": null,
"mailingSTDLandlineNo2": null,
"mailingFaxNo": null,
"bankAccountType": null,
"bankAccountNo": null,
"ifscCode": null,
"GSTIN": "",
"GSTRegistrationStatus": "Consumers"
},
"PolicyCreationRequest": {
"Quotation_Number": "22000034xxxx",
"QuoteDate": "02/09/2022",
"Product_Code": "7100",
"Plan_Code": "7100100001",
"SumInsured_Type": "Family Floater",
"Policy_Tanure": "3",
"Member_Type_Code": "M750",
"intermediaryCode": "2100465",
"AutoRenewal": "N",
"intermediaryBranchCode": "10GJVAD01",
"agentSignatureDate": null,
"Customer_Signature_Date": null,
"businessSourceChannel": null,
"leadID": "LEAD-104330987",
"Source_Name": "HDFC_NETB",
"SPID": null,
"RefCode1": null,
"RefCode2": null,
"RefCode6": "14510096767xxxxx",
"TCN": null,
"goGreen": "0",
"CRTNO": null,
"BusinessType": "New Business",
"IsPayment": "1",
"TeleOpd": null,
"familyDoctor": {
"fullName": "",
"qualification": "",
"emailId": "",
"RegistrationNumber": "",
"addressLine1": "",
"addressLine2": "",
"pinCode": "",
"contact_number": ""
},
"Whether_Employee_Affiliate": null,
"EmployeeId": null,
"Affiliate_Employee_ID": null,
"Name_of_Affiliate": null,
"EmployeeDiscount": null,
"AutoDebit": null,
"EnumIsMandate": null,
"TrackerRefCode": null
},
"MemObj": {
"Member": [
{
"MemberNo": "1",
"Salutation": "Mr",
"First_Name": "dfgd",
"Middle_Name": "",
"Last_Name": "ghjgh",
"Gender": "M",
"DateOfBirth": "02/03/2004",
"Relation_Code": "R001",
"Marital_Status": "Single",
"height": "135.00",
"weight": "50.00",
"occupation": "",
"NatureOfDuty": "",
"Designation": null,
"annualIncome": null,
"PrimaryMember": "N",
"optionalCovers": [
{ "optionalCoverName": "Travel Protect", "optionalCoverValue": "10000" },
{ "optionalCoverName": "Premium Waiver", "optionalCoverValue": "" },
{ "optionalCoverName": "EMI Protection", "optionalCoverValue": "30000" },
{ "optionalCoverName": "Super No Claim Bonus", "optionalCoverValue": "" },
{ "optionalCoverName": "OPD Expense", "optionalCoverValue": "" },
{ "optionalCoverName": "Non- Medical Expense", "optionalCoverValue": "" }
],
"productComponents": [
{ "productComponentName": "SumInsured", "productComponentValue": "100000" }
],
"Nominee_First_Name": "xcvxc",
"Nominee_Relationship_Code": "R004",
"Mobile_Number": "7xxxxxxxxxx",
"Upfront_Good_Health_Discount_Applicable": "N"
},
{
"MemberNo": "2",
"Salutation": "ms",
"First_Name": "cmcn",
"Middle_Name": "",
"Last_Name": "sdfsd",
"Gender": "F",
"DateOfBirth": "02/03/1977",
"Relation_Code": "R002",
"Marital_Status": "Married",
"height": "152.00",
"weight": "50.00",
"optionalCovers": [
{ "optionalCoverName": "Travel Protect", "optionalCoverValue": "20000" },
{ "optionalCoverName": "Premium Waiver", "optionalCoverValue": "" },
{ "optionalCoverName": "EMI Protection", "optionalCoverValue": "60000" }
],
"productComponents": [
{ "productComponentName": "SumInsured", "productComponentValue": "100000" }
],
"Nominee_First_Name": "xcvxc",
"Nominee_Relationship_Code": "R004",
"Mobile_Number": "7xxxxxxxxx"
}
]
},
"ReceiptCreation": {
"officeLocation": "Mumbai",
"modeOfEntry": "DIRECT",
"payerType": "Proposer",
"collectionAmount": "19532",
"collectionRcvdDate": "02/09/2022",
"collectionMode": "Online Collections",
"PaymentGatewayName": "Razorpay",
"TerminalID": "ExO4eKBgjHgbNd",
"instrumentNumber": "pay_KCyQjKYqFVDmeT",
"instrumentDate": "02/09/2022"
}
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| PolCreationRespons | quoteNumber | String | Unique identifier for the quote |
| customerId | String | Customer's unique ID |
| Source_Name | String | Source system or channel name |
| productName | String | Name of the insurance product |
| productCode | String | Code representing the product |
| lineOfBusiness | String | Type of insurance business |
| quoteStatus | String | Status of the quote |
| quoteValidFromDate | String (Date) | Start date of quote validity |
| quoteValidToDate | String (Date) | End date of quote validity |
| policyNumber | String | Policy number |
| proposalNumber | String | Proposal number |
| policyStatus | String | Status of the policy |
| tenure | String | Duration of the policy in years |
| stpflag | String | Straight-through processing flag |
| MedicalTestInfo | String | Medical test information |
| premiumDetails | Array | Contains premium-related details |
| Premium | BasePremium | String | Original premium before discounts/loadings |
| NetPremium | String | Premium after discounts |
| ServiceTax | String | Service tax amount |
| SBC | String | Swachh Bharat Cess |
| KKC | String | Krishi Kalyan Cess |
| BMI_loading | String | Loading based on BMI |
| GrossPremium | String | Total premium before final adjustments |
| FinalPremium | String | Final payable premium |
| ErrorObject | errorCode | String | Error code |
| errormessage | String | Error message |
| ReceiptCreationResponse | errorMessage | String | Message indicating success or failure |
| errorNumber | String | Error number |
| ReceiptNumber | String | Receipt number generated |
| ReceiptAmount | String | Amount received |
| ExcessAmount | String | Excess amount if any |
Sample Response Payload
<ns0:ActiveHealthRes xmlns:ns0="http://">
<PolCreationRespons>
<quoteNumber>22000034xxxx</quoteNumber>
<customerId>PT8720xxxx</customerId>
<Source_Name>HDFC_NETB</Source_Name>
<productName>Activ Fit</productName>
<Plan></Plan>
<productCode>7100</productCode>
<lineOfBusiness>HEALTH</lineOfBusiness>
<quoteStatus>IF</quoteStatus>
<quoteValidFromDate>02/09/2022</quoteValidFromDate>
<quoteValidToDate>01/09/2025</quoteValidToDate>
<policyNumber>71-22-000xxxx-00</policyNumber>
<proposalNumber>22000034xxxx</proposalNumber>
<policyStatus>IF</policyStatus>
<tenure>3</tenure>
<stpflag>STP</stpflag>
<premiumDetails>
<Premium>
<BasePremium>18392</BasePremium>
<NetPremium>16553</NetPremium>
<ServiceTax>2979</ServiceTax>
<SBC>0</SBC>
<KKC>0</KKC>
<BMI_loading>0.0</BMI_loading>
<GrossPremium>19532</GrossPremium>
<FinalPremium>19532</FinalPremium>
<Discount_Amount></Discount_Amount>
</Premium>
</premiumDetails>
<MedicalTestInfo></MedicalTestInfo>
<errorList>
<ErrorObject>
<errorCode>0</errorCode>
<errormessage></errormessage>
</ErrorObject>
</errorList>
</PolCreationRespons>
<ReceiptCreationResponse>
<errorMessage>Sucess</errorMessage>
<errorNumber>0</errorNumber>
<ReceiptNumber>RR-21-22-16xxxx</ReceiptNumber>
<ReceiptAmount>19532.0</ReceiptAmount>
<ExcessAmount></ExcessAmount>
</ReceiptCreationResponse>
</ns0:ActiveHealthRes>
Super Heath Top Up
Tired of medical expenses draining your savings? Say goodbye to financial stress during health emergencies with Super Health Plus Top Up - your ultimate shield against rising healthcare costs. This innovative health insurance solution offers comprehensive coverage that kicks in when your basic insurance limits are exceeded.
With upto INR 95 lacs* coverage, you can access top-notch medical care at the most affordable premium, without compromising on your health or your finances.
Request Payload
| Parent Node |
Field Name |
Data Type |
Data Length |
Mandatory/Non-mandatory |
Business Logic & Validations |
| Client Creation | | Object | | | |
| salutation | string | 5 | Yes | Reference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others |
| firstName | string | 250 | Yes | First name of proposer |
| middleName | string | 250 | No | Middle name of proposer |
| lastName | string | 250 | Yes | Last name of proposer |
| dateofBirth | string | - | Yes | DOB of proposer. Only MM/DD/YYYY Format will be Accepted |
| gender | string | 3 | Yes | Reference Master Value (M, F, T) |
| educationalQualification | string | 20 | No | Reference Master Value (Below Metric, Graduate, etc.) |
| pinCode | string | 25 | Yes | Pincode of Proposer |
| uidNo | string | 30 | No | UID number |
| maritalStatus | string | 10 | Yes | Reference Master Value |
| nationality | string | 200 | Yes | Reference Master Value (Indian, NRI, etc.) |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
Sample Request Payload
{
"MemObj": {
"Member": [
{
"PreviousCurrentInsuranceDetails": {
"IsPreviousCurrentpolicy": null,
"ConsiderAnyInternational": null,
"Insurername": null,
"IsAnyClaim": null
},
"MemberproductComponents": [
{
"MemberQuestionDetails": null,
"Deductible": "",
"CoversDetails": [
{
"CoverPartCode": "",
"CoverSI": "",
"PlanCode": "4225100001",
"CoverCode": ""
}
],
"SumInsured": "1000000",
"PlanCode": "4225100001",
"ChronicDetails": ""
}
],
"MemberPEDs": [
{
"PEDCode": "",
"Remarks": "",
"Value": ""
}
],
"Middle_Name": "dummy",
"Marital_Status": "Married",
"IdProofNumber": "XXXXXXXX8810",
"emailId": "dummy@gmail.com",
"Gender": "M",
"Nominee_First_Name": "dummy",
"Nominee_Last_Name": "dummy",
"Nominee_Relationship_Code": "R002",
"Nominee_Contact_Number": "9xxxxxxxx",
"Nominee_Home_Address": "xxxxxxxxxx 421201",
"First_Name": "dummy",
"Last_Name": "dummy",
"Nationality": "Indian",
"DateOfBirth": "28/04/1969",
"height": 175,
"weight": "75",
"AnnualIncome": "500000"
},
{
"PreviousCurrentInsuranceDetails": {
"IsPreviousCurrentpolicy": null,
"ConsiderAnyInternational": null,
"Insurername": null,
"IsAnyClaim": null
},
"MemberproductComponents": [
{
"MemberQuestionDetails": null,
"Deductible": "",
"CoversDetails": [
{
"CoverPartCode": "",
"CoverSI": "",
"PlanCode": "4225100001",
"CoverCode": ""
}
],
"SumInsured": "1000000",
"PlanCode": "4225100001",
"ChronicDetails": ""
}
],
"Middle_Name": "dummy",
"Gender": "F",
"emailId": "dummy@gmail.com",
"Nominee_First_Name": "dummy",
"Nominee_Last_Name": "dummy",
"Nominee_Relationship_Code": "R002",
"Nominee_Contact_Number": "9xxxxxxxx",
"First_Name": "Aarti",
"Last_Name": "Shaha",
"Nationality": "Indian",
"DateOfBirth": "28/04/1969",
"height": 155,
"weight": "65",
"AnnualIncome": "500000"
}
]
},
"PreviousPolicyObj": {
"PreviousPolicyDetails": [{}]
},
"ReceiptObj": {
"ReceiptCreation": []
},
"PolicyCreationRequest": {
"BusinessType": "New Business",
"Is_Combi": "No",
"intermediaryCode": "2118000",
"intermediaryBranchCode": "10MHMUM02",
"AccountNumber": "41064047280",
"AccountType": "02",
"BankBranch": "DOMBIVLI EAST BRANCH",
"IFSCCode": "SBINxxxxxxx",
"leadID": "UPL03102512367xxxxx",
"Source_Name": "ABHIOne",
"businessSourceChannel": "ABHIOne",
"PolicyproductComponents": [
{
"SumInsured_Type": "Family Floater",
"ProductCode": "4225",
"PlanCode": "4225100001",
"Member_Type_Code": "M717",
"Policy_Tanure": "1"
}
]
},
"ClientCreation": {
"firstName": "xxxxx",
"lastName": "dummy",
"middleName": "dummy",
"dateofBirth": "28/04/1969",
"gender": "M",
"maritalStatus": "Married",
"occupation": "O005",
"contactMobileNo": "9xxxxxxxxx",
"primaryEmailID": "dummy@gmail.com",
"homeAddressLine1": "101 xxxxx Apartment",
"homeAddressLine2": "xxxxxx Road",
"homeAddressLine3": "xxxxxxxxx Thane, Maharashtra 421201",
"mailingAddressLine1": "101xxxxxx Apartment",
"mailingAddressLine2": "xxxxxxx Road",
"mailingAddressLine3": "xxxxxxxxxxx 421201",
"mailingPinCode": "421201",
"bankAccountNo": "410xxxxxxxxx",
"ifscCode": "SBIN000xxxx",
"bankAccountType": "Saving",
"BankBranch": "DOMBIVLI EAST BRANCH",
"annualIncome": "500000",
"nationality": "Indian",
"panNo": "Cxxxxxxx"
}
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| PolCreationRespons | quoteNumber | String | Unique identifier for the quote |
| customerId | String | Customer's unique ID |
| Source_Name | String | Source system or channel name |
| productName | String | Name of the insurance product |
| productCode | String | Code representing the product |
| lineOfBusiness | String | Type of insurance business |
| quoteStatus | String | Status of the quote |
| quoteValidFromDate | String (Date) | Start date of quote validity |
| quoteValidToDate | String (Date) | End date of quote validity |
| policyNumber | String | Policy number |
| proposalNumber | String | Proposal number |
| policyStatus | String | Status of the policy |
| tenure | String | Duration of the policy in years |
| stpflag | String | Straight-through processing flag |
| MedicalTestInfo | String | Medical test information |
| premiumDetails | Array | Contains premium-related details |
| Premium | BasePremium | String | Original premium before discounts/loadings |
| NetPremium | String | Premium after discounts |
| ServiceTax | String | Service tax amount |
| SBC | String | Swachh Bharat Cess |
| KKC | String | Krishi Kalyan Cess |
| BMI_loading | String | Loading based on BMI |
| GrossPremium | String | Total premium before final adjustments |
| FinalPremium | String | Final payable premium |
| ErrorObject | errorCode | String | Error code |
| errormessage | String | Error message |
| ReceiptCreationResponse | errorMessage | String | Message indicating success or failure |
| errorNumber | String | Error number |
| ReceiptNumber | String | Receipt number generated |
| ReceiptAmount | String | Amount received |
| ExcessAmount | String | Excess amount if any |
Sample Response Payload
{
"quoteNumber": "25000270xxxx",
"quoteValidFromDate": "10/03/2025",
"quoteValidToDate": "10/02/2026",
"customerId": "",
"Source_Name": "ABHIOne",
"quoteStatus": "UW",
"stpflag": "NSTP",
"ReceiptCreationResponse": [
{
"errorMessage": "Success",
"errorNumber": "0",
"ReceiptNumber": "",
"ReceiptAmount": "",
"ExcessAmount": ""
}
],
"ProductPremiumDetails": [
{
"productCode": "4225",
"PlanCode": "4225100001",
"policyNumber": "",
"proposalNumber": "",
"tenure": "1",
"BasePremium": "35402",
"NetPremium": "35402",
"Tax": "0",
"TaxDetails": {
"CGST": "",
"SGST": "",
"IGST": "",
"UTGST": "",
"OtherCess": ""
},
"Loading": "0",
"Discount": "3540",
"GrossPremium": "31862",
"stpFlag": "NSTP",
"Status": "UW",
"Rider_Amount": ""
}
],
"FinalPremium": {
"FinalBasePremium": "31862",
"FinalNetPremium": "31862",
"FinalTax": "0",
"FinalTaxDetails": {
"CGST": "",
"SGST": "",
"IGST": "",
"UTGST": "",
"OtherCess": ""
},
"Loading": "0",
"Discount": "3540",
"FinalGrossPremium": "31862"
},
"errorList": [
{
"ErrorObject": {
"errorCode": "0",
"errormessage": "Success"
}
}
]
}
Activ Assure
Activ Assure Diamond Health Insurance Plan is a cost-effective health insurance plan offering comprehensive cover for hospitalization, 586 day care procedures and convenient cashless claims at our 10051+ network hospitals.
Request Payload
| Parent Node |
Field Name |
Data Type |
Data Length |
Mandatory/Non-mandatory |
Business Logic & Validations |
| Client Creation | | Object | | | |
| salutation | string | 5 | Yes | Reference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others |
| firstName | string | 250 | Yes | First name of proposer |
| middleName | string | 250 | No | Middle name of proposer |
| lastName | string | 250 | Yes | Last name of proposer |
| dateofBirth | string | - | Yes | DOB of proposer. Only MM/DD/YYYY Format will be Accepted |
| gender | string | 3 | Yes | Reference Master Value (M, F, T) |
| educationalQualification | string | 20 | No | Reference Master Value (Below Metric, Graduate, etc.) |
| pinCode | string | 25 | Yes | Pincode of Proposer |
| uidNo | string | 30 | No | UID number |
| maritalStatus | string | 10 | Yes | Reference Master Value |
| nationality | string | 200 | Yes | Reference Master Value (Indian, NRI, etc.) |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
| occupation | string | 20 | No | Reference Master Value |
| primaryEmailID | string | 50 | Yes | Mail ID |
| contactMobileNo | string | 15 | Yes | Contact Number |
| stdLandlineNo | string | 15 | No | STD landline number |
| panNo | string | 15 | Yes in case of id proof Pan card | Pan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card |
| passportNumber | string | 20 | Yes in Case of id Proof Passport | Passport number |
| contactPerson | string | 100 | No | Contact person name |
| annualIncome | string | (18, 2) | No | If Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer. |
| remarks | string | max | No | Remarks |
| startDate | string | | No | start date (only MM/DD/YYYY Format will be Accepted) |
| endDate | string | | No | end date (only MM/DD/YYYY Format will be Accepted) |
| IdProof | string | 100 | No | Reference Master Value (e.g."Aadhaar Card", "Pan Card" ..) |
| residenceProof | string | 100 | No | Reference Master Value for Residence proof type |
| ageProof | string | 100 | No | Value of "IdProof" master value |
| others | string | 100 | No | Other details |
| homeAddressLine1 | string | 300 | Yes | Part of Correspondence Address |
| homeAddressLine2 | string | 300 | No | Part of Correspondence Address |
| homeAddressLine3 | string | 300 | No | Part of Correspondence Address |
| homePinCode | string | 6 | Yes | Pincode entered during client creation |
| homeArea | string | 10 | | Home area |
| homeContactMobileNo | string | 10 | Yes | Home contact number |
| homeContactMobileNo2 | string | 10 | No | Home alternate contact number |
| homeSTDLandlineNo | string | 20 | No | Home Landline number |
| homeSTDLandlineNo2 | string | 20 | No | Home alternate landline number |
| homeFaxNo | string | 20 | No | Home fax number |
| sameAsHomeAddress | string | 1 | Yes | Reference master value 1 - mailing details same as home details, 0 - to be filled manually |
| mailingAddressLine1 | string | 300 | | Mailing address line 1 |
| mailingAddressLine2 | string | 300 | | Mailing address line 2 |
| mailingAddressLine3 | string | 300 | | Mailing address line 3 |
| mailingPinCode | string | 6 | | Auto derived code in all the places. |
| mailingArea | string | 100 | | Mailing Area |
| mailingContactMobileNo | string | 10 | | Mailing contact number |
| mailingContactMobileNo2 | string | 10 | | Mailing alternate contact number |
| mailingSTDLandlineNo | string | 20 | | Mailing landline number |
| mailingSTDLandlineNo2 | string | 20 | | Mailing alternate landlind number |
| mailingFaxNo | string | 20 | | Mailing fax number |
| bankAccountType | string | 20 | Yes | Type of Bank Account. Reference master value |
| bankName | string | 50 | Yes | Bank Name |
| bankAccountNo | string | 20 | Yes | Bank account number |
| ifscCode | string | 20 | Yes | IFSC. Free Text |
| GSTIN | string | | | Mandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered" |
| GSTRegistrationStatus | string | 20 | | EnumMaster value - "Consumer" Register" "Compounding dealers" |
| UIDAcknowledgementNo | string | 50 | No | UID Acknowledgent number |
| IsEIAavailable | string | 3 | No | "Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available) |
| ApplyEIA | string | 3 | No | Indicator for Applying electronic account |
| EIAAccountNo | string | 20 | Yes, if isEIAavailabe=Yes | EIA number |
| EIAWith | string | 50 | Yes, if isEIAavailabe=Yes | EI account with |
| AccountType | string | 20 | | Reference master value for account type like, 01 - current acc, 02 - saving acc |
| AddressProof | string | 100 | No | Reference master value. Proof of address |
| DOBProof | string | 100 | No | Reference master value. Proof of DOB |
| IdentityProof | string | 100 | No | Reference master value. ID Proof |
| DCNnumber | string | 100 | | Document number |
Sample Request Payload
{
"ClientCreation": {
"salutation": "Mr",
"firstName": "dummy",
"middleName": "dummy",
"lastName": "dummy",
"dateofBirth": "15/06/1993",
"gender": "M",
"educationalQualification": "",
"pinCode": "263002",
"uidNo": "",
"maritalStatus": "Single",
"nationality": "Indian",
"occupation": "dummy",
"primaryEmailID": "email@email.com",
"contactMobileNo": "0000000000",
"stdLandlineNo": "0000000000",
"panNo": "AXXXXXXXX",
"passportNumber": "",
"contactPerson": "",
"annualIncome": 500000,
"remarks": "dummy",
"startDate": "17/06/2020",
"endDate": "17/06/2020",
"IdProof": "",
"residenceProof": "",
"ageProof": "",
"others": "",
"homeAddressLine1": "line1",
"homeAddressLine2": "line2",
"homeAddressLine3": "line3",
"homePinCode": "263002",
"homeArea": "area",
"homeContactMobileNo": "0000000000",
"homeContactMobileNo2": "0000000000",
"homeSTDLandlineNo": "",
"homeSTDLandlineNo2": "",
"homeFaxNo": "",
"sameAsHomeAddress": 1,
"mailingAddressLine1": "line1",
"mailingAddressLine2": "line2",
"mailingAddressLine3": "line3",
"mailingPinCode": "263002",
"mailingArea": "area",
"mailingContactMobileNo": "",
"mailingContactMobileNo2": "",
"mailingSTDLandlineNo": "",
"mailingSTDLandlineNo2": "",
"mailingFaxNo": "",
"bankAccountType": "",
"bankAccountNo": "",
"ifscCode": "",
"GSTIN": "",
"GSTRegistrationStatus": "Consumers",
"IsEIAavailable": "0",
"ApplyEIA": "0",
"EIAAccountNo": "",
"EIAWith": "",
"AccountType": "",
"AddressProof": "",
"DOBProof": "",
"IdentityProof": "",
"UIDAcknowledgementNo": ""
},
"PolicyCreationRequest": {
"Quotation_Number": "",
"Product_Code": 4226,
"Plan_Code": "4226100001",
"SumInsured_Type": "Individual",
"Policy_Tanure": "1",
"Member_Type_Code": "M391",
"AutoRenewal": "N",
"intermediaryBranchCode": "10MHMUM02",
"agentSignatureDate": "17/06/2020",
"Customer_Signature_Date": "17/06/2020",
"businessSourceChannel": "",
"Source_Name": "Invictus",
"SPID": "",
"RefCode1": "",
"RefCode2": "",
"TCN": "",
"EmployeeNumber": "null",
"EmployeeDiscount": "",
"QuoteDate": "17/06/2020",
"CRTNO": "",
"IsPayment": 0,
"goGreen": 0,
"familyDoctor": {
"fullName": "",
"qualification": "",
"emailId": "",
"RegistrationNumber": "",
"addressLine1": "",
"addressLine2": "",
"pinCode": "",
"contact_number": ""
},
"leadID": "INVI12042018000xxx",
"intermediaryCode": "2103129"
},
"MemObj": {
"Member": [
{
"MemberNo": 1,
"Salutation": "Mr",
"First_Name": "dummy",
"Middle_Name": "dummy",
"Last_Name": "dummy",
"Gender": "M",
"DateOfBirth": "15/06/1993",
"Relation_Code": "R001",
"Marital_Status": "Single",
"height": 167,
"weight": 72.8,
"occupation": "",
"PrimaryMember": "Y",
"optionalCovers": [
{
"optionalCoverName": "Maternity Expenses",
"optionalCoverValue": 0
},
{
"optionalCoverName": "OPD Expenses",
"optionalCoverValue": 0
}
],
"productComponents": [
{
"productComponentName": "Conditions",
"productComponentValue": "Non-Chronic"
},
{
"productComponentName": "SumInsured",
"productComponentValue": "500000"
},
{
"productComponentName": "Zone",
"productComponentValue": "Z000"
},
{
"productComponentName": "RoomCategory",
"productComponentValue": "Single Private Room"
}
],
"MemberPED": [
{
"PEDCode": "",
"Remarks": ""
}
],
"exactDiagnosis": "",
"dateOfDiagnosis": "17/06/2020",
"lastDateConsultation": "17/06/2020",
"detailsOfTreatmentGiven": "",
"doctorName": "",
"hospitalName": "",
"phoneNumberHosital": "",
"labReport": "",
"dischargeCardSummary": "",
"personalHabitDetail": [
{
"numberOfYears": "",
"count": "",
"type": ""
}
],
"Nominee_First_Name": "",
"Nominee_Last_Name": "Test",
"Nominee_Contact_Number": "",
"Nominee_Home_Address": "",
"Nominee_Relationship_Code": ""
}
]
},
"ReceiptCreation": {
"officeLocation": "",
"modeOfEntry": "",
"cdAcNo": "",
"expiryDate": "17/06/2020",
"payerType": "Customer",
"payerCode": "",
"paymentBy": "",
"paymentByName": "",
"paymentByRelationship": "",
"collectionAmount": "",
"collectionRcvdDate": "17/06/2020",
"collectionMode": "",
"remarks": "",
"instrumentNumber": "",
"instrumentDate": "17/06/2020",
"bankName": "",
"branchName": "",
"bankLocation": "",
"micrNo": "",
"chequeType": "",
"ifscCode": "",
"PaymentGatewayName": "ABHI TUTRLEMINT",
"TerminalID": "76025071"
}
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| PolCreationRespons | quoteNumber | String | Unique identifier for the quote |
| customerId | String | Customer's unique ID |
| Source_Name | String | Source system or channel name |
| productName | String | Name of the insurance product |
| productCode | String | Code representing the product |
| lineOfBusiness | String | Type of insurance business |
| quoteStatus | String | Status of the quote |
| quoteValidFromDate | String (Date) | Start date of quote validity |
| quoteValidToDate | String (Date) | End date of quote validity |
| policyNumber | String | Policy number |
| proposalNumber | String | Proposal number |
| policyStatus | String | Status of the policy |
| tenure | String | Duration of the policy in years |
| stpflag | String | Straight-through processing flag |
| MedicalTestInfo | String | Medical test information |
| premiumDetails | Array | Contains premium-related details |
| Premium | BasePremium | String | Original premium before discounts/loadings |
| NetPremium | String | Premium after discounts |
| ServiceTax | String | Service tax amount |
| SBC | String | Swachh Bharat Cess |
| KKC | String | Krishi Kalyan Cess |
| BMI_loading | String | Loading based on BMI |
| GrossPremium | String | Total premium before final adjustments |
| FinalPremium | String | Final payable premium |
| ErrorObject | errorCode | String | Error code |
| errormessage | String | Error message |
| ReceiptCreationResponse | errorMessage | String | Message indicating success or failure |
| errorNumber | String | Error number |
| ReceiptNumber | String | Receipt number generated |
| ReceiptAmount | String | Amount received |
| ExcessAmount | String | Excess amount if any |
Sample Response Payload
{
"PolCreationRespons": {
"quoteNumber": "2020061742197084xxxx",
"customerId": "",
"Source_Name": "INVICTUS",
"productName": "",
"productCode": "4219",
"lineOfBusiness": "",
"quoteStatus": "",
"quoteValidFromDate": "06/17/2020",
"quoteValidToDate": "06/24/2020",
"policyNumber": "",
"proposalNumber": "",
"policyStatus": "IF",
"tenure": "1",
"stpflag": "STP",
"premiumDetails": [
{
"Premium": [
{
"BasePremium": "5395.00",
"NetPremium": "5395.00",
"ServiceTax": "971.10",
"SBC": "0",
"KKC": "0",
"BMI_loading": "0.00",
"GrossPremium": "6366.00",
"FinalPremium": "6366.00"
}
]
}
],
"MedicalTestInfo": "",
"errorList": [
{
"ErrorObject": {
"errorCode": "0",
"errormessage": ""
}
}
]
},
"ReceiptCreationResponse": {
"errorMessage": "Sucess ",
"errorNumber": "0 ",
"ReceiptNumber": "",
"ReceiptAmount": "",
"ExcessAmount": ""
}
}
claimSearchInfo
This API retrieves detailed claim information using a specific claim number.
It returns key data such as member details, policy number, claim type and status, hospitalization cover type, bank details, and financial breakdowns like approved amount, deductions, and insurer payout.
It is primarily used to track the progress and status of a claim within the insurance system.
Request Payload
| Field Name |
Data Type |
Mandatory/Non-mandatory |
Description |
| claimNumber | string | Yes | Enter claim number |
Sample Request Payload
{
"claimNumber": "1122585004xxxx/03"
}
Response Payload
| Field Name |
Data Type |
Description |
| ClaimNumber | String | Unique identifier for the claim |
| Member_ID | String | ID of the insured member |
| Member_Name | String | Name of the insured member |
| Policy_No | String | Policy number under which the claim is filed |
| Claim_SubStatus | String | Current sub-status of the claim |
| Claim_Type | String | Type of claim |
| Cover_Type | String | Type of insurance cover |
| Opted_Room | String/null | Room type opted during hospitalization |
| Claim_Amount | String | Total claimed amount |
| Deducted_Amount | String | Amount deducted from the claim |
| Provider_Discount | String | Discount provided by the healthcare provider |
| Reason | String | Reason code or description |
| Status | String | Claim status |
| Compulsory_Deduction | String/null | Mandatory deduction amount |
| Co_payment | String | Co-payment amount |
| Copay_reason | String/null | Reason for co-payment |
| SumInsured_Exhausted_Amount | String/null | Amount exhausted from sum insured |
| Approved_Amount_INR | String | Approved amount in INR |
| Intial_Approval | String | Initial approval status |
| Interim_Approval_Amount | String/null | Interim approved amount |
| Final_Approved_Amount | String | Final approved amount |
| Approval_Remark | String | Remarks related to approval |
| Deficiency_Raise_To | String/null | Entity to whom deficiency was raised |
| Raise_Date | String/null | Date when deficiency was raised |
| Document_Received_Date | String/null | Date when documents were received |
| Close_Date | String/null | Claim closure date |
| Claim_Status | String | Final status of the claim |
| Deduction_Reason | String | Reason for deductions |
| Discount_Reason | String | Reason for discount |
| Discount_Amount | String | Amount discounted |
| AmountToBePaidByInsured | String | Final amount payable by the insured |
| CKYC_Flag | String | CKYC verification flag |
| CKYC_Number | String | CKYC reference number |
| BankName | String | Name of the insured’s bank |
| AccountNumber | String | Bank account number |
| BankBranch | String | Branch of the bank |
| IFSCCode | String | IFSC code of the bank branch |
| document | Array | List of associated documents |
Sample Response Payload
{
"Response": [
{
"ClaimNumber": "112258500xxxx/03",
"Member_ID": "PT1447xxxx",
"Member_Name": "dummy dummy",
"Policy_No": "21-24-002xxxx-00",
"Claim_SubStatus": "RI Registration Raised",
"Claim_Type": "Reimbursement",
"Cover_Type": "In-patient Hospitalization cover",
"Opted_Room": null,
"Claim_Amount": "",
"Deducted_Amount": "",
"Provider_Discount": "",
"Reason": "A",
"Status": "RI Registration Raised",
"Compulsory_Deduction": null,
"Co_payment": "",
"Copay_reason": null,
"SumInsured_Exhausted_Amount": null,
"Approved_Amount_INR": "",
"Checklist_of_Denial_Clauses": null,
"Intial_Approval": null,
"Interim_Approval_Amount": "",
"Final_Approved_Amount": "",
"Approval_Remark": null,
"Deficiency_Raise_To": null,
"Raise_Date": null,
"Document_Received_Date": null,
"Close_Date": null,
"Claim_Status": "RI Registration Raised",
"First_Reminder_Date": null,
"Second_Reminder_Date": null,
"Third_Reminder_Date": null,
"Final_Closure_Date": null,
"Discrepancy_Remark": null,
"isChildClaim": null,
"Deduction_Reason": null,
"Discount_Reason": null,
"Discount_Amount": "",
"UTR_Number": null,
"Denial_Reason": null,
"ErrorMessage": null,
"AmountToBePaidByInsured": "0.00",
"CKYC_Flag": "",
"CKYC_Number": "",
"BankName": "KOTAK MAHINDRA BANK LIMITED",
"AccountNumber": "3216xxxxx",
"BankBranch": "WORLI",
"IFSCCode": "KKBK0000xxxx",
"document": []
}
]
}
PreAuthRegistration
This API is used to initiate and register a pre-authorization request for health insurance claims.
It captures essential details such as policy number, family ID, claim intimation source and type, hospitalization cover, patient information, diagnosis (ICDCode), and procedure codes (PCSCode).
Upon successful submission, the API returns a confirmation message along with a unique claim number, enabling insurers to begin claim evaluation and processing.
Request Payload
| Field Name |
Data Type |
Mandatory/Non-mandatory |
Description |
| PreAuthObj | List | Y | |
| Policy_Number | String | Y | Policy Number, text |
| FamilyId | String | Y | Unique Member code/Party code |
| Claim_Intimation_Through | String | Y | Source (e.g., CRM) |
| Claim_Intimation_Source | String | Y | Source (e.g., CRM) |
| Intimation_Type | String | Y | Claim type: Cashless or Reimbursement |
| Cover_code | String | Y | Admission type code (DayCare/Inpatient) |
| Cover_Name | String | Y | Admission type description |
| Hospital_Name | String | Y | Hospital name |
| Hospital_Code | String | Y | Hospital code |
| Diagnosis | String | Y | Diagnosis description |
| Date_of_Admission | String | Y | Actual date of admission |
| Time_of_Admission | String | Y | Actual time of admission |
| Date_of_Discharge | String | Y | Actual date of discharge |
| Time_of_Discharge | String | Y | Actual time of discharge |
| Claim_Amount | String | Y | Claim amount |
| Source_System_Code | String | Y | Source system identifier |
| Document_Received_Date | String | Y | Date when documents were received |
| Document_Received_Time | String | Y | Time when documents were received |
| Patient_Name | String | Y | Patient name |
| Co_morbidities | String | N | Co-morbid conditions |
| Service_flag | String | N | Service flag |
| Name_Of_Treating_Doctor | String | N | Name of treating doctor |
| Doctor_Contact_No | String | N | Doctor's contact number |
| Duration_Of_Present_Ailment | String | N | Duration of current ailment |
| Proposed_line_of_treatment | String | N | Proposed treatment plan |
| Investigation_MedicalManagementDetails | String | N | Investigation and medical management details |
| Name_Of_Surgery | String | N | Name of surgery |
| IRDA_Code_Of_surgery | String | N | IRDA code for surgery |
| How_did_injury_occur | String | N | Details of injury occurrence |
| Case_Of_accident | String | N | Accident case indicator |
| IsItRTA | String | N | Road traffic accident indicator |
| Date_Of_Inhury | String | N | Date of injury |
| ReportedtoPolice | String | N | Police report status |
| FirNo | String | N | FIR number |
| Injury_Disease_Alcohalconsumption | String | N | Alcohol-related injury/disease |
| IsMaternity | String | N | Maternity case indicator |
| G | String | N | Gravida count |
| P | String | N | Parity count |
| L | String | N | Live births count |
| A | String | N | Abortions count |
| Date_Of_Delivery | String | N | Date of delivery |
| Emergency_Planned_Event | String | N | Emergency or planned event |
| Room_Type | String | N | Type of hospital room |
| DeaseasWithPresentingComplaints | String | N | Disease with presenting complaints |
| ReleventClinicalFinding | String | N | Relevant clinical findings |
| DateOfFirstConsultation | String | N | Date of first consultation |
| ProvisionalDiagnosis | String | N | Provisional diagnosis |
| Doctor_Registration_No | String | N | Doctor registration number |
| IsPreexisting | String | N | Pre-existing condition indicator |
| IsNaturalCalamityCase | String | N | Natural calamity case indicator |
| Test_ConductedToEstablishThis | String | N | Tests conducted to establish condition |
| AlcohalordrugAbuse | String | N | Alcohol or drug abuse indicator |
| AnyHivorStdRelatedAilments | String | N | HIV/STD-related ailments |
| AnyOtherAilments | String | N | Other ailments |
| Other_Ind | String | N | Other indicators |
| Hospital_Nm | String | N | Hospital name |
| Hospital_Address | String | N | Hospital address |
| Hospital_Country | String | N | Hospital country |
| Hospital_State | String | N | Hospital state |
| Hospital_District | String | N | Hospital district |
| Hospital_City | String | N | Hospital city |
| Hospital_PinCode | String | N | Hospital postal code |
| Hospital_Mail | String | N | Hospital email |
| Hospital_StdCode | String | N | Hospital STD code |
| Hospital_PhoneNo | String | N | Hospital phone number |
| Hospital_MobileNo | String | N | Hospital mobile number |
| Hospital_FaxNo | String | N | Hospital fax number |
| Hospital_WebSite | String | N | Hospital website |
| Hospital_LandMark | String | N | Hospital landmark |
| PreexistingObj | List | N | Pre-existing conditions object |
| Preexisting_Deases | String | N | Pre-existing diseases |
| Status | String | N | Status of pre-existing condition |
| Sincewhen | String | N | Duration of condition |
| Remarks | String | N | Additional remarks |
| PCSObj | List | N | Procedure codes object |
| PCS_Code | String | N | Procedure code |
| ICD_Code | String | N | Diagnosis code |
| DocObj | List | N | Document object |
| UploadStatus | String | N | Upload status |
| Filename | String | N | Document filename |
Sample Request Payload
{
"PreAuthObj": [
{
"Policy_Number": "GHI-81-25-0607xxxx-000",
"FamilyId": "PT352xxxxx",
"Claim_Intimation_Through": "Online",
"Claim_Intimation_Source": "EEP",
"Intimation_Type": "Reimbursement",
"Cover_code": "42214101",
"Cover_Name": "In-patient Hospitalization",
"Hospital_Name": "",
"Hospital_Code": "HS00001632",
"Diagnosis": "illness",
"Date_of_Admission": "08/04/2025",
"Date_of_Discharge": "08/07/2025",
"Time_of_Admission": "13:37",
"Time_of_Discharge": "00:00",
"Claim_Amount": "78483",
"Source_System_Code": "EEP",
"Document_Received_Date": "10/03/2025",
"Document_Received_Time": "12:26",
"Patient_Name": "dummy dummy",
"coMorbidities": "",
"Service_flag": "",
"Name_Of_Treating_Doctor": "",
"Doctor_Contact_No": "",
"Duration_Of_Present_Ailment": "",
"Proposed_line_of_treatment": "",
"Investigation_MedicalManagementDetails": "",
"Name_Of_Surgery": "",
"IRDA_Code_Of_surgery": "",
"How_did_injury_occur": "",
"Case_Of_accident": "",
"IsItRTA": "",
"Date_Of_Inhury": "",
"ReportedtoPolice": "",
"FirNo": "",
"Injury_Disease_Alcohalconsumption": "",
"IsMaternity": "",
"G": "",
"P": "",
"L": "",
"A": "",
"Date_Of_Delivery": "",
"Emergency_Planned_Event": "",
"Room_Type": "",
"DeaseasWithPresentingComplaints": "",
"ReleventClinicalFinding": "",
"DateOfFirstConsultation": "",
"ProvisionalDiagnosis": "",
"Doctor_Registration_No": "",
"IsPreexisting": "",
"IsNaturalCalamityCase": "",
"Test_ConductedToEstablishThis": "",
"AlcohalordrugAbuse": "",
"AnyHivorStdRelatedAilments": "",
"AnyOtherAilments": "",
"Other_Ind": "No",
"Hospital_Nm": "",
"Hospital_Address": "",
"Hospital_Country": "",
"Hospital_State": "",
"Hospital_District": "",
"Hospital_City": "",
"Hospital_PinCode": "",
"Hospital_Mail": "",
"Hospital_StdCode": "",
"Hospital_PhoneNo": "",
"Hospital_MobileNo": "",
"Hospital_FaxNo": "",
"Hospital_WebSite": "",
"Hospital_LandMark": ""
}
],
"PreexistingObj": [
{
"Preexisting_Deases": "",
"Status": "",
"Sincewhen": "",
"Remarks": ""
}
],
"PCSObj": [
{
"PCS_Code": ""
}
],
"ICDObj": [
{
"ICD_Code": ""
}
],
"DocObj": [
{
"UploadStatus": "",
"Filename": ""
}
]
}
Response Payload
| Field Name |
Data Type |
Mandatory/Non-mandatory |
Description |
| Code | String | Y | Response status code |
| Message | String | Y | Response message |
| Claim_Number | String | Y | Generated claim number |
| Pre_Auth_Id | String | Y | Pre-authorization ID |
Sample Response Payload
{
"Code": "200",
"Message": "Saved SuccessFully",
"Claim_Number": "122258533xxxx",
"Pre_Auth_Id": ""
}
PortalClaimDigitization
This API allows updating claim details such as policy number, claim amount, and process type in the ABHI Claims Portal. It supports secure data exchange for workflows like query replies and document uploads. A successful response confirms the claim update with status and error codes.
Request Payload
| Field Name |
Data Type |
Mandatory/Non-Mandatory |
Description |
| Policy_Number | string | Mandatory | Insurance policy identifier |
| Claim_No | string | Mandatory | Unique claim number |
| MemberId | string | Mandatory | Member identification number |
| Claim_Intimation_Through | string | Mandatory | Mode of claim intimation (e.g., Online) |
| Claim_Intimation_Source | string | Mandatory | Source system or channel of claim |
| Claim_Type | string | Mandatory | Type of claim (e.g., Reimbursement) |
| Process_Type | string | Non-Mandatory | Type of processing (if applicable) |
| Claim_flag | string | Non-Mandatory | Internal flag for claim status |
| Hospital_Name | string | Mandatory | Name of the hospital where treatment occurred |
| NOL | string | Non-Mandatory | Possibly No Objection Letter or similar |
| Remark | string | Mandatory | Additional remarks or comments |
| Date_of_Admission | string | Mandatory | Admission date of the patient |
| Time_of_Admission | string | Mandatory | Time of admission |
| Date_of_Discharge | string | Mandatory | Discharge date of the patient |
| Time_of_Discharge | string | Mandatory | Time of discharge |
| Claim_Amount | string | Mandatory | Total claim amount |
| Source_System_Code | string | Mandatory | Code representing the source system |
| DocumentuploadFlag | string | Mandatory | Indicates if documents were uploaded |
| Document_Received_Date | string | Mandatory | Date when documents were received |
| Document_Received_Time | string | Mandatory | Time when documents were received |
| Patient_Name | string | Mandatory | Full name of the patient |
Sample Request Payload
{
"UpdateClaimObj": [
{
"Policy_Number": "31-25-000XXXX-00",
"Claim_No": "1122585XXXXXX",
"MemberId": "",
"Claim_Intimation_Through": "Customer Portal/App",
"Claim_Intimation_Source": "Customer portal/App",
"Claim_Type": "Reimbursement",
"Process_Type": "",
"Claim_flag": "",
"Hospital_Name": "XXXXXX REASEARCH INSTITUTE & SUPER SPECIALITY HOSPITAL PVT LTD",
"NOL": "",
"Remark": "Response from customer portal",
"Date_of_Admission": "08/04/2025",
"Time_of_Admission": "00:00:00",
"Date_of_Discharge": "10/08/2025",
"Time_of_Discharge": "00:00:00",
"Claim_Amount": "81451",
"Source_System_Code": "Customer portal",
"DocumentuploadFlag": "Yes",
"Document_Received_Date": "10-24-2025",
"Document_Received_Time": "12:01",
"Patient_Name": "dummy dummy dummy"
}
]
}
Response Payload
| Field Name |
Data Type |
Description |
| Claim_Number | string | Unique identifier for the insurance claim |
| IsSucess | string | Indicates whether the claim submission was successful |
| Error_Msg | string | Message returned from the system (e.g., Success or error details) |
| Error_Code | string | Code representing the result of the operation (e.g., 0 for success) |
Sample Response Payload
{
"Claim_Number": "1122585xxxxx",
"IsSucess": "True",
"Error_Msg": "Success",
"Error_Code": "00"
}
Claim History
The Claim History API provides detailed information about a health insurance claim based on inputs like policy number, claim number, and member code. It returns structured data including patient details, hospital information, diagnosis, treatment type, and reimbursement status. This API helps insurers, healthcare providers, and support teams track claim progress and access related documents.
Request Payload
| Field Name |
Data Type |
Mandatory/Non-mandatory |
Description |
| ClientCode |
string |
Non-Mandatory |
Code representing the client or organization |
| PolicyNumber1 |
string |
Non-Mandatory |
Primary insurance policy number |
| ClaimNumber |
string |
Non-Mandatory |
Unique identifier for the claim |
| FamilyId |
string |
Non-Mandatory |
Identifier for the family group under the policy |
| MemberCode |
string |
Non-Mandatory |
Unique code identifying the insured member |
Sample Request Payload
{
"ClientCode": "",
"PolicyNumber1": "",
"ClaimNumber": "112258500xxxx/01",
"FamilyId": "",
"MemberCode": ""
}
Response Payload
| Field Name |
Data Type |
Description |
| Approved_Amount | string | Amount approved for the claim |
| Approved_Date | string | Date when the claim was approved |
| ClaimType | string | Type of claim (e.g., Cashless) |
| Claim_Amount | string | Total amount claimed |
| Claim_Number | string | Unique identifier for the claim |
| Claiment_Name | string | Name of the person claiming |
| Client_Code | string | Code representing the client |
| Client_Name | string | Name of the client |
| Date_Of_Admission | string | Date of hospital admission |
| Date_Of_Discharge | string | Date of hospital discharge |
| Diagnosis | string | Diagnosis details |
| DocName | string | List of required documents for claim processing |
| Document_Flag | string | Flag indicating document status |
| Hospital | string | Name of the hospital |
| Hospital_Address | string | Address of the hospital |
| Hospital_City | string | City where the hospital is located |
| Hospital_Name | string | Name of the hospital |
| Intermediary_Code | string | Code of the intermediary involved |
| Intimation_Date | string | Date when claim was intimated |
| Patient_Name | string | Name of the patient |
| Policy_End_Date | string | End date of the insurance policy |
| Policy_Start_Date | string | Start date of the insurance policy |
| Policy_Type | string | Type of insurance policy |
| Product | string | Insurance product name |
| Recommend_Date | string | Date of recommendation |
| Scheme | string | Insurance scheme name |
| Status | string | Current status of the claim |
| SubStatus | string | Sub-status of the claim |
| followUpDate | string | Date for follow-up |
| healthId | string | Health ID of the patient |
| isChildClaim | string | Indicates if the claim is for a child |
| mnyDeduction | string | Amount deducted from the claim |
| paidAmount | string | Amount paid out for the claim |
| procedures | string | Medical procedures performed |
| requirementsArrs | string | Array of additional requirements |
| totalSIUtilised | string | Total sum insured utilized |
| treatmentType | string | Type of treatment received |
| vchPolicyNumber | string | Voucher policy number |
| vchPriority | string | Priority level of the voucher |
| vchRemarks | string | Remarks related to the voucher |
Sample Response Payload
{
"ResponseObj": [
{
"Message": "Result fetched successfully.",
"Code": "200"
}
],
"Response": [
{
"Time_of_Admission ": "",
"Time_of_Discharge ": "",
"CKYC_Flag": "",
"CKYC_Number": "",
"BankName": "AXIS BANK",
"BankBranch": "KOLKATA",
"IFSCCode": "UTIB0000016",
"AccountNumber": "123123123",
"Intermediary_Code": "",
"Gender": "F",
"DateOfBirth": "01/01/1996",
"Status": "RI Registration Raised",
"SubStatus": "RI Registration Raised",
"Claim_Number": "1122585004098/01",
"Claim_Amount": "33",
"vchPolicyNumber": "31-25-0003448-00",
"vchPriority": "",
"mnyDeduction": "",
"vchRemarks": "",
"Policy_Start_Date": "01/01/2025",
"Policy_End_Date": "31/12/2025",
"Claiment_Name": "Eertrey ",
"Patient_Name": "Eertrey ",
"PCSDetails": null,
"ICDDetails": [],
"Date_Of_Admission": "01/07/2025",
"Date_Of_Discharge": "04/07/2025",
"Client_Name": "Vjhkhj Hjfkjh",
"Hospital_Code": "HS2514649054",
"Hospital_Name": "Non Vitraya",
"Hospital": "Non Vitraya",
"Hospital_Address": "SDFG",
"Hospital_City": "Mumbai",
"Product": "Activ One",
"Policy_Type": "Activ One Max",
"ClaimType": "Reimbursement",
"Intimation_Date": "01/07/2025",
"Diagnosis": "",
"Approved_Amount": "",
"Client_Code": "PT14895180",
"Scheme": "",
"Recommend_Date": "",
"Approved_Date": "",
"Document_Flag": "",
"DocName": "Claim form- duly filled & signed*,Consultations,Discharge summary*,Investigation reports*,Hospital bills*,Pharmacy bills,Indoor case papers & daily Doctors notes,NEFT/Cancelled cheque/bank passbook*,Other,KYC (This option in case claim amount is equal or more than 1 Lakh)",
"isChildClaim": "",
"requirementsArrs": [],
"followUpDate": "10/10/2025 10:50:18",
"healthId": "6051092512434665",
"totalSIUtilised": "",
"procedures": "",
"treatmentType": "",
"paidAmount": "",
"coverSetAttribute": [
{
"name": "Cover",
"value": "IPTT"
},
{
"name": "Cover Name",
"value": "In-patient Hospitalization"
},
{
"name": "Expected Amount",
"value": "33"
},
{
"name": "Approved Amount",
"value": ""
},
{
"name": "Balance Sum insured",
"value": "0"
}
],
"claimFollowUp": [
{
"createdBy": "APIUSER",
"eventCode": "RR",
"followUpDescription": "",
"followUpStatusCode": "RR",
"followUpTime": "10/10/2025 10:50:18",
"remarks": "",
"updatedBy": "APIUSER"
},
{
"createdBy": "APIUSER",
"eventCode": "Q",
"followUpDescription": "",
"followUpStatusCode": "Q",
"followUpTime": "10/10/2025 10:50:14",
"remarks": "",
"updatedBy": "APIUSER"
}
]
}
]
}
MemberSearch
The Member Search API allows users to retrieve detailed coverage information for a specific insured member under a health policy. By providing inputs like policy number and member code, the API returns a list of benefits such as treatment types, coverage codes, and policy details. It helps insurers, healthcare providers, and digital platforms display personalized coverage data.
Request Payload
| Field Name |
Data Type |
Mandatory / Non-Mandatory |
Description |
| Policy_Number |
string |
Mandatory |
Unique identifier for the insurance policy |
| Family_ID |
string |
Non-Mandatory |
Identifier for the family group under the policy |
| Member_Code |
string |
Mandatory |
Unique code identifying the insured member |
Sample Request Payload
{
"SearchMemberObj": {
"Policy_Number": "31-25-000xxxx-00",
"Family_ID": "",
"Member_Code": "PT1489xxxx"
}
}
Response Payload
| Field Name |
Data Type |
Description |
| Member_Code |
string |
Unique code identifying the insured member |
| Cover_Code |
string |
Code representing the specific coverage benefit |
| Cover_Name |
string |
Name of the coverage benefit |
| Loss_Type_Code |
string |
Code indicating the type of loss (if applicable) |
| Policy_Number |
string |
Insurance policy number |
| Member_Name |
string |
Full name of the insured member |
| Date_of_Birth |
string |
Date of birth of the member |
| Gender |
string |
Gender of the member |
| Relation |
string |
Relationship of the member to the policyholder |
| Limit |
string |
Coverage limit for the benefit (if applicable) |
| Applicable_Options |
string |
Additional options or conditions applicable to the coverage |
Sample Response Payload
{
"Response": [
{
"Member_Code": "PT1489xxxx",
"Cover_Code": "52234108",
"Cover_Name": "AYUSH Treatment",
"Policy_Number": "31-25-000xxxx-00",
"Member_Name": "dummy dummy",
"Date_of_Birth": "07/08/2000",
"Gender": "M",
"Relation": "Self"
},
{
"Member_Code": "PT1489xxxx",
"Cover_Code": "6212xxxx",
"Cover_Name": "Domiciliary Hospitalization",
"Policy_Number": "31-25-00xxxxx-00",
"Member_Name": "dummy dummy",
"Date_of_Birth": "07/08/2000",
"Gender": "M",
"Relation": "Self"
},
],
"responseCode": "",
"responseMessage": ""
}
Policy Insured
The Policy Insured API retrieves detailed information about an insured member under a specific health insurance policy. By using the PolicyNumber and MemberId as path parameters, it returns member demographics, coverage details, and policy attributes. This API helps insurers, healthcare platforms, and support teams access accurate member-level data instantly.
Response Payload
| Parent Node |
Field Name | Data Type |
Description |
| PolicyDetail | PolicyNumber | string | Unique identifier for the insurance policy |
| PolicyExpiryDate | string | Date when the policy expires |
| PolicyStatus | string | Current status of the policy |
| Plan | string | Name of the insurance plan |
| MasterPolicyNumber | string | Master policy reference number |
| Product | string | Insurance product name |
| proposer_pan_number | string | PAN number of the proposer |
| FamilyDefinition | string | Type of family coverage |
| UWDependentEntitlement | string | Underwriting dependent entitlement |
| ApplicationDate | string | Date of application submission |
| ValidFrom | string | Policy start date |
| ValidTo | string | Policy end date |
| Tenure | string | Duration of the policy |
| BusinessType | string | Type of business |
| Parent_Policy_Number | string | Reference to parent policy |
| Medical_Type | string | Type of medical coverage |
| Quote_Type | string | Quote classification |
| Sub_Quote_Type | string | Sub classification of quote |
| HAN_Number | string | Health Account Number |
| OPD_reference_number | string | Reference number for OPD claims |
| policy_start_date | string | Start date of the policy |
| CKYC_Number | string | Central KYC number |
| CKYC_Flag | string | Central KYC verification flag |
| AML_Flag | string | Anti-Money Laundering flag |
| If_FaceMatch | string | Face match verification status |
| Digi_Locker_Verified | string | DigiLocker verification status |
| Kyc_Transition_id | string | KYC transition identifier |
| Politically_Exposed_Person | string | PEP flag |
| ApplicationNo | string | Application number |
| Post_issuance_date | string | Date of post issuance |
| Post_issuance_time | string | Time of post issuance |
| NumberofAdults | string | Number of adults covered |
| NumberofChildren | string | Number of children covered |
| PolicyOwnerName | string | Full name of the policy owner |
| PolicyOwnerFirstName | string | First name of the policy owner |
| PolicyOwnerMiddleName | string | Middle name of the policy owner |
| PolicyOwnerLastName | string | Last name of the policy owner |
| CustomerCode | string | Unique customer identifier |
| DateOfBirth | string | Date of birth of the policyholder |
| ProposarAge | string | Age of the proposer |
| Gender1 | string | Gender of the proposer |
| MaritalStatus | string | Marital status of the proposer |
| Nationality | string | Nationality of the proposer |
| Mobile | string | Mobile number |
| Email | string | Email address |
| vchNominee | string | Nominee code |
| Relationship | string | Relationship with nominee |
| NomineeName | string | Name of the nominee |
| Nominee_DOB | string | Date of birth of the nominee |
| Nominee_Gender | string | Gender of the nominee |
| NomineeAddress | string | Address of the nominee |
| NomineeContactNumber | string | Contact number of the nominee |
| AccountNumber | string | Bank account number |
| ConfirmAccountNumber | string | Confirmation of bank account number |
| IFSCCode | string | Bank IFSC code |
| BankName | string | Name of the bank |
| BankBranchName | string | Branch name of the bank |
| MICRCode | string | MICR code of the bank |
| AccountType | string | Type of bank account |
| BankPriority | string | Priority of the bank account |
| Policy_Expired | string | Indicates if the policy is expired |
| InsuredDetail | MemberId | string | Unique member identifier |
| FullName | string | Full name of the insured member |
| vchRelation | string | Relationship to the proposer |
| DateOfBirth | string | Date of birth of the member |
| Gender | string | Gender of the member |
| Cover_Details | Cover_Code | string | Code for the coverage benefit |
| Cover_Discription | string | Description of the coverage |
| SumInsured | string | Sum insured for the coverage |
| Mandatory_or_Optional | string | Indicates if coverage is mandatory or optional |
Sample Request Payload
{
"Response": {
"PolicyDetail": {
"PolicyNumber": "GHI-41-25-000xxxx-000",
"PolicyExpiryDate": "01/07/2026",
"PolicyStatus": "IF",
"Plan": "MasterPolicyNumber",
"Product": "Group Activ Health V3",
"proposer_pan_number": "IXxxxx",
"FamilyDefinition": "Individual",
"UWDependentEntitlement": "Self",
"ApplicationDate": "2025-07-02",
"ValidFrom": "2025-07-02",
"ValidTo": "2026-07-01",
"Tenure": "1",
"BusinessType": "New Business",
"PolicyOwnerName": "dummy dummy",
"CustomerCode": "PT147xxxxx",
"DateOfBirth": "1984-06-12",
"ProposarAge": "41",
"Gender1": "M",
"HomeAddress": {
"Home_State": "MAHARASHTRA",
"Home_District": "Amravati",
"Home_City": "Amravati",
"Home_Pincode": "444606"
},
"Mobile": "9860378813",
"Email": "dummy-v@gmail.com",
"SumInsured": "100000",
"NetPremium": "1155.22",
"AnnualPremium": "1155.22",
"agentCode": "2103154",
"agentName": "HDFC Bank - Telesales Group Business",
"channel": "BANCA",
"Policy_Expired": "No",
"InsuredDetail": {
"MemberId": "PT1476xxxxx",
"FullName": "dummy",
"Gender": "Male",
"SumInsuredPerUnit": "100000"
},
"Cover_Details": [
{"Cover_Code": "AC", "Cover_Discription": "Attendant Charges"},
{"Cover_Code": "ACCD", "Cover_Discription": "Accidental Death Cover (AD)"},
{"Cover_Code": "AIRAMBX", "Cover_Discription": "Air Ambulance Expenses"}
]
}
}
}
ProviderSearch
The Provider Search API enables users to search for healthcare providers based on location parameters such as city and state. It supports optional geolocation inputs like latitude and longitude for more precise results.
Request Payload
| Field Name |
Data Type |
Mandatory / Non-Mandatory |
Description |
| city |
string |
Mandatory |
Name of the city where provider search is to be performed |
| state |
string |
Mandatory |
Name of the state corresponding to the city |
| latitute |
number (nullable) |
Non-Mandatory |
Latitude coordinate for location-based search |
| longitude |
number (nullable) |
Non-Mandatory |
Longitude coordinate for location-based search |
Sample Request Payload
{
"city": "Carnicobar",
"state": "Andaman & Nicobar Islands",
"latitute": "",
"longitude": ""
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| Root |
partyLists |
null |
List of provider parties (currently null) |
| response |
responseCode |
string |
Code indicating the result of the API call |
| responseMessage |
string |
Message describing the outcome of the API call |
| messages |
null |
Additional messages or details (currently null) |
OmniDocsUpload
The Omni Upload API facilitates secure document uploads from external systems to the document management system. It accepts metadata like category ID, document ID, file name, and optional reference details, along with classification parameters. Upon successful upload, the API returns a unique global ID, document and image indexes, and a status message.
Request Payload
| Field Name |
Data Type |
Mandatory / Non-Mandatory |
Description |
| CategoryID |
string |
Mandatory |
Identifier for the document category |
| DocumentID |
string |
Mandatory |
Unique identifier for the document |
| ReferenceID |
string (nullable) |
Non-Mandatory |
Reference identifier linked to the document |
| SharedPath |
string (nullable) |
Non-Mandatory |
Path where the document is shared or stored |
| FileName |
string |
Mandatory |
Name of the uploaded file |
| Description |
string |
Mandatory |
Description or purpose of the document |
| DocSearchParamId |
string |
Mandatory |
Identifier for the document search parameter |
| Value |
string |
Mandatory |
Value associated with the document search parameter |
| SourceSystemName |
string |
Mandatory |
Name of the source system initiating the upload |
| Identifier |
string |
Mandatory |
Unique identifier for the upload request (e.g., bytearray) |
Sample Response Payload
{
"UploadRequest": {
"CategoryID": "1001",
"DocumentID": "2365",
"ReferenceID": "SharedPath",
"FileName": "112258535xxxx_CKYC Proof_202510201xxxxxx_2.jpg",
"Description": "112258535xxxx_CKYC Proof_2025102010xxxx_2.jpg",
"DataClassParam": {
"DocSearchParamId": "1",
"Value": "112258535xxxx"
},
"AdditionalParams": {
"DocSearchParamId": "2",
"Value": "31-25-008xxxx-00"
},
"Year": "2025",
"Month": "October",
"SourceSystemName": "ubona",
"Identifier": "ByteArray"
}
}
Response Payload
| Field Name |
Data Type |
Description |
| GlobalId |
string |
System-generated unique identifier for the uploaded document |
| CategoryId |
string |
Identifier for the document category |
| DocumentId |
string |
Unique identifier for the document type |
| ReferenceId |
string |
Reference identifier linked to the document (if applicable) |
| FileName |
string |
Name of the uploaded file |
| DocumentIndex |
string |
Index number assigned to the document in the system |
| ImageIndex |
string |
Index number assigned to the image in the system |
| Status |
string |
Upload status of the document (e.g., SUCCESS) |
| Code |
string |
Status code indicating the result of the upload |
| Description |
string |
Description of the upload result or error message |
Sample Response Payload
{
"UploadResponse": {
"GlobalId": "DE965288F00A4436A76xxxxx",
"CategoryId": "1001",
"DocumentId": "2365",
"ReferenceId": "",
"FileName": "1122585353938_CKYC Proof_2025102010xxxx_2.jpg",
"DocumentIndex": "80006xxx",
"ImageIndex": "85490xxx",
"Status": "SUCCESS",
"Error Code": "0",
"Description": "SUCCESS"
}
}
PrepostClaims
This API is used for pre-authorization claim submission in a health insurance system. It accepts detailed claim information such as policy number, hospital details, admission/discharge dates, and patient details, and responds with a confirmation message including a generated claim number and status.
Request Payload
| Parent Node |
Field Name |
Data Type |
Mandatory / Non-Mandatory |
Description |
| PreAuthObj | Policy_Number | string | Mandatory | Policy Number |
| FamilyId | string | Mandatory | Family ID |
| Claim_Intimation_Through | string | Mandatory | Mode of claim intimation |
| Claim_Intimation_Source | string | Mandatory | Source of claim intimation |
| Intimation_Type | string | Mandatory | Type of claim (e.g., Reimbursement) |
| Cover_code | string | Mandatory | Coverage code |
| Cover_Name | string | Mandatory | Name of the coverage |
| Hospital_Name | string | Non-Mandatory | Name of the hospital |
| Hospital_Code | string | Mandatory | Hospital identifier code |
| Diagnosis | string | Mandatory | Diagnosis description |
| Date_of_Admission | string | Mandatory | Date of admission |
| Time_of_Admission | string | Mandatory | Time of admission |
| Date_of_Discharge | string | Mandatory | Date of discharge |
| Time_of_Discharge | string | Mandatory | Time of discharge |
| Claim_Amount | string | Mandatory | Claimed amount |
| Source_System_Code | string | Mandatory | System source code |
| Document_Received_Date | string | Mandatory | Date when documents were received |
| Document_Received_Time | string | Mandatory | Time when documents were received |
| Patient_Name | string | Non-Mandatory | Name of the patient |
| Bank_Name | string | Mandatory | Name of the bank |
| Bank_Branch_Name | string | Mandatory | Branch name of the bank |
| Account_No | string | Mandatory | Bank account number |
| IFSC_Code | string | Mandatory | IFSC code of the bank |
| ParentClaimNumber | string | Mandatory | Reference to parent claim |
| PreexistingObj | Preexisting_Deases | string | Non-Mandatory | Pre-existing disease name |
| Status | string | Non-Mandatory | Status of the disease |
| Sincewhen | string | Non-Mandatory | Duration since disease exists |
| Remarks | string | Non-Mandatory | Additional remarks |
| PCSObj | PCS_Code | string | Non-Mandatory | Procedure code |
| ICDObj | ICD_Code | string | Non-Mandatory | ICD diagnosis code |
| DocObj | UploadStatus | string | Mandatory | Status of document upload |
| Filename | string | Non-Mandatory | Name of the uploaded file |
Sample Request Payload
{
"PreAuthObj": {
"Policy_Number": "GHI-41-25-000xxxx-000",
"FamilyId": "PT1487xxxx",
"Claim_Intimation_Through": "Online",
"Claim_Intimation_Source": "CUSTOMERPORTAL",
"Intimation_Type": "Reimbursement",
"Cover_code": "42114101",
"Cover_Name": "In-Patient hospitalization",
"Hospital_Name": null,
"Hospital_Code": "HS00001273",
"Diagnosis": "",
"Date_of_Admission": "08/28/2025",
"Time_of_Admission": "",
"Date_of_Discharge": "08/30/2025",
"Time_of_Discharge": "",
"Claim_Amount": "34324",
"Source_System_Code": "CUSTOMERPORTAL",
"Document_Received_Date": "10/20/2025",
"Document_Received_Time": "11:06",
"Patient_Name": null,
"Co_morbidities": "",
"Service_flag": "",
"Name_Of_Treating_Doctor": "",
"Doctor_Contact_No": "",
"Duration_Of_Present_Ailment": "",
"Proposed_line_of_treatment": "",
"Investigation_MedicalManagementDetails": "",
"Name_Of_Surgery": "",
"IRDA_Code_Of_surgery": "",
"How_did_injury_occur": "",
"Case_Of_accident": "",
"IsItRTA": "",
"Date_Of_Inhury": "",
"ReportedtoPolice": "",
"FirNo": "",
"Injury_Disease_Alcohalconsumption": "",
"IsMaternity": "",
"G": "",
"P": "",
"L": "",
"A": "",
"Date_Of_Delivery": "",
"Emergency_Planned_Event": "",
"Room_Type": "",
"DeaseasWithPresentingComplaints": "",
"ReleventClinicalFinding": "",
"DateOfFirstConsultation": "",
"ProvisionalDiagnosis": "",
"Doctor_Registration_No": "",
"IsPreexisting": "",
"IsNaturalCalamityCase": "",
"Test_ConductedToEstablishThis": "",
"AlcohalordrugAbuse": "",
"AnyHivorStdRelatedAilments": "",
"AnyOtherAilments": "",
"Other_Ind": "",
"Hospital_Nm": "",
"Hospital_Address": "",
"Hospital_Country": "",
"Hospital_State": "",
"Hospital_District": "",
"Hospital_City": "",
"Hospital_PinCode": "",
"Hospital_Mail": "",
"Hospital_StdCode": "",
"Hospital_PhoneNo": "",
"Hospital_MobileNo": "",
"Hospital_FaxNo": "",
"Hospital_WebSite": "",
"Hospital_LandMark": "",
"CKYC_Flag": "N",
"CKYC_Number": "",
"Account_HolderName": "",
"Bank_Name": "AXIS BANK",
"Bank_Branch_Name": "MUMBAI BRANCH",
"Account_No": "1730102xxxxxxx",
"IFSC_Code": "UTIB000xxxx",
"ParentClaimNumber": "122258500xxxx"
},
"PreexistingObj": [ {"Preexisting_Deases": "", "Status": "", "Sincewhen": "", "Remarks": ""} ],
"PCSObj": [ {"PCS_Code": ""} ],
"ICDObj": [ {"ICD_Code": ""} ],
"DocObj": [ {"UploadStatus": "No", "Filename": ""} ]
}
Response Payload
| Field Name |
Data Type |
Description |
| Code |
string |
Response code indicating the result of the API call |
| Message |
string |
Message describing the outcome of the operation |
| Claim_Number |
string |
Unique identifier for the insurance claim |
| claimStatus |
string |
Current status of the claim process |
Sample Response Payload
{
"Code": "200",
"Message": "Saved SuccessFully",
"Claim_Number": "122258500xxxx/02",
"claimStatus": "RI Registration Raised"
}
Endorsement
The Endorsement API is designed to facilitate the submission and processing of endorsement requests for insurance policies. In the insurance domain, an endorsement refers to any formal amendment or update made to an existing policy.
These changes can be initiated by the policyholder or the insurer and may include modifications to personal details, coverage terms, beneficiary information, or other policy-related attributes.
Request Payload
| Parent Node |
Field Name |
Data Type |
Mandatory/Non-mandatory |
Description |
| Root | endorsementReason | String | Yes | Reason for the endorsement |
| eventEffectiveDate | String (Date) | No | Effective date of the endorsement |
| roleCode | String | Yes | Role of the user initiating the request |
| typeofEndorsement | String | Yes | Type of endorsement |
| endorsementAttribute | Array of Objects | No | Additional endorsement attributes |
| endorsementAttribute[] | name | String | Yes | Name of the attribute |
| value | String | No | Value of the attribute |
| createProposalRequest | flag | String | Yes | Operation flag (e.g., 'E' for endorsement) |
| productCode | String | No | Product code of the insurance policy |
| policyBranch | String | No | Branch code of the policy |
| policyTermUnit | String | No | Unit of policy term |
| policyInceptionDate | String (Date) | No | Start date of the policy |
| policyStatus | String | No | Current status of the policy |
| premiumDepositMode | String | No | Mode of premium deposit |
| premiumFrequency | String | No | Frequency of premium payment |
| proposalNumber | String | No | Proposal number |
| policyNumber | String | Yes | Unique identifier of the policy |
| alternateemail | String | No | Alternate email of the policyholder |
| alternatemobilenumber | String | No | Alternate mobile number |
| policyExpiryDate | String (Date) | No | Expiry date of the policy |
| policyTerm | String | No | Duration of the policy |
| baseCurrencyRate | Decimal/String | No | Exchange rate for base currency |
| baseCurrency | String | No | Base currency |
| premiumCurrencyRate | Decimal/String | No | Exchange rate for premium currency |
| premiumCurrency | String | No | Premium currency |
| entityType | String | No | Type of entity (individual/organization) |
| basicdetailAttribute | Array | No | Additional basic details |
| paymentInfo | Array | No | Payment-related information |
| members | Array of Objects | No | List of insured members |
| members[] | benefits | Array | No | Benefits applicable to the member |
| discount | Decimal/String | No | Discount applied |
| expiryDate | String (Date) | No | Member coverage expiry date |
| grosspremium | Decimal/String | No | Gross premium amount |
| inceptionDate | String (Date) | No | Member coverage start date |
| loading | Decimal/String | No | Loading applied to premium |
| medicalDetails | Array | No | Medical details |
| medicalDigitization | Array | No | Digitized medical records |
| memberDetails | Array of Objects | No | Additional member attributes |
| netpremium | Decimal/String | No | Net premium amount |
| party | Object | Yes (partial) | Party details of the member |
| questionnaire | Array | No | Questionnaire responses |
| requirement | Array | No | Requirements for the member |
| memberDetails[] | name | String | Yes | Name of the attribute |
| value | String | Yes | Value of the attribute |
| multisetAttribute | Array | No | Additional attributes |
| party | partyCode | String | Yes | Unique identifier for the party |
| firstName | String | No | First name |
| lastName | String | No | Last name |
| middleName | String | No | Middle name |
| initial | String | No | Initials |
| otherName | String | No | Other name |
| dateofBirth | String (Date) | No | Date of birth |
| sex | String | No | Gender |
| nationality | String | No | Nationality |
| occupation | String | No | Occupation |
| contactDetails | Array | No | Contact information |
| partyDetails | Array | No | Additional party details |
| businessName | String | No | Business name |
| company | String | No | Company name |
| citizenshipId | String | No | Citizenship ID |
| parentPartyCode | String | No | Parent party code |
| indvOrOrg | String | No | Individual or Organization |
| effectiveDate | String (Date) | No | Effective date |
| createProposalRequest | documents | Array | No | Document list |
| requirements | Array | No | Requirement list |
| policyPaymentCycleDetails | Array | No | Policy payment cycle details |
| notes | Array | No | Notes |
| collectionDetail | Array | No | Collection details |
| endorsementDetails | Array | No | Endorsement details |
Sample Request Payload
{
"CrossSaleReferenceNumber": "",
"Endorsement": [
{
"Service_Request_Number": "182924xxxx",
"Policy_Number": "21-25-000xxxx-00",
"Home_Address1": "",
"Home_Address2": "",
"Home_Address3": "",
"Home_Pincode": "",
"Home_Mobile1": "",
"Home_Mobile2": "",
"Home_Mobile3": "",
"Home_LandLine1": "",
"Home_LandLine2": "",
"Home_FaxNo": "",
"Home_Area": "",
"SameASHome": "",
"Mailling_Address1": "",
"Mailling_Address2": "",
"Mailling_Address3": "",
"Mailling_Pincode": "",
"MemObj": {
"Member": {
"Member_AdharNumber": "",
"Member_AlternateEmailId": "",
"Member_AlternateNumber": "",
"Member_AnnualIncome": "",
"Member_ContactNumber": "",
"Member_Education": "",
"Member_EmailId": "",
"Member_FirstName": "",
"Member_Height": "",
"Member_LastName": "",
"Member_Occupation": "",
"Member_PAN": "",
"Member_Weight": "",
"MemberCode": "",
"MemberNo": ""
}
},
"Mailling_Mobile1": "",
"Mailling_Mobile2": "",
"Mailling_Mobile3": "",
"Mailling_LandLine1": "",
"Mailling_LandLine2": "",
"Mailling_FaxNo": "",
"Mailling_Area": "",
"Email1": "",
"Email2": "",
"Email3": "",
"Alternateemail": "",
"AADHAR_Number": "",
"PAN": "",
"Nominee_Relationship": "",
"Nominee_Name": "",
"Nominee_Contact_Number": "",
"Height": "",
"Weight": "",
"Country_Code": "",
"Internation_Contact_No": "",
"Internation_Address": "",
"Flag": "18",
"PostIssuanceDate": "06/10/2025",
"PostIssuanceTime": "15:19",
"eventeffectivedate": "06/10/2025",
"PreferredLanguages": "MR"
}
],
"IsCombi": "N"
}
Response Payload
| Parent Node |
Field Name |
Data Type |
Description |
| Root | clonePolicyNumber | String | Policy number being cloned for endorsement |
| isFinancialEndorsement | String (Enum: Y/N) | Indicates if the endorsement has financial implications |
| memberPremiumDetails[] | memberCode | String | Unique code identifying the member |
| memberName | String | Full name of the member |
| grosspremium | Decimal | Gross premium amount before taxes and discounts |
| netpremium | Decimal | Net premium amount after adjustments |
| taxAmount | Decimal | Tax amount applicable to the member |
| premiumDetailsBeforeEndorsement.premiumDetails[] | name | String | Name of the premium component before endorsement |
| value | Decimal/String | Value of the premium component before endorsement |
| premiumDetailsAfterEndorsement.premiumDetails[] | name | String | Name of the premium component after endorsement |
| value | Decimal/String or Null | Value of the premium component after endorsement |
| response | responseCode | String | Response code indicating success or failure |
| responseMessage | String | Message describing the result of the endorsement |
| messages | Null or Array | Additional messages or errors, if any |
Sample Response Payload
{
"Response": {
"ErrorNumber": "0",
"ErrorMessage": "Sucess",
"Endorsement_Number": "12-25-003xxxx-00-01",
"DCN_Number": "",
"Status": "CH",
"Policy_Number": "12-25-003xxxx-00",
"InwardNumber": "25000255xxxx"
}
}