Types

Invite

An invite, which carries an investor or an internal user through registration.

idrequired
string (uuid)
The invite id.
typerequired
string
Who the invite is for: investor, internal_user or advisor. Read-only.One of: investor, internal_user, advisor
statusrequired
string
Where the invite is in its lifecycle. Read-only: it changes through actions.One of: invited, draft, completed, revoked
emailrequired
string | null
The address the invitation is sent to.
titlerequired
string | null
The invitee's title, such as Ms or Dr.
first_namerequired
string | null
The invitee's first name.
last_namerequired
string | null
The invitee's last name.
sso_idrequired
string | null
The invitee's single sign-on id.
onboarding_idrequired
string | null (uuid)
The published onboarding journey the invitee completes after registering. Set only by `POST /invites` for an investor and read-only afterwards. Null when none was given and for an internal user.
user_idrequired
string | null (uuid)
The invitee, an investor or internal user. Read-only. Null when no user is linked to the invite or the user was deactivated.
expires_atrequired
string | null (date-time)
When the invite expires. Read-only: send, resend and extend change it.
invited_atrequired
string | null (date-time)
When the invitation was last sent. Null for a draft that was never sent.
created_atrequired
string | null (date-time)
When the invite was created.
updated_atrequired
string | null (date-time)
When the invite last changed.

Used by (11)