Types

InvestorPreferenceLookup

An investor preference as it applies to one investor.

idrequired
string (uuid)
The preference's id.
namerequired
string
The preference's name, which is also the name of the form investors answer. Read-only.
form_idrequired
string (uuid)
The form investors answer for this preference. Read-only; the form is created with the preference.
staterequired
string
`enabled` asks investors the preference; `disabled` stops asking. A new preference is disabled.One of: enabled, disabled
enforcement_typerequired
string
`none` leaves the preference optional, `popup` shows investors a prompt, `forced` requires an answer.One of: none, popup, forced
editablerequired
boolean
Whether investors can change their answers after giving them.
created_atrequired
string (date-time)
When the preference was created.
updated_atrequired
string (date-time)
When the preference last changed.
implementation_idrequired
string | null (uuid)
The investor's implementation of the preference form, or null while they have none.
implementation_completedrequired
boolean
Whether the investor has completed the form.
user_staterequired
object | null
What the investor did with the prompt, or null while they have done nothing.

Used by (1)