Horizon

Interacting with routes still handled by the Horizon system.

Invite Investor

POST

/horizon/users?actions=api/v1/users/invite_client

Create a new investor invite for the platform.

Required user_invite POST body attributes

  • Name
    client_email
    Type
    string
    Description

    The email address of the client

  • Name
    client_title
    Type
    string
    Description

    The title of the client (e.g., Mr, Mrs, Ms)

  • Name
    client_forename
    Type
    string
    Description

    The first name of the client

  • Name
    client_surname
    Type
    string
    Description

    The last name of the client

  • Name
    investor_type
    Type
    string
    Description

    The type of investor, should usually be "Individual"

Description

This creates an invite for the specified investor, but will not send the invite until approved on the platform.

cURL

curl -X POST https://your.platform.url/kong/core/api/gateway/horizon/users?actions=api/v1/users/invite_client \
  -H "Authorization: Bearer {token}" \
  -H "Content-Type: application/json" \
  -d '{
  "user_invite": {
    "client_email": "email@example.com",
    "client_title": "Mr",
    "client_forename": "Test",
    "client_surname": "User",
    "investor_type": "Individual"
  }
}'