SignCare

Deposit Insights

5 endpoints · WealthSync API

POST

/pfm/api/v2/deposit/user-linked-accounts

#

Get user linked accounts for deposit.

docs.signcare.io/wealthsync/api/deposit-insights/#post-pfm-api-v2-deposit-user-linked-accounts

This API returns all linked Bank Savings/Current (Deposit) accounts for a user, grouped by FIP. Each linked account includes account type, masked number, holder info, balance, IFSC, branch, and consent 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.

→ filterZeroValueAccounts (optional): Set to "true" to exclude accounts with zero balance. Default: "false".

→ filterZeroValueHoldings (optional): Set to "true" to exclude holdings with zero value. Default: "false".

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
  • filterZeroValueAccounts
    stringoptional
    Optional. Send "true" to exclude accounts with zero current value. String "true" or "false". Default: "false".
    nullabledefault false
  • filterZeroValueHoldings
    stringoptional
    Optional. Send "true" to exclude holdings with zero current value. String "true" or "false". Default: "false".
    nullabledefault false
Sample request body
{ "uniqueIdentifier": "user-12345", "filterZeroValueAccounts": "false", "filterZeroValueHoldings": "false" }

Responses

200OK
  • totalFiData
    integer (int32)optional
    No description.
    nullable
  • totalFiDataToBeFetched
    integer (int32)optional
    No description.
    nullable
  • fipData
    array<object>optional
    No description.
    nullable
    Each item: 6 fields
    • fipId
      stringoptional
      No description.
      nullable
    • fipName
      stringoptional
      No description.
      nullable
    • totalFiData
      integer (int32)optional
      No description.
      nullable
    • totalFiDataToBeFetched
      integer (int32)optional
      No description.
      nullable
    • linkedAccounts
      array<object>optional
      No description.
      nullable
      Each item: 34 fields
      • fiDataId
        stringoptional
        No description.
        nullable
      • accountRefNumber
        stringoptional
        No description.
        nullable
      • dataFetched
        stringoptional
        No description.
        nullable
      • lastFetchDateTime
        string (date-time)optional
        No description.
        nullable
      • fiRequestCountOfCurrentMonth
        integer (int32)optional
        No description.
        nullable
      • fipId
        stringoptional
        No description.
        nullable
      • fipName
        stringoptional
        No description.
        nullable
      • latestConsentPurposeText
        stringoptional
        No description.
        nullable
      • latestConsentExpiryTime
        string (date-time)optional
        No description.
        nullable
      • consentPurposeVersion
        stringoptional
        No description.
        nullable
      • accountName
        stringoptional
        No description.
        nullable
      • accountType
        stringoptional
        No description.
        nullable
      • maskedAccNumber
        stringoptional
        No description.
        nullable
      • holderName
        stringoptional
        No description.
        nullable
      • holderDob
        stringoptional
        No description.
        nullable
      • holderMobile
        stringoptional
        No description.
        nullable
      • holderNominee
        stringoptional
        No description.
        nullable
      • holderLandline
        stringoptional
        No description.
        nullable
      • holderAddress
        stringoptional
        No description.
        nullable
      • holderEmail
        stringoptional
        No description.
        nullable
      • holderPan
        stringoptional
        No description.
        nullable
      • holderCkycCompliance
        stringoptional
        No description.
        nullable
      • holderType
        stringoptional
        No description.
        nullable
      • accountCurrentBalance
        number (double)optional
        No description.
        nullable
      • accountCurrency
        stringoptional
        No description.
        nullable
      • accountExchgeRate
        number (double)optional
        No description.
        nullable
      • accountBranch
        stringoptional
        No description.
        nullable
      • accountFacility
        stringoptional
        No description.
        nullable
      • accountIfscCode
        stringoptional
        No description.
        nullable
      • accountMicrCode
        integer (int64)optional
        No description.
        nullable
      • accountOpeningDate
        stringoptional
        No description.
        nullable
      • accountCurrentODLimit
        number (double)optional
        No description.
        nullable
      • accountDrawingLimit
        number (double)optional
        No description.
        nullable
      • accountStatus
        stringoptional
        No description.
        nullable
    • currentBalance
      number (double)optional
      No description.
      nullable
  • currentBalance
    number (double)optional
    No description.
    nullable
