Types

UserDataCaptureField

A single field in the firm's enabled User Data Capture (UDC) schema (UserDataCaptureFieldResource).

referencerequired
string
Stable key used to read/write this field's value on the investor `data_capture` map.
labelrequired
string | null
namerequired
string | null
typerequired
string | null
The form field type (e.g. TEXT, DATE, CURRENCY, INTEGER, CHECKBOX, DROPDOWN, MULTI_DROPDOWN).
allowed_valuesrequired
array | null
For option-style fields, the permitted values; null otherwise.
requiredrequired
boolean

Used by (1)