Workflow

7 operations in the Tolvi API, version 1. Paths are relative to https://api.tolvi.co.uk. Every amount is integer pence.

Sign a section off at its current stage

POST/api/v1/engagements/{id}/sections/{code}/sign

Scopes: engagements:write and engagements:read

Preparer sign-off, or a review stage’s (which also needs review:write). Records the content fingerprint. Not available through MCP. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/sections/{code}/sign
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.
`code`required	path	`string`	Section code (W/P ref), e.g. C. One of: `A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I`, `J`, `K`, `L`, `M`, `T`, `X`, `Z`

Responses

200 OK, `application/json`

Body: object (SectionDetail).

200 OK response for POST /api/v1/engagements/{id}/sections/{code}/sign
Field	Type	Description
`code`required	`string`	example "C"
`name`required	`string`
`kind`required	`string (SectionKind)`	One of: `plan`, `tb`, `lead`, `jnl`, `fs`
`status`required	`string (SectionStatus)`	One of: `todo`, `progress`, `prepared`, `reviewed`, `changed`
`issueCount`required	`integer`	at least 0
`openReviewPoints`required	`integer`	at least 0
`signOffs`required	`array of SignOff`
`signOffs[].stageId`required	`string`
`signOffs[].stageName`required	`string`
`signOffs[].signAs`required	`string (SignOffRole)`	Who signs at this stage, for labels such as "Sign as reviewer". One of: `preparer`, `reviewer`, `manager`, `partner`
`signOffs[].userId`required	`string (uuid)`nullable
`signOffs[].at`required	`string (date-time)`nullable
`signOffs[].current`required	`boolean`	Signed against the content as it is now.
`currentStageId`required	`string`nullable	Stage the section is at.
`checklist`required	`array of ChecklistItem`
`checklist[].id`required	`string (uuid)`
`checklist[].position`required	`integer`
`checklist[].text`required	`string`
`checklist[].origin`required	`string (ChecklistOrigin)`	One of: `builtin`, `firm`, `client`
`checklist[].status`required	`string (ChecklistStatus)`	"" is not yet done. One of: , `done`, `na`
`checklist[].auto`required	`boolean`	Ticked by Tolvi from the data (a person’s own tick always wins).
`checklist[].note`required	`string`
`checklist[].doneBy`required	`string (uuid)`nullable
`checklist[].doneAt`required	`string (date-time)`nullable
`checklist[].evidence`required	`array of Evidence`
`checklist[].evidence[].id`required	`string (uuid)`
`checklist[].evidence[].sectionCode`required	`string`nullable
`checklist[].evidence[].checklistItemId`required	`string (uuid)`nullable
`checklist[].evidence[].reviewPointId`required	`string (uuid)`nullable
`checklist[].evidence[].reviewPointMessageId`required	`string (uuid)`nullable
`checklist[].evidence[].fileName`required	`string`
`checklist[].evidence[].contentType`required	`string`
`checklist[].evidence[].sizeBytes`required	`integer`	at least 0
`checklist[].evidence[].status`required	`string (EvidenceStatus)`	pending_upload until POST …/evidence/{evidenceId}/confirm checks the stored file; then pending_scan (malware scan) and available. Only available files can be downloaded or read by Tolvi AI. rejected: the file failed the checks or the scan found malware (see rejectedReason); it can never be downloaded. One of: `pending_upload`, `pending_scan`, `available`, `rejected`
`checklist[].evidence[].rejectedReason`required	`string`nullable	Why a rejected file was rejected, e.g. "malware detected"; null otherwise.
`checklist[].evidence[].uploadedBy`required	`string (uuid)`nullable
`checklist[].evidence[].createdAt`required	`string (date-time)`
`issues`required	`array of Issue`
`issues[].message`required	`string`
`issues[].action`required	`string (IssueAction)`	One of: `import`, `map`, `journal`, `explain`, `reconcile`, `post_tax`, `post_deferred_tax`, `open_tax`, `fixed_assets`, `post_fixed_assets`, `checklist`
`issues[].label`required	`string`
`issues[].target`required	`string`nullable
`signOff`required	`object (SectionSignOffPanel)`
`signOff.stages`required	`array of SignOff`	Every stage that applies to sections, with its live sign-off.
`signOff.stages[].stageId`required	`string`
`signOff.stages[].stageName`required	`string`
`signOff.stages[].signAs`required	`string (SignOffRole)`	Who signs at this stage, for labels such as "Sign as reviewer". One of: `preparer`, `reviewer`, `manager`, `partner`
`signOff.stages[].userId`required	`string (uuid)`nullable
`signOff.stages[].at`required	`string (date-time)`nullable
`signOff.stages[].current`required	`boolean`	Signed against the content as it is now.
`signOff.currentStageId`required	`string`
`signOff.sign`required	`object (GuardResult)`	Can the caller sign at the current stage now?
`signOff.sign.allowed`required	`boolean`
`signOff.sign.reasons`required	`array of string`
`signOff.sign.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`signOff.ownSignOffStageId`required	`string`nullable	Stage of the caller’s own live sign-off, which they can remove.
`signOff.signStageId`	`string`nullable	The stage signing now would record the caller’s sign-off at. Usually `currentStageId`; the first stage when the caller re-signs their own out-of-date preparer sign-off (the section is reopened first). Null when there is nothing to sign.
`signOff.unsign`	`object (GuardResult)`	Can the caller remove their own sign-off now? Refused while the file is signed off at every stage.
`signOff.unsign.allowed`required	`boolean`
`signOff.unsign.reasons`required	`array of string`
`signOff.unsign.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`signOff.unsignRemoves`	`array of SignOff`	Removing the caller’s own sign-off removes these later sign-offs too (other people’s).
`signOff.unsignRemoves[].stageId`required	`string`
`signOff.unsignRemoves[].stageName`required	`string`
`signOff.unsignRemoves[].signAs`required	`string (SignOffRole)`	Who signs at this stage, for labels such as "Sign as reviewer". One of: `preparer`, `reviewer`, `manager`, `partner`
`signOff.unsignRemoves[].userId`required	`string (uuid)`nullable
`signOff.unsignRemoves[].at`required	`string (date-time)`nullable
`signOff.unsignRemoves[].current`required	`boolean`	Signed against the content as it is now.
`signOff.fingerprint`required	`string`	Content fingerprint now.
`nextStep`required	`object (NextStep)`	The first outstanding item and the one action that deals with it.
`nextStep.message`required	`string`
`nextStep.action`required	`string (NextStepAction)`	One of: `import`, `map`, `journal`, `explain`, `reconcile`, `post_tax`, `post_deferred_tax`, `open_tax`, `fixed_assets`, `post_fixed_assets`, `checklist`, `sign`, `resign`, `answer_review_point`, `check_review_point`, `raise_review_point`, `open_section`, `submit`, `approve`, `reopen`, `wait`, `none`, `generate_file`, `start_next_year`
`nextStep.label`required	`string`nullable	Button label, e.g. "Post tax journal".
`nextStep.target`required	`string`nullable	Section code, journal id, account code or review point id the action is about.
`nextStep.done`required	`boolean`	Nothing left for anyone to do here.
`nextStep.more`required	`integer`	Further outstanding items after this one. at least 0
`reviewPoints`required	`array of ReviewPoint`
`reviewPoints[].id`required	`string (uuid)`
`reviewPoints[].sectionCode`required	`string`nullable	Null for a point on the engagement as a whole.
`reviewPoints[].category`required	`string (ReviewPointCategory)`	One of: `query`, `error`, `presentation`, `missing_evidence`
`reviewPoints[].status`required	`string (ReviewPointStatus)`	One of: `open`, `answered`, `cleared`, `reopened`
`reviewPoints[].raisedAtStageId`required	`string`
`reviewPoints[].raisedInRound`required	`integer`	at least 1
`reviewPoints[].raisedBy`required	`string (uuid)`nullable
`reviewPoints[].raisedAt`required	`string (date-time)`
`reviewPoints[].clearedBy`required	`string (uuid)`nullable
`reviewPoints[].clearedAt`required	`string (date-time)`nullable
`reviewPoints[].sourceMeetingId`	`string (uuid)`nullable	The meeting whose next step this point came from (Create follow-ups in Tolvi Meetings), if any.
`reviewPoints[].messages`required	`array of ReviewPointMessage`
`reviewPoints[].messages[].id`required	`string (uuid)`
`reviewPoints[].messages[].kind`required	`string (ReviewPointMessageKind)`	One of: `raise`, `comment`, `answer`, `clear`, `reopen`
`reviewPoints[].messages[].authorId`required	`string (uuid)`nullable
`reviewPoints[].messages[].body`required	`string`
`reviewPoints[].messages[].mentions`required	`array of string (uuid)`
`reviewPoints[].messages[].at`required	`string (date-time)`
`reviewPoints[].messages[].evidence`required	`array of Evidence`
`reviewPoints[].messages[].evidence[].id`required	`string (uuid)`
`reviewPoints[].messages[].evidence[].sectionCode`required	`string`nullable
`reviewPoints[].messages[].evidence[].checklistItemId`required	`string (uuid)`nullable
`reviewPoints[].messages[].evidence[].reviewPointId`required	`string (uuid)`nullable
`reviewPoints[].messages[].evidence[].reviewPointMessageId`required	`string (uuid)`nullable
`reviewPoints[].messages[].evidence[].fileName`required	`string`
`reviewPoints[].messages[].evidence[].contentType`required	`string`
`reviewPoints[].messages[].evidence[].sizeBytes`required	`integer`	at least 0
`reviewPoints[].messages[].evidence[].status`required	`string (EvidenceStatus)`	pending_upload until POST …/evidence/{evidenceId}/confirm checks the stored file; then pending_scan (malware scan) and available. Only available files can be downloaded or read by Tolvi AI. rejected: the file failed the checks or the scan found malware (see rejectedReason); it can never be downloaded. One of: `pending_upload`, `pending_scan`, `available`, `rejected`
`reviewPoints[].messages[].evidence[].rejectedReason`required	`string`nullable	Why a rejected file was rejected, e.g. "malware detected"; null otherwise.
`reviewPoints[].messages[].evidence[].uploadedBy`required	`string (uuid)`nullable
`reviewPoints[].messages[].evidence[].createdAt`required	`string (date-time)`
`evidence`required	`array of Evidence`
`evidence[].id`required	`string (uuid)`
`evidence[].sectionCode`required	`string`nullable
`evidence[].checklistItemId`required	`string (uuid)`nullable
`evidence[].reviewPointId`required	`string (uuid)`nullable
`evidence[].reviewPointMessageId`required	`string (uuid)`nullable
`evidence[].fileName`required	`string`
`evidence[].contentType`required	`string`
`evidence[].sizeBytes`required	`integer`	at least 0
`evidence[].status`required	`string (EvidenceStatus)`	pending_upload until POST …/evidence/{evidenceId}/confirm checks the stored file; then pending_scan (malware scan) and available. Only available files can be downloaded or read by Tolvi AI. rejected: the file failed the checks or the scan found malware (see rejectedReason); it can never be downloaded. One of: `pending_upload`, `pending_scan`, `available`, `rejected`
`evidence[].rejectedReason`required	`string`nullable	Why a rejected file was rejected, e.g. "malware detected"; null otherwise.
`evidence[].uploadedBy`required	`string (uuid)`nullable
`evidence[].createdAt`required	`string (date-time)`

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Remove your own sign-off from a section