Example
{ "totalFiData": 0, "totalFiDataToBeFetched": 0, "fipData": [ { "fipId": "string", "fipName": "string", "totalFiData": 0, "totalFiDataToBeFetched": 0, "linkedAccounts": [ { "fiDataId": "string", "accountRefNumber": "string", "dataFetched": "string", "lastFetchDateTime": "2026-01-01T00:00:00Z", "fiRequestCountOfCurrentMonth": 0, "fipId": "string", "fipName": "string", "latestConsentPurposeText": "string", "latestConsentExpiryTime": "2026-01-01T00:00:00Z", "consentPurposeVersion": "string", "accountName": "string", "accountType": "string", "maskedAccNumber": "string", "holderName": "string", "holderDob": "string", "holderMobile": "string", "holderNominee": "string", "holderLandline": "string", "holderAddress": "string", "holderEmail": "string", "holderPan": "string", "holderCkycCompliance": "string", "holderType": "string", "accountCurrentBalance": 0, "accountCurrency": "string", "accountExchgeRate": 0, "accountBranch": "string", "accountFacility": "string", "accountIfscCode": "string", "accountMicrCode": 0, "accountOpeningDate": "string", "accountCurrentODLimit": 0, "accountDrawingLimit": 0, "accountStatus": "string" } ], "currentBalance": 0 } ], "currentBalance": 0 }
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/deposit/user-linked-accounts' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345", "filterZeroValueAccounts": "false", "filterZeroValueHoldings": "false" }'
POST

/pfm/api/v2/deposit/user-details

#

Get user details for deposit.

docs.signcare.io/wealthsync/api/deposit-insights/#post-pfm-api-v2-deposit-user-details

This API retrieves the user's subscription status along with a summary of all Deposit FI data. It shows subscription start/end dates, total bank balance, and a per-FIP account breakdown.

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
  • subscriptionStatus
    stringoptional
    No description.
    nullable
  • subscriptionStartDate
    string (date-time)optional
    No description.
    nullable
  • subscriptionEndDate
    string (date-time)optional
    No description.
    nullable
  • fiDatas
    anyoptional
    No description.
    nullable
Example
{ "subscriptionStatus": "string", "subscriptionStartDate": "2026-01-01T00:00:00Z", "subscriptionEndDate": "2026-01-01T00:00:00Z", "fiDatas": null }
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/deposit/user-details' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345" }'
POST

/pfm/api/v2/deposit/user-account-statement-download

#

Download account statement as binary (PDF/CSV) for deposit.

docs.signcare.io/wealthsync/api/deposit-insights/#post-pfm-api-v2-deposit-user-account-statement-download

This API downloads the bank deposit account statement as a binary file (PDF/CSV). Use this for exporting or sharing the transaction history of a specific bank account.

Prerequisites:

→ First call POST deposit/user-linked-accounts to get the list of linked deposit 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-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
  • accountId
    stringrequired
    Required. The fiDataId of the deposit account to fetch the statement for (from deposit/user-linked-accounts).
    nullabledefault YOUR_FI_DATA_ID
  • txnOrder
    stringoptional
    Optional. Transaction order: ASC (oldest first, default) or DESC (newest first). Upper case.
    nullabledefault ASC
  • dateRangeFrom
    stringoptional
    Optional. Start date to filter transactions, in yyyy-MM-dd format (for example 2025-01-01).
    nullabledefault 2025-01-01
  • dateRangeTo
    stringoptional
    Optional. End date to filter transactions, in yyyy-MM-dd format (for example 2025-12-31).
    nullabledefault 2025-12-31
Sample request body
{ "uniqueIdentifier": "user-12345", "accountId": "YOUR_FI_DATA_ID", "txnOrder": "ASC", "dateRangeFrom": "2025-01-01", "dateRangeTo": "2025-12-31" }

Responses

200OK
Example
0
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/deposit/user-account-statement-download' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345", "accountId": "YOUR_FI_DATA_ID", "txnOrder": "ASC", "dateRangeFrom": "2025-01-01", "dateRangeTo": "2025-12-31" }'
POST

/pfm/api/v2/deposit/user-account-statement

#

Get account statement for deposit.

docs.signcare.io/wealthsync/api/deposit-insights/#post-pfm-api-v2-deposit-user-account-statement

This API returns the transaction history for a specific bank deposit (savings/current) account. Each transaction includes txnId, amount, narration, type (DEBIT/CREDIT), mode, balance, and datetime.

Prerequisites:

→ First call POST deposit/user-linked-accounts to get the list of linked deposit 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-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
  • accountId
    stringrequired
    Required. The fiDataId of the deposit account to fetch the statement for (from deposit/user-linked-accounts).
    nullabledefault YOUR_FI_DATA_ID
  • txnOrder
    stringoptional
    Optional. Transaction order: ASC (oldest first, default) or DESC (newest first). Upper case.
    nullabledefault ASC
  • dateRangeFrom
    stringoptional
    Optional. Start date to filter transactions, in yyyy-MM-dd format (for example 2025-01-01).
    nullabledefault 2025-01-01
  • dateRangeTo
    stringoptional
    Optional. End date to filter transactions, in yyyy-MM-dd format (for example 2025-12-31).
    nullabledefault 2025-12-31
