Investors

List an investor's appropriateness tests

GET/investors/{investor_id}/appropriateness-tests
onboarding:readlist_investor_appropriateness_testsRead-only

Lists one investor's appropriateness-test attempts, newest first. An attempt starts not_taken when the test is shown and becomes passed or failed on submit. question_ids are the questions asked; include=answers embeds the answers given. Filter by filter[status] and filter[created_at]. An unknown investor, a non-investor user or another organisation's investor returns 404. Use GET /investors/{investor_id}/appropriateness-tests/{id} for one. Changes nothing.

Path parameters

  • investor_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.

Query parameters

  • limitinteger#

    Page size (1–100). Defaults to 25; values are clamped to the range.

    Default: 25
  • cursorstring#

    Opaque pagination cursor taken from a prior response's meta.next_cursor.

  • fieldsstring#

    Comma-separated top-level fields to return. id is always returned.

  • includestring#

    Set to answers to embed the answers given in each attempt.

  • sortstring#

    Comma-separated fields to sort by: created_at or expires_at. Prefix a field with - for descending. Defaults to -created_at, newest first. Attempts that tie fall back to id, in the same direction.

  • filter[status]string#

    Only attempts in this status: not_taken, passed or failed. Takes [in] and [not_in] with a comma-separated list.

    One of: not_taken, passed, failed
  • filter[created_at]string#

    Only attempts started in a range, written filter[created_at][gte]=2026-10-01. Takes gt, gte, lt and lte.

Responses

200

One page of the investor's appropriateness-test attempts.

InvestorAppropriatenessTest[]
{
  "data": [
    {
      "id": "5b8e2f6a-3c41-4d97-a0b2-7e1d9c4f8a36",
      "status": "passed",
      "question_ids": [
        3,
        9,
        14
      ],
      "expires_at": "2027-06-15T10:30:00Z",
      "created_at": "2026-06-15T10:20:00Z",
      "updated_at": "2026-06-15T10:30:00Z"
    }
  ],
  "meta": {
    "limit": 25,
    "next_cursor": null,
    "prev_cursor": null
  }
}
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
422

The request can't be processed (HTTP 422): validation_failed with one ErrorDetail per problem, or a code documented on the operation.

Error
429

Rate limit exceeded (error.code = rate_limited).

Error

Examples

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