F&O

2 endpoints · WealthSync API

POST

/pfm/api/v2/fno/result

Get F&O eligibility result.

docs.signcare.io/wealthsync/api/f-o/#post-pfm-api-v2-fno-result

This API checks whether a user is eligible for F&O (Futures and Options) trading based on SEBI criteria. The response includes user details (age), account-wise eligibility (per FI type with evaluated values), user-wise eligibility, and overall eligibility with rules evaluated and their pass/fail 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

consentId
integer (int64)optional
No description.
nullable
userDetails
objectoptional
No description.
2 fields
- uniqueIdentifier
  integer (int64)optional
  No description.
  nullable
- age
  integer (int32)optional
  No description.
  nullable
evaluationDate
stringoptional
No description.
nullable
accountWiseEligibility
array<object>optional
No description.
nullable
Each item: 11 fields
- fiType
  stringoptional
  No description.
  nullable
- dataPresent
  booleanoptional
  No description.
  nullable
- evaluatedValues
  objectoptional
  No description.
  4 fields
  accountBalance
  number (double)optional
  No description.
  nullable
  currentHoldingValue
  number (double)optional
  No description.
  nullable
  accountOpeningDate
  stringoptional
  No description.
  nullable
  accountType
  stringoptional
  No description.
  nullable
- fipId
  integer (int64)optional
  No description.
  nullable
- fipName
  stringoptional
  No description.
  nullable
- accountNumber
  integer (int64)optional
  No description.
  nullable
- accountId
  integer (int64)optional
  No description.
  nullable
- folioNumber
  integer (int64)optional
  No description.
  nullable
- dematNumber
  integer (int64)optional
  No description.
  nullable
- rulesEvaluated
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  ruleName
  stringoptional
  No description.
  nullable
  ruleCondition
  stringoptional
  No description.
  nullable
  ruleStatus
  stringoptional
  No description.
  nullable
- isEligible
  booleanoptional
  No description.
  nullable
userWiseEligibility
objectoptional
No description.
3 fields
- fiTypeWiseUserEligibility
  array<object>optional
  No description.
  nullable
  Each item: 4 fields
  fiType
  stringoptional
  No description.
  nullable
  dataPresent
  booleanoptional
  No description.
  nullable
  evaluatedValues
  objectoptional
  No description.
  4 fields
  accountBalance
  number (double)optional
  No description.
  nullable
  currentHoldingValue
  number (double)optional
  No description.
  nullable
  accountOpeningDate
  stringoptional
  No description.
  nullable
  accountType
  stringoptional
  No description.
  nullable
  fiDataSources
  array<object>optional
  No description.
  nullable
  Each item: 7 fields
  dataSource
  stringoptional
  No description.
  nullable
  fipId
  integer (int64)optional
  No description.
  nullable
  fipName
  stringoptional
  No description.
  nullable
  accountNumber
  integer (int64)optional
  No description.
  nullable
  accountId
  integer (int64)optional
  No description.
  nullable
  folioNumber
  integer (int64)optional
  No description.
  nullable
  dematNumber
  integer (int64)optional
  No description.
  nullable
- rulesEvaluated
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  ruleName
  stringoptional
  No description.
  nullable
  ruleCondition
  stringoptional
  No description.
  nullable
  ruleStatus
  stringoptional
  No description.
  nullable
- isEligible
  booleanoptional
  No description.
  nullable
overallEligibility
objectoptional
No description.
2 fields
- eligibilityCriteria
  array<object>optional
  No description.
  nullable
  Each item: 3 fields
  ruleName
  stringoptional
  No description.
  nullable
  ruleCondition
  stringoptional
  No description.
  nullable
  ruleStatus
  stringoptional
  No description.
  nullable
- eligible
  booleanoptional
  No description.
  nullable

Example

{ "consentId": 0, "userDetails": { "uniqueIdentifier": 0, "age": 0 }, "evaluationDate": "string", "accountWiseEligibility": [ { "fiType": "string", "dataPresent": false, "evaluatedValues": { "accountBalance": 0, "currentHoldingValue": 0, "accountOpeningDate": "string", "accountType": "string" }, "fipId": 0, "fipName": "string", "accountNumber": 0, "accountId": 0, "folioNumber": 0, "dematNumber": 0, "rulesEvaluated": [ { "ruleName": "string", "ruleCondition": "string", "ruleStatus": "string" } ], "isEligible": false } ], "userWiseEligibility": { "fiTypeWiseUserEligibility": [ { "fiType": "string", "dataPresent": false, "evaluatedValues": { "accountBalance": 0, "currentHoldingValue": 0, "accountOpeningDate": "string", "accountType": "string" }, "fiDataSources": [ { "dataSource": "string", "fipId": 0, "fipName": "string", "accountNumber": 0, "accountId": 0, "folioNumber": 0, "dematNumber": 0 } ] } ], "rulesEvaluated": [ { "ruleName": "string", "ruleCondition": "string", "ruleStatus": "string" } ], "isEligible": false }, "overallEligibility": { "eligibilityCriteria": [ { "ruleName": "string", "ruleCondition": "string", "ruleStatus": "string" } ], "eligible": 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/fno/result' \ -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/fno/data

Get raw data as received via AA for F&O (one-time) consents.

docs.signcare.io/wealthsync/api/f-o/#post-pfm-api-v2-fno-data

This API returns the raw, unanalyzed financial data as received from the AA, specifically for F&O one-time consents. Use this when you need the original data used for F&O eligibility evaluation.

Request Body Parameters:

→ consentId (required): Consent Id of a FnO request.

→ accountId (required): Account Id within that consent Id.

To get the accountId, call the /pfm/api/v2/fno/result API:

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
consentId
stringrequired
Required. Consent ID of the F&O request (the consentId returned by POST fno/result).
minLength 1default YOUR_CONSENT_ID
accountId
stringrequired
Required. ID of the account within that consent.
minLength 1default YOUR_FI_DATA_ID

Sample request body

{ "uniqueIdentifier": "user-12345", "consentId": "YOUR_CONSENT_ID", "accountId": "YOUR_FI_DATA_ID" }

Responses

200OK

Example

{}

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/fno/data' \ -H 'X-API-KEY: YOUR_API_KEY' \ -H 'X-API-APP-ID: YOUR_APP_ID' \ -H 'Content-Type: application/json' \ -d '{ "uniqueIdentifier": "user-12345", "consentId": "YOUR_CONSENT_ID", "accountId": "YOUR_FI_DATA_ID" }'