Endpoint Parameters

  • Request parameters

    Name Type Origin Description
    ClientKey ClientKey Route The client key uniquely identifying a client.
  • Response Parameters

    View Response Codes
    Name Type Description
    CanGiveSuitabilityTest Boolean Field will reflect whether user is allowed to give suitability test or not.
    EsgPriority EsgPriority ESG Priority to select e.g. Low, Medium, High
    EsgType EsgType ESG Type for investment e.g. Environmental,Science,Governance etc
    ForcedIgnoreESGPreference Boolean A boolean to indicate ignore ESG score
    LastSuitabilityCheckDate String Last Suitability Check Date And Time
    OverallSuitability SuitabilityLevel The overall suitablity score for the client.
    ProductAreaSuitability ProductArea [] The list of product areas for which the client has passed suitability test.
  • Request Example

    Request URL
    GET /at/v3/tradeFollowers/{ClientKey}/suitabilitystatus
  • Response Example

    Response body
      "CanGiveSuitabilityTest": true,
      "LastSuitabilityCheckDate": "2013-01-01T00:00:00Z",
      "OverallSuitability": "Medium",
      "ProductAreaSuitability": [