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.
Task types and statuses
Section titled “Task types and statuses”type | Raised for |
|---|---|
MISSING_DOCUMENT | A required document has not been provided |
DOCUMENT_VALIDATION_FAILED | A document failed validation |
SCREENING_MATCH | A screening hit needs review |
PENDING_ONBOARDING | Onboarding is incomplete |
PERIODIC_REVIEW | A scheduled re-review is due |
ONBOARDING_ORG_CHART_REVIEW | The ownership / org chart needs review |
status | Meaning |
|---|---|
PENDING | Open |
MISSING_DATA | Blocked waiting on data |
RESOLVED | Complete |
A task may be scoped to a sub-entity via its entityType (DOCUMENT, SCREENING_HIT, or APPLICATION) and entityId.
Operations
Section titled “Operations”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.
Example
Section titled “Example”# List taskscurl https://api.getsteward.ai/api/v1/tasks \ -H "Authorization: Bearer stw_live_your_api_key_here"
# Mark a task resolvedcurl -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" }'