Insurance Insights
4 endpoints · WealthSync API
Get user linked accounts for life insurance.
This API returns all linked Life Insurance accounts for a user, grouped by FIP (insurance provider). Each linked account includes policy details (status, type, sum assured, premium amount/frequency), holder name, consent status, and current surrender/policy value.
Request Body Parameters:
→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- uniqueIdentifierstringrequiredRequired. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.minLength 1default user-12345
Sample request body
Responses
200OK
- totalFiDatainteger (int32)optionalNo description.nullable
- totalFiDataToBeFetchedinteger (int32)optionalNo description.nullable
- fipDataarray<object>optionalNo description.nullable
Each item: 6 fields
- fipIdstringoptionalNo description.nullable
- fipNamestringoptionalNo description.nullable
- totalFiDatainteger (int32)optionalNo description.nullable
- totalFiDataToBeFetchedinteger (int32)optionalNo description.nullable
- linkedAccountsarray<object>optionalNo description.nullable
Each item: 15 fields
- fiDataIdstringoptionalNo description.nullable
- accountRefNumberstringoptionalNo description.nullable
- dataFetchedstringoptionalNo description.nullable
- lastFetchDateTimestring (date-time)optionalNo description.nullable
- fiRequestCountOfCurrentMonthinteger (int32)optionalNo description.nullable
- fipIdstringoptionalNo description.nullable
- fipNamestringoptionalNo description.nullable
- latestConsentPurposeTextstringoptionalNo description.nullable
- latestConsentExpiryTimestring (date-time)optionalNo description.nullable
- consentPurposeVersionstringoptionalNo description.nullable
- accountTypestringoptionalNo description.nullable
- maskedAccNumberstringoptionalNo description.nullable
- holderNamestringoptionalNo description.nullable
- policyobjectoptionalNo description.
13 fields
- policyStatusstringoptionalNo description.nullable
- policyTypestringoptionalNo description.nullable
- sumAssurednumber (double)optionalNo description.nullable
- premiumAmountnumber (double)optionalNo description.nullable
- premiumFrequencystringoptionalNo description.nullable
- premiumPaymentYearsinteger (int32)optionalNo description.nullable
- tenureYearsinteger (int32)optionalNo description.nullable
- tenureMonthsinteger (int32)optionalNo description.nullable
- surrenderValuenumber (double)optionalNo description.nullable
- currentValuenumber (double)optionalNo description.nullable
- exclusionsstringoptionalNo description.nullable
- assignmentstringoptionalNo description.nullable
- policyLoanStatusstringoptionalNo description.nullable
- currentValuenumber (double)optionalNo description.nullable
- currentValuenumber (double)optionalNo description.nullable
- currentValuenumber (double)optionalNo description.nullable
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500
Code samplescurl · Node.js · Python
Get user account statement for life insurance.
This API returns the premium payment / transaction history for a specific life insurance policy. Each transaction includes txnId, amount, narration, type, and transaction datetime.
Prerequisites:
→ First call POST life-insurance/user-linked-accounts to get the list of linked life insurance accounts.
→ From the response, pick the fiDataId of the desired account.
→ Pass that fiDataId as the "accountId" parameter in this API.
Request Body Parameters:
→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.
→ accountId (required): The fiDataId of the specific account.
→ txnOrder (optional): Sort order for transactions — "ASC" (oldest first) or "DESC" (newest first).
→ dateRangeFrom (optional): Start date for filtering transactions. Format: yyyy-MM-dd.
→ dateRangeTo (optional): End date for filtering transactions. Format: yyyy-MM-dd.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- uniqueIdentifierstringrequiredRequired. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.minLength 1default user-12345
- accountIdstringrequiredRequired. The fiDataId of the linked account, taken from the linked-accounts response.minLength 1default YOUR_FI_DATA_ID
- dateRangeFromstringoptionalOptional. Start date to filter transactions, in yyyy-MM-dd format.nullabledefault 2024-01-01
- dateRangeTostringoptionalOptional. End date to filter transactions, in yyyy-MM-dd format.nullabledefault 2024-12-31
- txnOrderstringoptionalOptional. Transaction order: ASC (oldest first, default) or DESC (newest first). Upper case.nullable
Sample request body
Responses
200OK
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500
Code samplescurl · Node.js · Python
Get user linked accounts for general insurance.
This API returns all linked General Insurance (health, motor, property, travel) accounts for a user. Each linked account includes policy details (name, number, type, status, sum insured, premium), covers, insured vehicles (for motor), holder name, consent status, and total coverage value.
The response contains a fiDataId for each account — this is the accountId you need to pass to the general insurance account statement API.
Request Body Parameters:
→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- uniqueIdentifierstringrequiredRequired. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.minLength 1default user-12345
Sample request body
Responses
200OK
- totalFiDatainteger (int32)optionalNo description.nullable
- totalFiDataToBeFetchedinteger (int32)optionalNo description.nullable
- fipDataarray<object>optionalNo description.nullable
Each item: 6 fields
- fipIdstringoptionalNo description.nullable
- fipNamestringoptionalNo description.nullable
- totalFiDatainteger (int32)optionalNo description.nullable
- totalFiDataToBeFetchedinteger (int32)optionalNo description.nullable
- linkedAccountsarray<object>optionalNo description.nullable
Each item: 17 fields
- fiDataIdstringoptionalNo description.nullable
- accountRefNumberstringoptionalNo description.nullable
- dataFetchedstringoptionalNo description.nullable
- lastFetchDateTimestring (date-time)optionalNo description.nullable
- fiRequestCountOfCurrentMonthinteger (int32)optionalNo description.nullable
- fipIdstringoptionalNo description.nullable
- fipNamestringoptionalNo description.nullable
- latestConsentPurposeTextstringoptionalNo description.nullable
- latestConsentExpiryTimestring (date-time)optionalNo description.nullable
- consentPurposeVersionstringoptionalNo description.nullable
- accountTypestringoptionalNo description.nullable
- maskedPolicyNumberstringoptionalNo description.nullable
- holderNamestringoptionalNo description.nullable
- policyobjectoptionalNo description.
19 fields
- policyNamestringoptionalNo description.nullable
- policyNumberstringoptionalNo description.nullable
- uinNumberstringoptionalNo description.nullable
- policyDescriptionstringoptionalNo description.nullable
- insuranceTypestringoptionalNo description.nullable
- policyTypestringoptionalNo description.nullable
- policyStatusstringoptionalNo description.nullable
- sumInsurednumber (double)optionalNo description.nullable
- sumAssurednumber (double)optionalNo description.nullable
- premiumAmountnumber (double)optionalNo description.nullable
- premiumFrequencystringoptionalNo description.nullable
- premiumPaymentYearsinteger (int32)optionalNo description.nullable
- premiumPaymentMonthsinteger (int32)optionalNo description.nullable
- tenureDaysinteger (int32)optionalNo description.nullable
- tenureMonthsinteger (int32)optionalNo description.nullable
- tenureYearsinteger (int32)optionalNo description.nullable
- policyStartDatestring (date-time)optionalNo description.nullable
- policyExpiryDatestring (date-time)optionalNo description.nullable
- nextPremiumDueDatestring (date-time)optionalNo description.nullable
- coversarray<object>optionalNo description.nullable
Each item: 10 fields
- coverNamestringoptionalNo description.nullable
- coverDescriptionstringoptionalNo description.nullable
- uinNumberstringoptionalNo description.nullable
- sumInsurednumber (double)optionalNo description.nullable
- sumAssurednumber (double)optionalNo description.nullable
- premiumAmountnumber (double)optionalNo description.nullable
- tenureYearsinteger (int32)optionalNo description.nullable
- tenureMonthsinteger (int32)optionalNo description.nullable
- coverStartDatestring (date-time)optionalNo description.nullable
- coverEndDatestring (date-time)optionalNo description.nullable
- vehiclesarray<object>optionalNo description.nullable
Each item: 8 fields
- registrationNumberstringoptionalNo description.nullable
- makestringoptionalNo description.nullable
- modelstringoptionalNo description.nullable
- manufacturingYearinteger (int32)optionalNo description.nullable
- rtoLocationstringoptionalNo description.nullable
- ncbPercentagestringoptionalNo description.nullable
- hypothecationbooleanoptionalNo description.nullable
- financerNamestringoptionalNo description.nullable
- coverageValuenumber (double)optionalNo description.nullable
- totalCoveragenumber (double)optionalNo description.nullable
- totalCoveragenumber (double)optionalNo description.nullable
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500
Code samplescurl · Node.js · Python
Get general insurance transactions.
This API returns the premium payment / transaction history for a specific general insurance policy. Each transaction includes txnId, amount, narration, type, and transaction datetime.
Prerequisites:
→ First call POST general-insurance/user-linked-accounts to get the list of linked general insurance accounts.
→ From the response, pick the fiDataId of the desired account.
→ Pass that fiDataId as the "accountId" parameter in this API.
Request Body Parameters:
→ uniqueIdentifier (required): The primary identifier added at the time of subscription. It must be the exact same value used during the initial subscription and MUST never change for this user.
→ accountId (required): The fiDataId of the specific account.
→ txnOrder (optional): Sort order for transactions — "ASC" (oldest first) or "DESC" (newest first).
→ dateRangeFrom (optional): Start date for filtering transactions. Format: yyyy-MM-dd.
→ dateRangeTo (optional): End date for filtering transactions. Format: yyyy-MM-dd.
Headers
- X-API-KEYstringrequiredYour secret API key for the environment you are calling (Stage and Live use different keys).
- X-API-APP-IDstringrequiredThe App ID issued together with the key.
- Content-Typestringrequiredapplication/json
Body parameters
application/json- uniqueIdentifierstringrequiredRequired. Your identifier for the user, exactly as sent when the user was subscribed. Never changes for a user. Non-empty string.minLength 1default user-12345
- accountIdstringrequiredRequired. The fiDataId of the linked account, taken from the linked-accounts response.minLength 1default YOUR_FI_DATA_ID
- dateRangeFromstringoptionalOptional. Start date to filter transactions, in yyyy-MM-dd format.nullabledefault 2024-01-01
- dateRangeTostringoptionalOptional. End date to filter transactions, in yyyy-MM-dd format.nullabledefault 2024-12-31
- txnOrderstringoptionalOptional. Transaction order: ASC (oldest first, default) or DESC (newest first). Upper case.nullable
Sample request body
Responses
200OK
400Bad Request
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 400
401Unauthorized
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 401
500Internal Server Error
- dataobjectoptionalNo description.
- messagesarray<string>optionalNo description.nullable
- request_idstringoptionalNo description.nullable
- successbooleanoptionalNo description.default false
- messagestringoptionalNo description.nullabledefault XXXXX
- isBillablebooleanoptionalNo description.
- statusCodeinteger (int32)optionalNo description.default 500