POST/api/v1/engagements/{id}/sections/{code}/unsign

Scopes: engagements:write and engagements:read

Later sign-offs are removed with it (the section detail’s signOff.unsignRemoves lists them). Refused (409) while the file is signed off at every stage: reopen it for re-approval first. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/sections/{code}/unsign
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.
`code`required	path	`string`	Section code (W/P ref), e.g. C. One of: `A`, `B`, `C`, `D`, `E`, `F`, `G`, `H`, `I`, `J`, `K`, `L`, `M`, `T`, `X`, `Z`

Responses

200 OK, `application/json`

Body: object (SectionDetail).

The fields are as shown above.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Get the engagement workflow and its event history

GET/api/v1/engagements/{id}/workflow

Scopes: engagements:read

Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for GET /api/v1/engagements/{id}/workflow
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.

Responses

200 OK, `application/json`

Body: object (WorkflowHistory).

200 OK response for GET /api/v1/engagements/{id}/workflow
Field	Type	Description
`workflow`required	`object (EngagementWorkflow)`
`workflow.templateId`required	`string`
`workflow.templateName`required	`string`
`workflow.status`required	`string (EngagementStatus)`	One of: `not_started`, `in_progress`, `submitted`, `returned`, `complete`
`workflow.workflowStatus`required	`string (WorkflowStatus)`	One of: `in_progress`, `submitted`, `returned`, `reopened`, `approved`
`workflow.currentStageId`required	`string`
`workflow.currentStageName`required	`string`
`workflow.currentStageIndex`required	`integer`	at least 0
`workflow.stages`required	`array of WorkflowStage`
`workflow.stages[].id`required	`string`
`workflow.stages[].name`required	`string`
`workflow.stages[].state`required	`string (TimelineStepState)`	One of: `done`, `now`, `todo`
`workflow.stages[].signedBy`required	`string (uuid)`nullable
`workflow.stages[].signedAt`required	`string (date-time)`nullable
`workflow.stages[].assigneeId`required	`string (uuid)`nullable	Who the engagement team assigns to this stage (preparer, reviewer, manager or partner), or null when nobody is.
`workflow.stages[].sentBackBy`required	`string (uuid)`nullable	While the workflow is returned: who sent it back from this stage.
`workflow.stages[].sentBackAt`required	`string (date-time)`nullable	While the workflow is returned: when it was sent back from this stage.
`workflow.round`required	`integer`	Amendment round (each return or reopen starts a new one). at least 1
`workflow.returnCount`required	`integer`	at least 0
`workflow.reopenCount`required	`integer`	at least 0
`workflow.changedAfterApproval`required	`boolean`
`workflow.returnTargets`required	`array of string`	Stages a return can go back to.
`workflow.actions`required	`object (EngagementActions)`	The engagement-level actions, checked for the caller.
`workflow.actions.submit`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`workflow.actions.submit.allowed`required	`boolean`
`workflow.actions.submit.reasons`required	`array of string`
`workflow.actions.submit.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`workflow.actions.approve`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`workflow.actions.approve.allowed`required	`boolean`
`workflow.actions.approve.reasons`required	`array of string`
`workflow.actions.approve.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`workflow.actions.return`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`workflow.actions.return.allowed`required	`boolean`
`workflow.actions.return.reasons`required	`array of string`
`workflow.actions.return.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`workflow.actions.reopen`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`workflow.actions.reopen.allowed`required	`boolean`
`workflow.actions.reopen.reasons`required	`array of string`
`workflow.actions.reopen.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`events`required	`array of WorkflowEvent`
`events[].id`required	`string (uuid)`
`events[].subject`required	`string`	"engagement" or a section code.
`events[].type`required	`string`
`events[].stageId`required	`string`
`events[].actorId`required	`string (uuid)`nullable
`events[].at`required	`string (date-time)`
`events[].fromStatus`required	`string`
`events[].toStatus`required	`string`
`events[].round`required	`integer`
`events[].openPoints`required	`integer`
`events[].fingerprint`required	`string`nullable
`events[].note`	`string`nullable	The note given with a submission or approval.
`events[].declaration`	`object (ApprovalDeclaration)`nullable	The declaration given with an approval.
`events[].declaration.initials`required	`string`	The approver’s initials, typed as a signature. 1 to 10 characters
`events[].declaration.statement`required	`string`	What they declared, e.g. "I have reviewed the file and approve the accounts for issue to the client." 1 to 500 characters

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Submit the engagement for review

