Investor
An investor: a Horizon user of the investor type.
idrequiredstring (uuid)- The investor id.
first_namerequiredstring | null- The investor's first name.
last_namerequiredstring | null- The investor's last name.
titlerequiredstring | null- The investor's title, such as Ms or Dr.
emailrequiredstring | null- The investor's primary email address.
statusrequiredstring- Where the investor is in their lifecycle. Read-only: it changes through actions and DELETE.One of: active, pending, suspended, timeout, cooldown, deactivated
external_idrequiredstring | null- The investor's id in your own system.
sso_idrequiredstring | null- The investor's single sign-on id. Read-only.
key_contact_idrequiredstring | null (uuid)- The internal user who is the key contact of the investor's client organisation. Read-only; the organisation shares one key contact.
inviterequiredobject | null- The latest invite sent to the investor. Null when they have none. Read-only: send-invite changes it.
two_factor_enabledrequiredboolean- Whether the investor has set up two-factor authentication.
last_loginrequiredstring | null (date-time)- When the investor last signed in, as an ISO 8601 timestamp. Null if they never have.
created_atrequiredstring | null (date-time)- When the investor was created. Null for investors created before the platform recorded it.
updated_atrequiredstring | null (date-time)- When the investor last changed.
data_captureobject- The investor's answers to your custom user data fields, keyed by field reference.
onboardingobject | null- The investor's latest onboarding journey. Null when they have none.
invitesobject[]- The investor's invites, newest first, up to 100.
rolesobject[]- The roles the investor holds.
Used by (12)
- GETList investors
- POSTCreate an investor
- POSTCreate many investors
- POSTActivate many investors
- POSTSuspend many investors
- GETGet an investor
- PATCHUpdate an investor
- POSTActivate an investor
- POSTSuspend an investor
- POSTSend an investor their invitation
- POSTSet an investor's single sign-on id
- POSTSet an investor's key contact