Skip to content
Fund Trading

Get Fund Suitability Results

Returns the Client's suitability results by rule identifier, such as the completion status, risk tolerance level, and validity of the risk assessment (risk_assessment). When counter_id is passed, it also returns product information such as the fund risk level. This read-only endpoint does not modify assessment results. Handle status as follows: on Completed, you can open result_link; on Outstanding or Expired, guide the Client to form_link; on Pending, tell the Client the review is in progress. Used to recommend funds by risk level on the fund channel and to confirm the risk assessment is complete before enabling cash management.

POSThttps://api.lbkrs.com/ut/suitability/results

Request body application/json

keysarray<string>

Rule identifiers to query. The source uses risk_assessment (risk assessment)

counter_idstring

Fund ID (counter_id). Pass an empty string when not querying a specific fund

Responses

HTTP 200The request succeeded. The response body contains the result of the “Get fund suitability results” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
rulesarray<object>

Result of each rule

Child attributes
keystring

Rule identifier matching the request keys, such as risk_assessment

rule_namestring

Rule name

statusstring

Rule status:

  • Completed - Completed
  • Pending - Under review
  • Outstanding - Not completed
  • Expired - Expired
is_passedboolean

Whether the rule is passed

user_levelstring

The Client's current result level, such as the risk tolerance level from the risk assessment

descstring

Rule description

product_descstring

Description related to the queried fund

expired_atinteger

Time when the result expires, as a Unix timestamp in seconds

form_linkstring

URL of the form that completes the rule. Open it for the Client when the status is Outstanding or Expired

result_linkstring

URL of the result page. Open it when the status is Completed

productobject

Product information of the queried fund. May be empty when counter_id is not passed

Child attributes
counter_idstring

Fund ID (counter_id)

namestring

Fund name

isinstring

Fund ISIN

currencystring

Currency, such as USD or HKD

asset_classinteger

Asset class

risk_levelinteger

Fund risk level from 1 (low) to 5 (high)

risk_level_descstring

Display text of the fund risk level

Whale Docs