POST/api/v1/engagements/{id}/workflow/submit

Scopes: engagements:write and engagements:read

Every section prepared and unchanged, no unanswered review points. Optionally name who takes the next stage (reviewerId, saved on the team) and leave them a note. Not available through MCP. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/workflow/submit
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.

Request body

Optional. application/json: object (SubmitEngagement).

Optional: name who reviews next and leave them a note.

Request body for POST /api/v1/engagements/{id}/workflow/submit
Field	Type	Description
`reviewerId`	`string (uuid)`	The person for the next stage (reviewer, manager or partner by the stage’s role). Saved on the engagement team, replacing whoever was there, and told about the submission. Must be a member of the firm.
`note`	`string`	A cover note for the reviewer: kept with the submission in the history and sent with the notification. up to 2000 characters

Responses

200 OK, `application/json`

Body: object (EngagementWorkflow).

200 OK response for POST /api/v1/engagements/{id}/workflow/submit
Field	Type	Description
`templateId`required	`string`
`templateName`required	`string`
`status`required	`string (EngagementStatus)`	One of: `not_started`, `in_progress`, `submitted`, `returned`, `complete`
`workflowStatus`required	`string (WorkflowStatus)`	One of: `in_progress`, `submitted`, `returned`, `reopened`, `approved`
`currentStageId`required	`string`
`currentStageName`required	`string`
`currentStageIndex`required	`integer`	at least 0
`stages`required	`array of WorkflowStage`
`stages[].id`required	`string`
`stages[].name`required	`string`
`stages[].state`required	`string (TimelineStepState)`	One of: `done`, `now`, `todo`
`stages[].signedBy`required	`string (uuid)`nullable
`stages[].signedAt`required	`string (date-time)`nullable
`stages[].assigneeId`required	`string (uuid)`nullable	Who the engagement team assigns to this stage (preparer, reviewer, manager or partner), or null when nobody is.
`stages[].sentBackBy`required	`string (uuid)`nullable	While the workflow is returned: who sent it back from this stage.
`stages[].sentBackAt`required	`string (date-time)`nullable	While the workflow is returned: when it was sent back from this stage.
`round`required	`integer`	Amendment round (each return or reopen starts a new one). at least 1
`returnCount`required	`integer`	at least 0
`reopenCount`required	`integer`	at least 0
`changedAfterApproval`required	`boolean`
`returnTargets`required	`array of string`	Stages a return can go back to.
`actions`required	`object (EngagementActions)`	The engagement-level actions, checked for the caller.
`actions.submit`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`actions.submit.allowed`required	`boolean`
`actions.submit.reasons`required	`array of string`
`actions.submit.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`actions.approve`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`actions.approve.allowed`required	`boolean`
`actions.approve.reasons`required	`array of string`
`actions.approve.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`actions.return`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`actions.return.allowed`required	`boolean`
`actions.return.reasons`required	`array of string`
`actions.return.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.
`actions.reopen`required	`object (GuardResult)`	Whether the caller can take an action now, and every reason not.
`actions.reopen.allowed`required	`boolean`
`actions.reopen.reasons`required	`array of string`
`actions.reopen.codes`required	`array of string`	Machine-readable reason codes from @tolvi/workflow.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Approve the engagement at its current stage

POST/api/v1/engagements/{id}/workflow/approve

Scopes: review:write and engagements:read
Role: Reviewer or above

Segregation of duties and every workflow guard apply. Optionally name who takes the next stage (reviewerId, saved on the team as on submit, and told). An optional note and declaration (with the approver’s typed initials) are kept with the approval in the history and the audit trail. Not available through MCP.

Needs the Reviewer role or above. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/workflow/approve
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.

Request body

Optional. application/json: object (ApproveEngagement).

Request body for POST /api/v1/engagements/{id}/workflow/approve
Field	Type	Description
`reviewerId`	`string (uuid)`	The person for the next stage (manager or partner by the stage’s role), as on submit. Saved on the engagement team, replacing whoever was there, and told about the approval. Must be a member of the firm. Ignored at the last stage.
`note`	`string`	A note kept with the approval in the history and sent with the notification. up to 2000 characters
`declaration`	`object (ApprovalDeclaration)`	The approver’s declaration with their typed initials (the web app asks for one at partner sign-off).
`declaration.initials`required	`string`	The approver’s initials, typed as a signature. 1 to 10 characters
`declaration.statement`required	`string`	What they declared, e.g. "I have reviewed the file and approve the accounts for issue to the client." 1 to 500 characters

Responses

200 OK, `application/json`

Body: object (EngagementWorkflow).

The fields are as shown above.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Return the engagement to an earlier stage

POST/api/v1/engagements/{id}/workflow/return

Scopes: review:write and engagements:read
Role: Reviewer or above

Needs at least one unanswered review point; starts a new amendment round. An optional note for the preparer is kept in the history and sent with the notification.

Needs the Reviewer role or above. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/workflow/return
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.

Request body

Required. application/json: object (ReturnEngagement).

Request body for POST /api/v1/engagements/{id}/workflow/return
Field	Type	Description
`toStageId`	`string`	Default: the first stage.
`reviewPointIds`	`array of string (uuid)`	Default: every unanswered review point.
`note`	`string`	A note for the preparer: kept with the return in the history and sent with the notification. up to 2000 characters

Responses

200 OK, `application/json`

Body: object (EngagementWorkflow).

The fields are as shown above.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Reopen an approved engagement whose content changed

POST/api/v1/engagements/{id}/workflow/reopen

Scopes: review:write and engagements:read
Role: Reviewer or above

Approvals from the target stage on go stale.

Needs the Reviewer role or above. Part of the working_papers product: the firm must have it and you must have access to it.

Parameters

Parameters for POST /api/v1/engagements/{id}/workflow/reopen
Name	In	Type	Description
`id`required	path	`string (uuid)`	Engagement id.

Request body

Required. application/json: object (ReopenEngagement).

Request body for POST /api/v1/engagements/{id}/workflow/reopen
Field	Type	Description
`toStageId`	`string`	Default: the first review stage.

Responses

200 OK, `application/json`

Body: object (EngagementWorkflow).

The fields are as shown above.

Errors: 400 Bad request, 401 Unauthorised, 403 Forbidden, 404 Not found, 429 Too many requests, as problem details (application/problem+json).

Workflow

Sign a section off at its current stage

Parameters

Responses

200 OK, application/json

Remove your own sign-off from a section

Parameters

Responses

200 OK, application/json

Get the engagement workflow and its event history

Parameters

Responses

200 OK, application/json

Submit the engagement for review

Parameters

Request body

Responses

200 OK, application/json

Approve the engagement at its current stage

Parameters

Request body

Responses

200 OK, application/json

Return the engagement to an earlier stage

Parameters

Request body

Responses

200 OK, application/json

Reopen an approved engagement whose content changed

Parameters

Request body

Responses

200 OK, application/json

200 OK, `application/json`

200 OK, `application/json`

200 OK, `application/json`

200 OK, `application/json`

200 OK, `application/json`

200 OK, `application/json`

200 OK, `application/json`