Sample request body
{ "uniqueIdentifier": "user-12345", "accountId": "YOUR_FI_DATA_ID", "txnOrder": "ASC", "dateRangeFrom": "2025-01-01", "dateRangeTo": "2025-12-31" }

Responses

200OK
  • category
    stringoptional
    No description.
    nullable
  • subCategory
    stringoptional
    No description.
    nullable
  • txnMode
    stringoptional
    No description.
    nullable
  • accountId
    stringoptional
    No description.
    nullable
  • merchantName
    stringoptional
    No description.
    nullable
  • type
    stringoptional
    No description.
    nullable
  • transactionTimestamp
    string (date-time)optional
    No description.
    nullable
  • valueDate
    string (date-time)optional
    No description.
    nullable
  • txnId
    stringoptional
    No description.
    nullable
  • narration
    stringoptional
    No description.
    nullable
  • reference
    stringoptional
    No description.
    nullable
  • currentBalance
    number (double)optional
    No description.
    nullable
  • mode
    stringoptional
    No description.
    nullable
  • merchants
    array<object>optional
    No description.
    nullable
    Each item: 2 fields
    • merchantName
      stringoptional
      No description.
      nullable
    • category
      stringoptional
      No description.
      nullable
  • amount
    number (double)optional
    No description.
    nullable
Example
{ "category": "string", "subCategory": "string", "txnMode": "string", "accountId": "string", "merchantName": "string", "type": "string", "transactionTimestamp": "2026-01-01T00:00:00Z", "valueDate": "2026-01-01T00:00:00Z", "txnId": "string", "narration": "string", "reference": "string", "currentBalance": 0, "mode": "string", "merchants": [ { "merchantName": "string", "category": "string" } ], "amount": 0 }
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/deposit/user-account-statement' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345", "accountId": "YOUR_FI_DATA_ID", "txnOrder": "ASC", "dateRangeFrom": "2025-01-01", "dateRangeTo": "2025-12-31" }'
POST

/pfm/api/v2/deposit/insights

#

Get deposit insights (balance, incoming, outgoing).

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

This API returns analytical insights for bank deposit accounts including balance trends, incoming/outgoing cash flow analysis, and transaction categorization. You can filter by specific accounts and configure the analysis time range and frequency.

Prerequisites (only if you filter by account):

→ First call POST deposit/user-linked-accounts to get the list of linked deposit accounts.

→ From the response, pick the fiDataId of each desired account.

→ Pass those fiDataId values in the "accountIds" array 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.

→ accountIds (optional): Filter insights for specific account IDs (fiDataIds). Array of strings. When omitted or empty, all linked deposit accounts are included.

→ from (optional): Start date for analysis. Format: yyyy-MM-dd.

→ to (optional): End date for analysis. Format: yyyy-MM-dd. Defaults to the current date.

→ frequency (optional): The frequency of the insights data requested. Default: MONTHLY. Allowed (upper case): DAILY, WEEKLY, MONTHLY, QUARTERLY, LAST_THREE_MONTHS, YEARLY.

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
  • accountIds
    array<string>optional
    Optional. fiDataIds of the deposit accounts to include. When omitted or empty, all linked deposit accounts are included.
    nullable
  • from
    stringoptional
    Optional. Start date for the insights, in yyyy-MM-dd format (for example 2025-01-01).
    nullabledefault 2025-01-01
  • to
    stringoptional
    Optional. End date for the insights, in yyyy-MM-dd format (for example 2025-12-31). Defaults to the current date.
    nullabledefault 2025-12-31
  • frequency
    stringoptional
    Optional. Frequency of the insights. Default: MONTHLY. Allowed (upper case): DAILY, WEEKLY, MONTHLY, QUARTERLY, LAST_THREE_MONTHS, YEARLY.
    nullable
Sample request body
{ "uniqueIdentifier": "user-12345", "from": "2025-01-01", "to": "2025-12-31" }

Responses

