TransactionWorkflow
A reusable transaction workflow: the ordered steps an investor moves through on a deal.
idrequiredstring (uuid)- The workflow id.
namerequiredstring- The machine name.
labelrequiredstring- The name people see.
descriptionrequiredstring | null- What the workflow is for.
statusrequiredstring- draft or published, as the app has them. New workflows start as draft.One of: draft, published
is_defaultrequiredboolean- Whether new deals use this workflow. Change it with the set-default action.
kyc_check_step_idrequiredstring | 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.
stepsobject[]- The workflow's steps in order, with include=steps.
created_atrequiredstring (date-time)- When the workflow was created.
updated_atrequiredstring | null (date-time)- When the workflow last changed.
Used by (9)
- GETList transaction workflows
- POSTCreate a transaction workflow
- POSTImport a transaction workflow
- GETGet a transaction workflow
- PATCHUpdate a transaction workflow
- POSTMake a transaction workflow the default
- POSTAdd a KYC check to a transaction workflow
- POSTRemove a KYC check from a transaction workflow
- GETGet the deal transaction workflow