Skip to content
Fund Trading

Validate Fund Order Risk

Checks whether the Client's risk assessment result meets the fund risk level. This is the first step of the fund order flow and does not create an order. The recommended order flow is:

  1. Make sure the trade token is valid.
  2. Call this endpoint and handle user_pi: continue on 2; on 0 or 3, guide the Client to open eval_address to complete or redo the risk assessment; on 1, show user_risk_level and fund_risk_level and explain the mismatch. Do not continue unless the value is 2.
  3. Call Get Fund Order Certification Checks and stop if any item has is_force set to true.
  4. After the Client confirms, call Submit Fund Order with the auth_token returned here.

Also used to check the risk level before creating or modifying a recurring investment plan.

When you call this endpoint through WhaleCore requestService(), set requiresTradeToken to true.

POSThttps://api.lbkrs.com/ut/order/validate

Parameters

x-target-aaidstringheader

The aaid of the target fund account. Broker App passes the fund account the Client currently selects

Request body application/json

counter_idstringrequired

Fund ID (counter_id)

actionstring

Trade direction:

  • BUY - Buy (subscription)
  • SELL - Sell (redemption)
Values
BUY
SELL
currencystring

Payment currency, from currency in the order page information

amountstring

Buy amount. For a sell, pass it only when selling by amount

unitsstring

Sell units. Pass an empty string for a buy

dividend_optionstring

Dividend option, from dividend[].value in the order page information

fund_sourcestring

Funding source. Pass 2 (cash)

account_channelstring

Account channel. Use the account_channel of the current account

Responses

HTTP 200The request succeeded. The response body contains the result of the “Validate fund order risk” operation.
Standard response envelopecodemessagedata
dataobjectdata structure
user_pistring

Risk assessment check result:

  • 0 - Risk assessment not submitted
  • 1 - Risk level mismatch
  • 2 - Passed
  • 3 - Risk assessment expired

It may be returned as a string; convert it to a number before comparing.

user_risk_levelinteger

Client risk tolerance level: 1 conservative, 2 moderately conservative, 3 balanced, 4 growth, 5 aggressive

fund_risk_levelinteger

Fund risk level: 1 low, 2 low to medium, 3 medium, 4 medium to high, 5 high

eval_addressstring

Risk assessment page URL. Open it for the Client when user_pi is not 2

msgstring

Prompt text. Prefer it for display in cases such as an expired risk assessment

auth_tokenstring

Validation credential required to submit the order. Pass it unchanged to Submit Fund Order

Whale Docs