Types

InvestorCreate

The body that creates an investor.

emailrequired
string (email)
The investor's email. At most 53 characters, so the sign-in username with its invite suffix fits 64. A live investor with this email, on any contact email, is returned unchanged with 200.
title
string | null
Optional title, such as Mr, Ms or Dr.
first_namerequired
string
The investor's first name.
last_namerequired
string
The investor's last name.
sso_id
string | null
The investor's single sign-on id.
external_id
string | null
The investor's id in your own system.
data_capture
object
Answers to your custom user data fields, keyed by field `reference`. Every reference must exist, else 422 `exists`.
onboarding_uuid
string (uuid)
The published onboarding journey the investor follows. Required while the organisation has a published journey, else 422.
auto_send
string
Whether to send the invite email: `Yes` sends it, `No` never does. Omit to follow the organisation's approval workflow: held when it has one, sent otherwise.One of: Yes, No
type
string
Accepted as `investor` and ignored. It is removed when the old routes are withdrawn on 2027-06-30.One of: investor

Used by (2)