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:

  1. 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.
  2. 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.
  3. 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.
  4. 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.
  5. Final Policy Issuance: The Full Quote API is invoked to issue the final policy, marking the completion of the digital onboarding journey.
  6. 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.

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

Requirements

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

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

CodeMeaningDescription
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 CreationObject
salutationstring5YesReference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others
firstNamestring250YesFirst name of proposer
middleNamestring250NoMiddle name of proposer
lastNamestring250YesLast name of proposer
dateofBirthstring-YesDOB of proposer. Only MM/DD/YYYY Format will be Accepted
genderstring3YesReference Master Value (M, F, T)
educationalQualificationstring20NoReference Master Value (Below Metric, Graduate, etc.)
pinCodestring25YesPincode of Proposer
uidNostring30NoUID number
maritalStatusstring10YesReference Master Value
nationalitystring200YesReference Master Value (Indian, NRI, etc.)
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document number
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document 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
PolCreationResponsquoteNumberStringUnique identifier for the quote
customerIdStringCustomer's unique ID
Source_NameStringSource system or channel name
productNameStringName of the insurance product
productCodeStringCode representing the product
lineOfBusinessStringType of insurance business
quoteStatusStringStatus of the quote
quoteValidFromDateString (Date)Start date of quote validity
quoteValidToDateString (Date)End date of quote validity
policyNumberStringPolicy number
proposalNumberStringProposal number
policyStatusStringStatus of the policy
tenureStringDuration of the policy in years
stpflagStringStraight-through processing flag
MedicalTestInfoStringMedical test information
premiumDetailsArrayContains premium-related details
PremiumBasePremiumStringOriginal premium before discounts/loadings
NetPremiumStringPremium after discounts
ServiceTaxStringService tax amount
SBCStringSwachh Bharat Cess
KKCStringKrishi Kalyan Cess
BMI_loadingStringLoading based on BMI
GrossPremiumStringTotal premium before final adjustments
FinalPremiumStringFinal payable premium
ErrorObjecterrorCodeStringError code
errormessageStringError message
ReceiptCreationResponseerrorMessageStringMessage indicating success or failure
errorNumberStringError number
ReceiptNumberStringReceipt number generated
ReceiptAmountStringAmount received
ExcessAmountStringExcess 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 CreationObject
salutationstring5YesReference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others
firstNamestring250YesFirst name of proposer
middleNamestring250NoMiddle name of proposer
lastNamestring250YesLast name of proposer
dateofBirthstring-YesDOB of proposer. Only MM/DD/YYYY Format will be Accepted
genderstring3YesReference Master Value (M, F, T)
educationalQualificationstring20NoReference Master Value (Below Metric, Graduate, etc.)
pinCodestring25YesPincode of Proposer
uidNostring30NoUID number
maritalStatusstring10YesReference Master Value
nationalitystring200YesReference Master Value (Indian, NRI, etc.)
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document number
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document 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
PolCreationResponsquoteNumberStringUnique identifier for the quote
customerIdStringCustomer's unique ID
Source_NameStringSource system or channel name
productNameStringName of the insurance product
productCodeStringCode representing the product
lineOfBusinessStringType of insurance business
quoteStatusStringStatus of the quote
quoteValidFromDateString (Date)Start date of quote validity
quoteValidToDateString (Date)End date of quote validity
policyNumberStringPolicy number
proposalNumberStringProposal number
policyStatusStringStatus of the policy
tenureStringDuration of the policy in years
stpflagStringStraight-through processing flag
MedicalTestInfoStringMedical test information
premiumDetailsArrayContains premium-related details
PremiumBasePremiumStringOriginal premium before discounts/loadings
NetPremiumStringPremium after discounts
ServiceTaxStringService tax amount
SBCStringSwachh Bharat Cess
KKCStringKrishi Kalyan Cess
BMI_loadingStringLoading based on BMI
GrossPremiumStringTotal premium before final adjustments
FinalPremiumStringFinal payable premium
ErrorObjecterrorCodeStringError code
errormessageStringError message
ReceiptCreationResponseerrorMessageStringMessage indicating success or failure
errorNumberStringError number
ReceiptNumberStringReceipt number generated
ReceiptAmountStringAmount received
ExcessAmountStringExcess 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 CreationObject
salutationstring5YesReference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others
firstNamestring250YesFirst name of proposer
middleNamestring250NoMiddle name of proposer
lastNamestring250YesLast name of proposer
dateofBirthstring-YesDOB of proposer. Only MM/DD/YYYY Format will be Accepted
genderstring3YesReference Master Value (M, F, T)
educationalQualificationstring20NoReference Master Value (Below Metric, Graduate, etc.)
pinCodestring25YesPincode of Proposer
uidNostring30NoUID number
maritalStatusstring10YesReference Master Value
nationalitystring200YesReference Master Value (Indian, NRI, etc.)
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document number
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document 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
PolCreationResponsquoteNumberStringUnique identifier for the quote
customerIdStringCustomer's unique ID
Source_NameStringSource system or channel name
productNameStringName of the insurance product
productCodeStringCode representing the product
lineOfBusinessStringType of insurance business
quoteStatusStringStatus of the quote
quoteValidFromDateString (Date)Start date of quote validity
quoteValidToDateString (Date)End date of quote validity
policyNumberStringPolicy number
proposalNumberStringProposal number
policyStatusStringStatus of the policy
tenureStringDuration of the policy in years
stpflagStringStraight-through processing flag
MedicalTestInfoStringMedical test information
premiumDetailsArrayContains premium-related details
PremiumBasePremiumStringOriginal premium before discounts/loadings
NetPremiumStringPremium after discounts
ServiceTaxStringService tax amount
SBCStringSwachh Bharat Cess
KKCStringKrishi Kalyan Cess
BMI_loadingStringLoading based on BMI
GrossPremiumStringTotal premium before final adjustments
FinalPremiumStringFinal payable premium
ErrorObjecterrorCodeStringError code
errormessageStringError message
ReceiptCreationResponseerrorMessageStringMessage indicating success or failure
errorNumberStringError number
ReceiptNumberStringReceipt number generated
ReceiptAmountStringAmount received
ExcessAmountStringExcess 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 CreationObject
salutationstring5YesReference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others
firstNamestring250YesFirst name of proposer
middleNamestring250NoMiddle name of proposer
lastNamestring250YesLast name of proposer
dateofBirthstring-YesDOB of proposer. Only MM/DD/YYYY Format will be Accepted
genderstring3YesReference Master Value (M, F, T)
educationalQualificationstring20NoReference Master Value (Below Metric, Graduate, etc.)
pinCodestring25YesPincode of Proposer
uidNostring30NoUID number
maritalStatusstring10YesReference Master Value
nationalitystring200YesReference Master Value (Indian, NRI, etc.)
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document number
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document 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
PolCreationResponsquoteNumberStringUnique identifier for the quote
customerIdStringCustomer's unique ID
Source_NameStringSource system or channel name
productNameStringName of the insurance product
productCodeStringCode representing the product
lineOfBusinessStringType of insurance business
quoteStatusStringStatus of the quote
quoteValidFromDateString (Date)Start date of quote validity
quoteValidToDateString (Date)End date of quote validity
policyNumberStringPolicy number
proposalNumberStringProposal number
policyStatusStringStatus of the policy
tenureStringDuration of the policy in years
stpflagStringStraight-through processing flag
MedicalTestInfoStringMedical test information
premiumDetailsArrayContains premium-related details
PremiumBasePremiumStringOriginal premium before discounts/loadings
NetPremiumStringPremium after discounts
ServiceTaxStringService tax amount
SBCStringSwachh Bharat Cess
KKCStringKrishi Kalyan Cess
BMI_loadingStringLoading based on BMI
GrossPremiumStringTotal premium before final adjustments
FinalPremiumStringFinal payable premium
ErrorObjecterrorCodeStringError code
errormessageStringError message
ReceiptCreationResponseerrorMessageStringMessage indicating success or failure
errorNumberStringError number
ReceiptNumberStringReceipt number generated
ReceiptAmountStringAmount received
ExcessAmountStringExcess 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 CreationObject
salutationstring5YesReference Master Value e.g. Dr, M/S , Miss, Mr, Mrs , Ms, Others
firstNamestring250YesFirst name of proposer
middleNamestring250NoMiddle name of proposer
lastNamestring250YesLast name of proposer
dateofBirthstring-YesDOB of proposer. Only MM/DD/YYYY Format will be Accepted
genderstring3YesReference Master Value (M, F, T)
educationalQualificationstring20NoReference Master Value (Below Metric, Graduate, etc.)
pinCodestring25YesPincode of Proposer
uidNostring30NoUID number
maritalStatusstring10YesReference Master Value
nationalitystring200YesReference Master Value (Indian, NRI, etc.)
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document number
occupationstring20NoReference Master Value
primaryEmailIDstring50YesMail ID
contactMobileNostring15YesContact Number
stdLandlineNostring15NoSTD landline number
panNostring15Yes in case of id proof Pan cardPan number. PAN is required if Premium is more than 1 Lakh, also incase id proof is pan card
passportNumberstring20Yes in Case of id Proof PassportPassport number
contactPersonstring100NoContact person name
annualIncomestring(18, 2)NoIf Sum insured is 5 lakh and above then its mandatory to provide anunual income of proposer.
remarksstringmaxNoRemarks
startDatestringNostart date (only MM/DD/YYYY Format will be Accepted)
endDatestringNoend date (only MM/DD/YYYY Format will be Accepted)
IdProofstring100NoReference Master Value (e.g."Aadhaar Card", "Pan Card" ..)
residenceProofstring100NoReference Master Value for Residence proof type
ageProofstring100NoValue of "IdProof" master value
othersstring100NoOther details
homeAddressLine1string300YesPart of Correspondence Address
homeAddressLine2string300NoPart of Correspondence Address
homeAddressLine3string300NoPart of Correspondence Address
homePinCodestring6YesPincode entered during client creation
homeAreastring10Home area
homeContactMobileNostring10YesHome contact number
homeContactMobileNo2string10NoHome alternate contact number
homeSTDLandlineNostring20NoHome Landline number
homeSTDLandlineNo2string20NoHome alternate landline number
homeFaxNostring20NoHome fax number
sameAsHomeAddressstring1YesReference master value 1 - mailing details same as home details, 0 - to be filled manually
mailingAddressLine1string300Mailing address line 1
mailingAddressLine2string300Mailing address line 2
mailingAddressLine3string300Mailing address line 3
mailingPinCodestring6Auto derived code in all the places.
mailingAreastring100Mailing Area
mailingContactMobileNostring10Mailing contact number
mailingContactMobileNo2string10Mailing alternate contact number
mailingSTDLandlineNostring20Mailing landline number
mailingSTDLandlineNo2string20Mailing alternate landlind number
mailingFaxNostring20Mailing fax number
bankAccountTypestring20YesType of Bank Account. Reference master value
bankNamestring50YesBank Name
bankAccountNostring20YesBank account number
ifscCodestring20YesIFSC. Free Text
GSTINstringMandatory If GSTRegistrationStatus is "Compounding Dealer" or "Registered"
GSTRegistrationStatusstring20EnumMaster value - "Consumer" Register" "Compounding dealers"
UIDAcknowledgementNostring50NoUID Acknowledgent number
IsEIAavailablestring3No"Electronic insurance account" , Not in use in SP. Yes/No (Yes stands for EIA Account Available and 'No' Stands for EIA Account not available)
ApplyEIAstring3NoIndicator for Applying electronic account
EIAAccountNostring20Yes, if isEIAavailabe=YesEIA number
EIAWithstring50Yes, if isEIAavailabe=YesEI account with
AccountTypestring20Reference master value for account type like, 01 - current acc, 02 - saving acc
AddressProofstring100NoReference master value. Proof of address
DOBProofstring100NoReference master value. Proof of DOB
IdentityProofstring100NoReference master value. ID Proof
DCNnumberstring100Document 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
PolCreationResponsquoteNumberStringUnique identifier for the quote
customerIdStringCustomer's unique ID
Source_NameStringSource system or channel name
productNameStringName of the insurance product
productCodeStringCode representing the product
lineOfBusinessStringType of insurance business
quoteStatusStringStatus of the quote
quoteValidFromDateString (Date)Start date of quote validity
quoteValidToDateString (Date)End date of quote validity
policyNumberStringPolicy number
proposalNumberStringProposal number
policyStatusStringStatus of the policy
tenureStringDuration of the policy in years
stpflagStringStraight-through processing flag
MedicalTestInfoStringMedical test information
premiumDetailsArrayContains premium-related details
PremiumBasePremiumStringOriginal premium before discounts/loadings
NetPremiumStringPremium after discounts
ServiceTaxStringService tax amount
SBCStringSwachh Bharat Cess
KKCStringKrishi Kalyan Cess
BMI_loadingStringLoading based on BMI
GrossPremiumStringTotal premium before final adjustments
FinalPremiumStringFinal payable premium
ErrorObjecterrorCodeStringError code
errormessageStringError message
ReceiptCreationResponseerrorMessageStringMessage indicating success or failure
errorNumberStringError number
ReceiptNumberStringReceipt number generated
ReceiptAmountStringAmount received
ExcessAmountStringExcess 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
claimNumberstringYesEnter claim number

