Investor Preferences

Create an implementation of an investor preference

POST/investor-preferences/{investor_preference_id}/implementations
investor-preferences:writecreate_investor_preference_implementation

Gives one investor their own copy of the preference's form, and returns it with a Location. investor_id must be an investor you can see, or it returns 422 exists. The preference must be enabled, or it returns 409 invalid_state. An investor who already has a copy returns 409 conflict with its id in details[0].implementation_id. The investor is not notified. dry_run shows the result without saving it. Emits no event; no email. Has no undo through the API.

Path parameters

  • investor_preference_idstring (uuid)Required#

    The investor preference's id, a uuid. An unknown, malformed or deleted preference returns 404.

Query parameters

  • dry_runboolean#

    Validate and run the call without committing it, returning what the real call would return with meta.dry_run set.

Headers

  • Idempotency-Keystring#

    Makes a retry safe. Send a new UUID for each new request and reuse it only to retry that request; the first response is replayed for 24 hours.

Request body

application/json, required · InvestorPreferenceImplementationCreate

  • investor_idstring (uuid)Required#

    The investor to give the form to. Must be an investor you can see.

{
  "investor_id": "5c7975c7-457d-4cb9-bc7e-f5475a5e6540"
}

Responses

201

The implementation was created.

InvestorPreferenceImplementation
{
  "data": {
    "id": "7d3e9a10-2b4c-4f6a-8d1e-3c5b7a9f0e21",
    "investor_id": "5c7975c7-457d-4cb9-bc7e-f5475a5e6540",
    "completed": false,
    "started_at": "2026-06-15T10:30:00Z",
    "completed_at": null,
    "created_at": "2026-06-15T10:30:00Z",
    "updated_at": "2026-06-15T10:30:00Z"
  }
}
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
409

The request conflicts with existing state (error.code = conflict), e.g. a compliance flow with the requested name already exists.

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 -X POST https://your-org-domain/kong/core/api/v2/investor-preferences/{investor_preference_id}/implementations\
  -H "Authorization: Bearer $HELM_API_KEY"\
  -H "Content-Type: application/json"\
  -d '{
  "investor_id": "5c7975c7-457d-4cb9-bc7e-f5475a5e6540"
}'