Types

Investor

An investor: a Horizon user of the investor type.

idrequired
string (uuid)
The investor id.
first_namerequired
string | null
The investor's first name.
last_namerequired
string | null
The investor's last name.
titlerequired
string | null
The investor's title, such as Ms or Dr.
emailrequired
string | null
The investor's primary email address.
statusrequired
string
Where the investor is in their lifecycle. Read-only: it changes through actions and DELETE.One of: active, pending, suspended, timeout, cooldown, deactivated
external_idrequired
string | null
The investor's id in your own system.
sso_idrequired
string | null
The investor's single sign-on id. Read-only.
key_contact_idrequired
string | null (uuid)
The internal user who is the key contact of the investor's client organisation. Read-only; the organisation shares one key contact.
inviterequired
object | null
The latest invite sent to the investor. Null when they have none. Read-only: send-invite changes it.
two_factor_enabledrequired
boolean
Whether the investor has set up two-factor authentication.
last_loginrequired
string | null (date-time)
When the investor last signed in, as an ISO 8601 timestamp. Null if they never have.
created_atrequired
string | null (date-time)
When the investor was created. Null for investors created before the platform recorded it.
updated_atrequired
string | null (date-time)
When the investor last changed.
data_capture
object
The investor's answers to your custom user data fields, keyed by field reference.
onboarding
object | null
The investor's latest onboarding journey. Null when they have none.
invites
object[]
The investor's invites, newest first, up to 100.
roles
object[]
The roles the investor holds.

Used by (12)