Sample Request Payload


{
  "claimNumber": "1122585004xxxx/03"
}
  

Response Payload

Field Name Data Type Description
ClaimNumberStringUnique identifier for the claim
Member_IDStringID of the insured member
Member_NameStringName of the insured member
Policy_NoStringPolicy number under which the claim is filed
Claim_SubStatusStringCurrent sub-status of the claim
Claim_TypeStringType of claim
Cover_TypeStringType of insurance cover
Opted_RoomString/nullRoom type opted during hospitalization
Claim_AmountStringTotal claimed amount
Deducted_AmountStringAmount deducted from the claim
Provider_DiscountStringDiscount provided by the healthcare provider
ReasonStringReason code or description
StatusStringClaim status
Compulsory_DeductionString/nullMandatory deduction amount
Co_paymentStringCo-payment amount
Copay_reasonString/nullReason for co-payment
SumInsured_Exhausted_AmountString/nullAmount exhausted from sum insured
Approved_Amount_INRStringApproved amount in INR
Intial_ApprovalStringInitial approval status
Interim_Approval_AmountString/nullInterim approved amount
Final_Approved_AmountStringFinal approved amount
Approval_RemarkStringRemarks related to approval
Deficiency_Raise_ToString/nullEntity to whom deficiency was raised
Raise_DateString/nullDate when deficiency was raised
Document_Received_DateString/nullDate when documents were received
Close_DateString/nullClaim closure date
Claim_StatusStringFinal status of the claim
Deduction_ReasonStringReason for deductions
Discount_ReasonStringReason for discount
Discount_AmountStringAmount discounted
AmountToBePaidByInsuredStringFinal amount payable by the insured
CKYC_FlagStringCKYC verification flag
CKYC_NumberStringCKYC reference number
BankNameStringName of the insured’s bank
AccountNumberStringBank account number
BankBranchStringBranch of the bank
IFSCCodeStringIFSC code of the bank branch
documentArrayList 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
PreAuthObjListY
Policy_NumberStringYPolicy Number, text
FamilyIdStringYUnique Member code/Party code
Claim_Intimation_ThroughStringYSource (e.g., CRM)
Claim_Intimation_SourceStringYSource (e.g., CRM)
Intimation_TypeStringYClaim type: Cashless or Reimbursement
Cover_codeStringYAdmission type code (DayCare/Inpatient)
Cover_NameStringYAdmission type description
Hospital_NameStringYHospital name
Hospital_CodeStringYHospital code
DiagnosisStringYDiagnosis description
Date_of_AdmissionStringYActual date of admission
Time_of_AdmissionStringYActual time of admission
Date_of_DischargeStringYActual date of discharge
Time_of_DischargeStringYActual time of discharge
Claim_AmountStringYClaim amount
Source_System_CodeStringYSource system identifier
Document_Received_DateStringYDate when documents were received
Document_Received_TimeStringYTime when documents were received
Patient_NameStringYPatient name
Co_morbiditiesStringNCo-morbid conditions
Service_flagStringNService flag
Name_Of_Treating_DoctorStringNName of treating doctor
Doctor_Contact_NoStringNDoctor's contact number
Duration_Of_Present_AilmentStringNDuration of current ailment
Proposed_line_of_treatmentStringNProposed treatment plan
Investigation_MedicalManagementDetailsStringNInvestigation and medical management details
Name_Of_SurgeryStringNName of surgery
IRDA_Code_Of_surgeryStringNIRDA code for surgery
How_did_injury_occurStringNDetails of injury occurrence
Case_Of_accidentStringNAccident case indicator
IsItRTAStringNRoad traffic accident indicator
Date_Of_InhuryStringNDate of injury
ReportedtoPoliceStringNPolice report status
FirNoStringNFIR number
Injury_Disease_AlcohalconsumptionStringNAlcohol-related injury/disease
IsMaternityStringNMaternity case indicator
GStringNGravida count
PStringNParity count
LStringNLive births count
AStringNAbortions count
Date_Of_DeliveryStringNDate of delivery
Emergency_Planned_EventStringNEmergency or planned event
Room_TypeStringNType of hospital room
DeaseasWithPresentingComplaintsStringNDisease with presenting complaints
ReleventClinicalFindingStringNRelevant clinical findings
DateOfFirstConsultationStringNDate of first consultation
ProvisionalDiagnosisStringNProvisional diagnosis
Doctor_Registration_NoStringNDoctor registration number
IsPreexistingStringNPre-existing condition indicator
IsNaturalCalamityCaseStringNNatural calamity case indicator
Test_ConductedToEstablishThisStringNTests conducted to establish condition
AlcohalordrugAbuseStringNAlcohol or drug abuse indicator
AnyHivorStdRelatedAilmentsStringNHIV/STD-related ailments
AnyOtherAilmentsStringNOther ailments
Other_IndStringNOther indicators
Hospital_NmStringNHospital name
Hospital_AddressStringNHospital address
Hospital_CountryStringNHospital country
Hospital_StateStringNHospital state
Hospital_DistrictStringNHospital district
Hospital_CityStringNHospital city
Hospital_PinCodeStringNHospital postal code
Hospital_MailStringNHospital email
Hospital_StdCodeStringNHospital STD code
Hospital_PhoneNoStringNHospital phone number
Hospital_MobileNoStringNHospital mobile number
Hospital_FaxNoStringNHospital fax number
Hospital_WebSiteStringNHospital website
Hospital_LandMarkStringNHospital landmark
PreexistingObjListNPre-existing conditions object
Preexisting_DeasesStringNPre-existing diseases
StatusStringNStatus of pre-existing condition
SincewhenStringNDuration of condition
RemarksStringNAdditional remarks
PCSObjListNProcedure codes object
PCS_CodeStringNProcedure code
ICD_CodeStringNDiagnosis code
DocObjListNDocument object
UploadStatusStringNUpload status
FilenameStringNDocument 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
CodeStringYResponse status code
MessageStringYResponse message
Claim_NumberStringYGenerated claim number
Pre_Auth_IdStringYPre-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_NumberstringMandatoryInsurance policy identifier
Claim_NostringMandatoryUnique claim number
MemberIdstringMandatoryMember identification number
Claim_Intimation_ThroughstringMandatoryMode of claim intimation (e.g., Online)
Claim_Intimation_SourcestringMandatorySource system or channel of claim
Claim_TypestringMandatoryType of claim (e.g., Reimbursement)
Process_TypestringNon-MandatoryType of processing (if applicable)
Claim_flagstringNon-MandatoryInternal flag for claim status
Hospital_NamestringMandatoryName of the hospital where treatment occurred
NOLstringNon-MandatoryPossibly No Objection Letter or similar
RemarkstringMandatoryAdditional remarks or comments
Date_of_AdmissionstringMandatoryAdmission date of the patient
Time_of_AdmissionstringMandatoryTime of admission
Date_of_DischargestringMandatoryDischarge date of the patient
Time_of_DischargestringMandatoryTime of discharge
Claim_AmountstringMandatoryTotal claim amount
Source_System_CodestringMandatoryCode representing the source system
DocumentuploadFlagstringMandatoryIndicates if documents were uploaded
Document_Received_DatestringMandatoryDate when documents were received
Document_Received_TimestringMandatoryTime when documents were received
Patient_NamestringMandatoryFull 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_NumberstringUnique identifier for the insurance claim
IsSucessstringIndicates whether the claim submission was successful
Error_MsgstringMessage returned from the system (e.g., Success or error details)
Error_CodestringCode 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_AmountstringAmount approved for the claim
Approved_DatestringDate when the claim was approved
ClaimTypestringType of claim (e.g., Cashless)
Claim_AmountstringTotal amount claimed
Claim_NumberstringUnique identifier for the claim
Claiment_NamestringName of the person claiming
Client_CodestringCode representing the client
Client_NamestringName of the client
Date_Of_AdmissionstringDate of hospital admission
Date_Of_DischargestringDate of hospital discharge
DiagnosisstringDiagnosis details
DocNamestringList of required documents for claim processing
Document_FlagstringFlag indicating document status
HospitalstringName of the hospital
Hospital_AddressstringAddress of the hospital
Hospital_CitystringCity where the hospital is located
Hospital_NamestringName of the hospital
Intermediary_CodestringCode of the intermediary involved
Intimation_DatestringDate when claim was intimated
Patient_NamestringName of the patient
Policy_End_DatestringEnd date of the insurance policy
Policy_Start_DatestringStart date of the insurance policy
Policy_TypestringType of insurance policy
ProductstringInsurance product name
Recommend_DatestringDate of recommendation
SchemestringInsurance scheme name
StatusstringCurrent status of the claim
SubStatusstringSub-status of the claim
followUpDatestringDate for follow-up
healthIdstringHealth ID of the patient
isChildClaimstringIndicates if the claim is for a child
mnyDeductionstringAmount deducted from the claim
paidAmountstringAmount paid out for the claim
proceduresstringMedical procedures performed
requirementsArrsstringArray of additional requirements
totalSIUtilisedstringTotal sum insured utilized
treatmentTypestringType of treatment received
vchPolicyNumberstringVoucher policy number
vchPrioritystringPriority level of the voucher
vchRemarksstringRemarks 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 NameData Type Description
PolicyDetailPolicyNumberstringUnique identifier for the insurance policy
PolicyExpiryDatestringDate when the policy expires
PolicyStatusstringCurrent status of the policy
PlanstringName of the insurance plan
MasterPolicyNumberstringMaster policy reference number
ProductstringInsurance product name
proposer_pan_numberstringPAN number of the proposer
FamilyDefinitionstringType of family coverage
UWDependentEntitlementstringUnderwriting dependent entitlement
ApplicationDatestringDate of application submission
ValidFromstringPolicy start date
ValidTostringPolicy end date
TenurestringDuration of the policy
BusinessTypestringType of business
Parent_Policy_NumberstringReference to parent policy
Medical_TypestringType of medical coverage
Quote_TypestringQuote classification
Sub_Quote_TypestringSub classification of quote
HAN_NumberstringHealth Account Number
OPD_reference_numberstringReference number for OPD claims
policy_start_datestringStart date of the policy
CKYC_NumberstringCentral KYC number
CKYC_FlagstringCentral KYC verification flag
AML_FlagstringAnti-Money Laundering flag
If_FaceMatchstringFace match verification status
Digi_Locker_VerifiedstringDigiLocker verification status
Kyc_Transition_idstringKYC transition identifier
Politically_Exposed_PersonstringPEP flag
ApplicationNostringApplication number
Post_issuance_datestringDate of post issuance
Post_issuance_timestringTime of post issuance
NumberofAdultsstringNumber of adults covered
NumberofChildrenstringNumber of children covered
PolicyOwnerNamestringFull name of the policy owner
PolicyOwnerFirstNamestringFirst name of the policy owner
PolicyOwnerMiddleNamestringMiddle name of the policy owner
PolicyOwnerLastNamestringLast name of the policy owner
CustomerCodestringUnique customer identifier
DateOfBirthstringDate of birth of the policyholder
ProposarAgestringAge of the proposer
Gender1stringGender of the proposer
MaritalStatusstringMarital status of the proposer
NationalitystringNationality of the proposer
MobilestringMobile number
EmailstringEmail address
vchNomineestringNominee code
RelationshipstringRelationship with nominee
NomineeNamestringName of the nominee
Nominee_DOBstringDate of birth of the nominee
Nominee_GenderstringGender of the nominee
NomineeAddressstringAddress of the nominee
NomineeContactNumberstringContact number of the nominee
AccountNumberstringBank account number
ConfirmAccountNumberstringConfirmation of bank account number
IFSCCodestringBank IFSC code
BankNamestringName of the bank
BankBranchNamestringBranch name of the bank
MICRCodestringMICR code of the bank
AccountTypestringType of bank account
BankPrioritystringPriority of the bank account
Policy_ExpiredstringIndicates if the policy is expired
InsuredDetailMemberIdstringUnique member identifier
FullNamestringFull name of the insured member
vchRelationstringRelationship to the proposer
DateOfBirthstringDate of birth of the member
GenderstringGender of the member
Cover_DetailsCover_CodestringCode for the coverage benefit
Cover_DiscriptionstringDescription of the coverage
SumInsuredstringSum insured for the coverage
Mandatory_or_OptionalstringIndicates 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
PreAuthObjPolicy_NumberstringMandatoryPolicy Number
FamilyIdstringMandatoryFamily ID
Claim_Intimation_ThroughstringMandatoryMode of claim intimation
Claim_Intimation_SourcestringMandatorySource of claim intimation
Intimation_TypestringMandatoryType of claim (e.g., Reimbursement)
Cover_codestringMandatoryCoverage code
Cover_NamestringMandatoryName of the coverage
Hospital_NamestringNon-MandatoryName of the hospital
Hospital_CodestringMandatoryHospital identifier code
DiagnosisstringMandatoryDiagnosis description
Date_of_AdmissionstringMandatoryDate of admission
Time_of_AdmissionstringMandatoryTime of admission
Date_of_DischargestringMandatoryDate of discharge
Time_of_DischargestringMandatoryTime of discharge
Claim_AmountstringMandatoryClaimed amount
Source_System_CodestringMandatorySystem source code
Document_Received_DatestringMandatoryDate when documents were received
Document_Received_TimestringMandatoryTime when documents were received
Patient_NamestringNon-MandatoryName of the patient
Bank_NamestringMandatoryName of the bank
Bank_Branch_NamestringMandatoryBranch name of the bank
Account_NostringMandatoryBank account number
IFSC_CodestringMandatoryIFSC code of the bank
ParentClaimNumberstringMandatoryReference to parent claim
PreexistingObjPreexisting_DeasesstringNon-MandatoryPre-existing disease name
StatusstringNon-MandatoryStatus of the disease
SincewhenstringNon-MandatoryDuration since disease exists
RemarksstringNon-MandatoryAdditional remarks
PCSObjPCS_CodestringNon-MandatoryProcedure code
ICDObjICD_CodestringNon-MandatoryICD diagnosis code
DocObjUploadStatusstringMandatoryStatus of document upload
FilenamestringNon-MandatoryName 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
RootendorsementReasonStringYesReason for the endorsement
eventEffectiveDateString (Date)NoEffective date of the endorsement
roleCodeStringYesRole of the user initiating the request
typeofEndorsementStringYesType of endorsement
endorsementAttributeArray of ObjectsNoAdditional endorsement attributes
endorsementAttribute[]nameStringYesName of the attribute
valueStringNoValue of the attribute
createProposalRequestflagStringYesOperation flag (e.g., 'E' for endorsement)
productCodeStringNoProduct code of the insurance policy
policyBranchStringNoBranch code of the policy
policyTermUnitStringNoUnit of policy term
policyInceptionDateString (Date)NoStart date of the policy
policyStatusStringNoCurrent status of the policy
premiumDepositModeStringNoMode of premium deposit
premiumFrequencyStringNoFrequency of premium payment
proposalNumberStringNoProposal number
policyNumberStringYesUnique identifier of the policy
alternateemailStringNoAlternate email of the policyholder
alternatemobilenumberStringNoAlternate mobile number
policyExpiryDateString (Date)NoExpiry date of the policy
policyTermStringNoDuration of the policy
baseCurrencyRateDecimal/StringNoExchange rate for base currency
baseCurrencyStringNoBase currency
premiumCurrencyRateDecimal/StringNoExchange rate for premium currency
premiumCurrencyStringNoPremium currency
entityTypeStringNoType of entity (individual/organization)
basicdetailAttributeArrayNoAdditional basic details
paymentInfoArrayNoPayment-related information
membersArray of ObjectsNoList of insured members
members[]benefitsArrayNoBenefits applicable to the member
discountDecimal/StringNoDiscount applied
expiryDateString (Date)NoMember coverage expiry date
grosspremiumDecimal/StringNoGross premium amount
inceptionDateString (Date)NoMember coverage start date
loadingDecimal/StringNoLoading applied to premium
medicalDetailsArrayNoMedical details
medicalDigitizationArrayNoDigitized medical records
memberDetailsArray of ObjectsNoAdditional member attributes
netpremiumDecimal/StringNoNet premium amount
partyObjectYes (partial)Party details of the member
questionnaireArrayNoQuestionnaire responses
requirementArrayNoRequirements for the member
memberDetails[]nameStringYesName of the attribute
valueStringYesValue of the attribute
multisetAttributeArrayNoAdditional attributes
partypartyCodeStringYesUnique identifier for the party
firstNameStringNoFirst name
lastNameStringNoLast name
middleNameStringNoMiddle name
initialStringNoInitials
otherNameStringNoOther name
dateofBirthString (Date)NoDate of birth
sexStringNoGender
nationalityStringNoNationality
occupationStringNoOccupation
contactDetailsArrayNoContact information
partyDetailsArrayNoAdditional party details
businessNameStringNoBusiness name
companyStringNoCompany name
citizenshipIdStringNoCitizenship ID
parentPartyCodeStringNoParent party code
indvOrOrgStringNoIndividual or Organization
effectiveDateString (Date)NoEffective date
createProposalRequestdocumentsArrayNoDocument list
requirementsArrayNoRequirement list
policyPaymentCycleDetailsArrayNoPolicy payment cycle details
notesArrayNoNotes
collectionDetailArrayNoCollection details
endorsementDetailsArrayNoEndorsement 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
RootclonePolicyNumberStringPolicy number being cloned for endorsement
isFinancialEndorsementString (Enum: Y/N)Indicates if the endorsement has financial implications
memberPremiumDetails[]memberCodeStringUnique code identifying the member
memberNameStringFull name of the member
grosspremiumDecimalGross premium amount before taxes and discounts
netpremiumDecimalNet premium amount after adjustments
taxAmountDecimalTax amount applicable to the member
premiumDetailsBeforeEndorsement.premiumDetails[]nameStringName of the premium component before endorsement
valueDecimal/StringValue of the premium component before endorsement
premiumDetailsAfterEndorsement.premiumDetails[]nameStringName of the premium component after endorsement
valueDecimal/String or NullValue of the premium component after endorsement
responseresponseCodeStringResponse code indicating success or failure
responseMessageStringMessage describing the result of the endorsement
messagesNull or ArrayAdditional 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"
  }
}