Types

TransactionWorkflow

A reusable transaction workflow: the ordered steps an investor moves through on a deal.

idrequired
string (uuid)
The workflow id.
namerequired
string
The machine name.
labelrequired
string
The name people see.
descriptionrequired
string | null
What the workflow is for.
statusrequired
string
draft or published, as the app has them. New workflows start as draft.One of: draft, published
is_defaultrequired
boolean
Whether new deals use this workflow. Change it with the set-default action.
kyc_check_step_idrequired
string | null (uuid)
The KYC check step of the workflow's first KYC pair, which moves an investor on once their KYC check passes. Add and remove KYC with the add-kyc and remove-kyc actions. Null when the workflow has no KYC check.
steps
object[]
The workflow's steps in order, with include=steps.
created_atrequired
string (date-time)
When the workflow was created.
updated_atrequired
string | null (date-time)
When the workflow last changed.

Used by (9)