Net Worth
1 endpoint · WealthSync API
Get net worth insights including assets and liabilities.
This API returns a comprehensive net worth summary for the user. The response includes total assets, total liabilities, net worth value, and daily change percentage. Financial assets are broken down by: mutual funds, stocks, ETFs, NPS, term deposit, recurring deposit, and bank accounts — each with current value, one-day change, and percentage of total assets. Liabilities include lender name, account type, outstanding balance, sanctioned limit, and status.
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
- totalAssetsnumber (double)optionalNo description.
- totalLiabilitiesnumber (double)optionalNo description.
- netWorthValuenumber (double)optionalNo description.
- dailyChangePercentagenumber (double)optionalNo description.
- financialAssetsobjectoptionalNo description.
7 fields
- mutualFundsobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- stocksobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- etfsobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- npsobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- termDepositobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- recurringDepositobjectoptionalNo description.
4 fields
- currentValuenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- bankAccountsarray<object>optionalNo description.nullable
Each item: 6 fields
- bankNamestringoptionalNo description.nullable
- accountNumberstringoptionalNo description.nullable
- currentBalancenumber (double)optionalNo description.
- oneDayChangePercentagenumber (double)optionalNo description.
- oneDayChangeAmountnumber (double)optionalNo description.
- percentOfTotalAssetsnumber (double)optionalNo description.
- liabilitiesarray<object>optionalNo description.nullable
Each item: 9 fields
- lenderNamestringoptionalNo description.nullable
- accountNumberstringoptionalNo description.nullable
- identificationNumberstringoptionalNo description.nullable
- accountTypestringoptionalNo description.nullable
- currentOutstandingBalancenumber (double)optionalNo description.
- sanctionedCreditLimitnumber (double)optionalNo description.
- accountStatusstringoptionalNo description.nullable
- percentOfTotalLiabilitiesnumber (double)optionalNo description.
- closedbooleanoptionalNo description.
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