Skip to content
Back to Steward

Tasks

A task is a unit of compliance or onboarding work that Steward raises on an application — a missing document, a failed document validation, a screening match to review, and so on. Every task belongs to an application, and may point at a specific sub-entity within it.

typeRaised for
MISSING_DOCUMENTA required document has not been provided
DOCUMENT_VALIDATION_FAILEDA document failed validation
SCREENING_MATCHA screening hit needs review
PENDING_ONBOARDINGOnboarding is incomplete
PERIODIC_REVIEWA scheduled re-review is due
ONBOARDING_ORG_CHART_REVIEWThe ownership / org chart needs review
statusMeaning
PENDINGOpen
MISSING_DATABlocked waiting on data
RESOLVEDComplete

A task may be scoped to a sub-entity via its entityType (DOCUMENT, SCREENING_HIT, or APPLICATION) and entityId.

GET /tasks lists tasks and GET /tasks/{id} returns one. PATCH /tasks/{id} updates a task — you can change its status, assigneeId, and reviewerId. A task’s type, title, and application are fixed once created.

Terminal window
# List tasks
curl https://api.getsteward.ai/api/v1/tasks \
-H "Authorization: Bearer stw_live_your_api_key_here"
# Mark a task resolved
curl -X PATCH https://api.getsteward.ai/api/v1/tasks/{id} \
-H "Authorization: Bearer stw_live_your_api_key_here" \
-H "Content-Type: application/json" \
-d '{ "status": "RESOLVED" }'