Investors

List the classifications an investor holds

GET/investors/{id}/classifications
classifications:readread_investor_classificationsRead-only

Returns every classification the investor holds, each with id, label and whether the platform gave it from their answers (automatic) or someone assigned it by hand. An unknown investor returns 404. The add, replace and remove calls return the same set. Sends nothing.

Path parameters

  • idstring (uuid)Required#

    The investor's id, a uuid. An unknown investor, or one outside the token's organisation and its client organisations, returns 404.

Responses

200

Every classification the investor holds.

InvestorClassification[]
{
  "data": [
    {
      "id": 12,
      "label": "Professional Investor",
      "automatic": false
    },
    {
      "id": 14,
      "label": "High Net Worth Individual",
      "automatic": true
    }
  ]
}
401

Authentication failed. error.code is one of invalid_token, expired, revoked.

Error
403

Authorization failed. error.code is one of org_disabled, ip_blocked, missing_scope, scope_disabled, user_disabled.

Error
404

Resource not found (error.code = not_found).

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

curl https://your-org-domain/kong/core/api/v2/investors/{id}/classifications\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"