Net Worth

1 endpoint · WealthSync API

POST

/pfm/api/v2/net-worth/insights

#

Get net worth insights including assets and liabilities.

docs.signcare.io/wealthsync/api/net-worth/#post-pfm-api-v2-net-worth-insights

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-KEY
    stringrequired
    Your secret API key for the environment you are calling (Stage and Live use different keys).
  • X-API-APP-ID
    stringrequired
    The App ID issued together with the key.
  • Content-Type
    stringrequired
    application/json

Body parameters

application/json
  • uniqueIdentifier
    stringrequired
    Required. 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
{ "uniqueIdentifier": "user-12345" }

Responses

200OK
  • totalAssets
    number (double)optional
    No description.
  • totalLiabilities
    number (double)optional
    No description.
  • netWorthValue
    number (double)optional
    No description.
  • dailyChangePercentage
    number (double)optional
    No description.
  • financialAssets
    objectoptional
    No description.
    7 fields
    • mutualFunds
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • stocks
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • etfs
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • nps
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • termDeposit
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • recurringDeposit
      objectoptional
      No description.
      4 fields
      • currentValue
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
    • bankAccounts
      array<object>optional
      No description.
      nullable
      Each item: 6 fields
      • bankName
        stringoptional
        No description.
        nullable
      • accountNumber
        stringoptional
        No description.
        nullable
      • currentBalance
        number (double)optional
        No description.
      • oneDayChangePercentage
        number (double)optional
        No description.
      • oneDayChangeAmount
        number (double)optional
        No description.
      • percentOfTotalAssets
        number (double)optional
        No description.
  • liabilities
    array<object>optional
    No description.
    nullable
    Each item: 9 fields
    • lenderName
      stringoptional
      No description.
      nullable
    • accountNumber
      stringoptional
      No description.
      nullable
    • identificationNumber
      stringoptional
      No description.
      nullable
    • accountType
      stringoptional
      No description.
      nullable
    • currentOutstandingBalance
      number (double)optional
      No description.
    • sanctionedCreditLimit
      number (double)optional
      No description.
    • accountStatus
      stringoptional
      No description.
      nullable
    • percentOfTotalLiabilities
      number (double)optional
      No description.
    • closed
      booleanoptional
      No description.
Example
{ "totalAssets": 0, "totalLiabilities": 0, "netWorthValue": 0, "dailyChangePercentage": 0, "financialAssets": { "mutualFunds": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "stocks": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "etfs": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "nps": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "termDeposit": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "recurringDeposit": { "currentValue": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 }, "bankAccounts": [ { "bankName": "string", "accountNumber": "string", "currentBalance": 0, "oneDayChangePercentage": 0, "oneDayChangeAmount": 0, "percentOfTotalAssets": 0 } ] }, "liabilities": [ { "lenderName": "string", "accountNumber": "string", "identificationNumber": "string", "accountType": "string", "currentOutstandingBalance": 0, "sanctionedCreditLimit": 0, "accountStatus": "string", "percentOfTotalLiabilities": 0, "closed": false } ] }
400Bad Request
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 400
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 400 }
401Unauthorized
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 401
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 401 }
500Internal Server Error
  • data
    objectoptional
    No description.
  • messages
    array<string>optional
    No description.
    nullable
  • request_id
    stringoptional
    No description.
    nullable
  • success
    booleanoptional
    No description.
    default false
  • message
    stringoptional
    No description.
    nullabledefault XXXXX
  • isBillable
    booleanoptional
    No description.
  • statusCode
    integer (int32)optional
    No description.
    default 500
Example
{ "data": {}, "messages": [ "string" ], "request_id": "string", "success": false, "message": "XXXXX", "isBillable": false, "statusCode": 500 }
Code samplescurl · Node.js · Python
Stage: uat-ext.signcare.io
curl -X POST 'https://uat-ext.signcare.io/pfm/api/v2/net-worth/insights' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345" }'