200OK
  • depositInsights
    objectoptional
    No description.
    4 fields
    • accountIds
      array<string>optional
      No description.
      nullable
    • balance
      array<object>optional
      No description.
      nullable
      Each item: 10 fields
      • from
        stringoptional
        No description.
        nullable
      • to
        stringoptional
        No description.
        nullable
      • avg
        number (double)optional
        No description.
        nullable
      • min
        number (double)optional
        No description.
        nullable
      • max
        number (double)optional
        No description.
        nullable
      • startOfPeriod
        number (double)optional
        No description.
        nullable
      • endOfPeriod
        number (double)optional
        No description.
        nullable
      • valueChange
        number (double)optional
        No description.
        nullable
      • percentChange
        number (double)optional
        No description.
        nullable
      • hasFullPeriodData
        booleanoptional
        No description.
        nullable
    • outgoing
      array<object>optional
      No description.
      nullable
      Each item: 5 fields
      • from
        stringoptional
        No description.
        nullable
      • to
        stringoptional
        No description.
        nullable
      • total
        number (double)optional
        No description.
        nullable
      • modeSplit
        array<object>optional
        No description.
        nullable
        Each item: 7 fields
        • type
          stringoptional
          No description.
          nullable
        • value
          number (double)optional
          No description.
          nullable
        • txnCount
          integer (int64)optional
          No description.
          nullable
        • valueChange
          number (double)optional
          No description.
          nullable
        • percentChange
          number (double)optional
          No description.
          nullable
        • subCategorySplit
          array<object>optional
          No description.
          nullable
          Each item: 5 fields
          • type
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int64)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
        • merchantSplit
          array<object>optional
          No description.
          nullable
          Each item: 6 fields
          • merchantName
            stringoptional
            No description.
            nullable
          • category
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int32)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
      • categorySplit
        array<object>optional
        No description.
        nullable
        Each item: 7 fields
        • type
          stringoptional
          No description.
          nullable
        • value
          number (double)optional
          No description.
          nullable
        • txnCount
          integer (int64)optional
          No description.
          nullable
        • valueChange
          number (double)optional
          No description.
          nullable
        • percentChange
          number (double)optional
          No description.
          nullable
        • subCategorySplit
          array<object>optional
          No description.
          nullable
          Each item: 5 fields
          • type
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int64)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
        • merchantSplit
          array<object>optional
          No description.
          nullable
          Each item: 6 fields
          • merchantName
            stringoptional
            No description.
            nullable
          • category
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int32)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
    • incoming
      array<object>optional
      No description.
      nullable
      Each item: 5 fields
      • from
        stringoptional
        No description.
        nullable
      • to
        stringoptional
        No description.
        nullable
      • total
        number (double)optional
        No description.
        nullable
      • modeSplit
        array<object>optional
        No description.
        nullable
        Each item: 7 fields
        • type
          stringoptional
          No description.
          nullable
        • value
          number (double)optional
          No description.
          nullable
        • txnCount
          integer (int64)optional
          No description.
          nullable
        • valueChange
          number (double)optional
          No description.
          nullable
        • percentChange
          number (double)optional
          No description.
          nullable
        • subCategorySplit
          array<object>optional
          No description.
          nullable
          Each item: 5 fields
          • type
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int64)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
        • merchantSplit
          array<object>optional
          No description.
          nullable
          Each item: 6 fields
          • merchantName
            stringoptional
            No description.
            nullable
          • category
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int32)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
      • categorySplit
        array<object>optional
        No description.
        nullable
        Each item: 7 fields
        • type
          stringoptional
          No description.
          nullable
        • value
          number (double)optional
          No description.
          nullable
        • txnCount
          integer (int64)optional
          No description.
          nullable
        • valueChange
          number (double)optional
          No description.
          nullable
        • percentChange
          number (double)optional
          No description.
          nullable
        • subCategorySplit
          array<object>optional
          No description.
          nullable
          Each item: 5 fields
          • type
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int64)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
        • merchantSplit
          array<object>optional
          No description.
          nullable
          Each item: 6 fields
          • merchantName
            stringoptional
            No description.
            nullable
          • category
            stringoptional
            No description.
            nullable
          • value
            number (double)optional
            No description.
            nullable
          • txnCount
            integer (int32)optional
            No description.
            nullable
          • valueChange
            number (double)optional
            No description.
            nullable
          • percentChange
            number (double)optional
            No description.
            nullable
Example
{ "depositInsights": { "accountIds": [ "string" ], "balance": [ { "from": "string", "to": "string", "avg": 0, "min": 0, "max": 0, "startOfPeriod": 0, "endOfPeriod": 0, "valueChange": 0, "percentChange": 0, "hasFullPeriodData": false } ], "outgoing": [ { "from": "string", "to": "string", "total": 0, "modeSplit": [ { "type": "string", "value": 0, "txnCount": 0, "valueChange": 0, "percentChange": 0, "subCategorySplit": [], "merchantSplit": [] } ], "categorySplit": [ { "type": "string", "value": 0, "txnCount": 0, "valueChange": 0, "percentChange": 0, "subCategorySplit": [], "merchantSplit": [] } ] } ], "incoming": [ { "from": "string", "to": "string", "total": 0, "modeSplit": [ { "type": "string", "value": 0, "txnCount": 0, "valueChange": 0, "percentChange": 0, "subCategorySplit": [], "merchantSplit": [] } ], "categorySplit": [ { "type": "string", "value": 0, "txnCount": 0, "valueChange": 0, "percentChange": 0, "subCategorySplit": [], "merchantSplit": [] } ] } ] } }
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/deposit/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", "from": "2025-01-01", "to": "2025-12-31" }'