Skip to content
Steward Developers
Back to Steward

Update a task

PATCH
/api/v1/tasks/{taskId}

Authorizations

Section titled “Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “Path Parameters ”
taskId
required
string

Task ID

Request Body required

Section titled “Request Body required ”
object
status

New status for the task

string
Allowed values: PENDING MISSING_DATA RESOLVED
assigneeId

ID of the user assigned to this task

string
Example
60d5ecb54b24003a7c8e92b2
reviewerId

ID of the reviewer for this task

string
Example
60d5ecb54b24003a7c8e92b2

Responses

Section titled “ Responses ”

200

Section titled “200 ”

Task updated successfully

object
id
required

Task ID

string
Example
507f1f77bcf86cd799439011
applicationId
required

ID of the application this task belongs to

string
Example
507f1f77bcf86cd799439011
status
required

Current status of the task

string
Allowed values: PENDING MISSING_DATA RESOLVED
type
required

Type of task

string
Allowed values: MISSING_DOCUMENT DOCUMENT_VALIDATION_FAILED SCREENING_MATCH PENDING_ONBOARDING PERIODIC_REVIEW ONBOARDING_ORG_CHART_REVIEW MISSING_FIELD
title
required

Title of the task

string
Example
Review proof of address document
description

Detailed description of the task

string
Example
Verify the uploaded utility bill matches the applicant address
entityType

Entity type the task relates to

string
Allowed values: DOCUMENT SCREENING_HIT APPLICATION PROFILE_FIELD
entityId

ID of the related entity

string
Example
507f1f77bcf86cd799439012
document

Related document details

object
id
required
string
Example
507f1f77bcf86cd799439011
type
required
string
Example
PROOF_OF_ADDRESS
subType
string
Allowed values: PASSPORT DRIVING_LICENSE ID_CARD
title
required
string
Example
Proof of Address
fileName
required
string
Example
utility_bill.pdf
url
required
string
Example
https://storage.example.com/documents/utility_bill.pdf
validations
required
Array<object>
object
type
required

The type of document validation

string
Allowed values: VALID_PROOF_OF_ADDRESS USER_PROVIDED_DATA_MATCH_ARTICLES_OF_INCORPORATION USER_PROVIDED_DATA_MATCH_ARTICLES_OF_ASSOCIATION USER_PROVIDED_DATA_MATCH_MEMORANDUM_ARTICLES_OF_ASSOCIATION USER_PROVIDED_DATA_MATCH_PROOF_OF_ADDRESS USER_PROVIDED_DATA_MATCH_REGISTER_OF_DIRECTORS USER_PROVIDED_DATA_MATCH_REGISTER_OF_SHAREHOLDERS USER_PROVIDED_DATA_MATCH_CAP_TABLE USER_PROVIDED_DATA_MATCH_REGISTER_OF_MEMBERS USER_PROVIDED_DATA_MATCH_PARTNERSHIP_AGREEMENT SOURCE_OF_FUNDS USER_PROVIDED_DATA_MATCH_SOURCE_OF_FUNDS SOURCE_OF_WEALTH USER_PROVIDED_DATA_MATCH_SOURCE_OF_WEALTH ONFIDO_DOCUMENT_VALIDATION TRULIOO_DOCUMENT_VALIDATION USER_PROVIDED_DATA_MATCH_TRUST_DEED USER_PROVIDED_DATA_MATCH_TRUST_REGISTER_OF_BENEFICIARIES USER_PROVIDED_DATA_MATCH_FOUNDATION_CHARTER USER_PROVIDED_DATA_MATCH_FOUNDATION_STATUTES USER_PROVIDED_DATA_MATCH_REGISTER_OF_BOARD_COUNCIL_MEMBERS USER_PROVIDED_DATA_MATCH_ORG_CHART USER_PROVIDED_DATA_PRELIMINARY_ORG_CHART ORG_CHART_CERTIFIED_ALPHA TRUST_DEED_SIGNED USER_PROVIDED_DATA_MATCH_PROOF_OF_ADDRESS_IDENTITY USER_PROVIDED_DATA_MATCH_SHAREHOLDERS_AGREEMENT USER_PROVIDED_DATA_MATCH_FINANCIAL_STATEMENTS USER_PROVIDED_DATA_MATCH_UBO_REGISTER_EXTRACT USER_PROVIDED_DATA_MATCH_COMPANY_REGISTRY_EXTRACT USER_PROVIDED_DATA_MATCH_W8 USER_PROVIDED_DATA_MATCH_W8_BEN_E USER_PROVIDED_DATA_MATCH_W9 USER_PROVIDED_DATA_MATCH_SUBSCRIPTION_AGREEMENT USER_PROVIDED_DATA_MATCH_INVESTOR_INFORMATION_FORM USER_PROVIDED_DATA_MATCH_CORPORATE_RESOLUTION USER_PROVIDED_DATA_MATCH_INVESTMENT_MANAGEMENT_AGREEMENT USER_PROVIDED_DATA_MATCH_CERTIFICATE_OF_INCUMBENCY USER_PROVIDED_DATA_MATCH_SIGNED_DIRECTOR_REGISTER USER_PROVIDED_DATA_MATCH_CHANGE_OF_NAME USER_PROVIDED_DATA_MATCH_SOURCE_OF_FUNDS_WEALTH_DECLARATION USER_PROVIDED_DATA_MATCH_FATCA_CRS_DECLARATION USER_PROVIDED_DATA_MATCH_CRS_SELF_CERT_ENTITY USER_PROVIDED_DATA_MATCH_AUTHORISED_SIGNATORY_LIST USER_PROVIDED_DATA_MATCH_PROOF_OF_REGULATION ID_CARD_ATTRIBUTE_VALIDATION USER_PROVIDED_DATA_MATCH_SPECIMEN_SIGNATURES USER_PROVIDED_DATA_MATCH_OWNERSHIP_CHART USER_PROVIDED_DATA_MATCH_TRANSACTION_AUTHORISATION_LETTER USER_PROVIDED_DATA_MATCH_AUTHORISED_TO_ACT_RESOLUTION USER_PROVIDED_DATA_MATCH_POWERS_OF_ATTORNEY USER_PROVIDED_DATA_MATCH_AIFM_APPOINTMENT_PROOF USER_PROVIDED_DATA_MATCH_CELL_REGISTER USER_PROVIDED_DATA_MATCH_CERTIFICATE_OF_FORMATION USER_PROVIDED_DATA_MATCH_CERTIFICATE_OF_LIMITED_PARTNERSHIP USER_PROVIDED_DATA_MATCH_CERTIFICATE_OF_REGISTRATION USER_PROVIDED_DATA_MATCH_CONSTITUTION USER_PROVIDED_DATA_MATCH_CONSTITUTIONAL_DOCUMENT USER_PROVIDED_DATA_MATCH_CORPORATE_BYLAWS USER_PROVIDED_DATA_MATCH_OPERATING_AGREEMENT USER_PROVIDED_DATA_MATCH_PROSPECTUS USER_PROVIDED_DATA_MATCH_REGISTER_OF_BOARD_MEMBERS USER_PROVIDED_DATA_MATCH_REGISTER_OF_MANAGERS USER_PROVIDED_DATA_MATCH_REGISTER_OF_PARTNERS USER_PROVIDED_DATA_MATCH_REGISTER_OF_TRUSTEES USER_PROVIDED_DATA_MATCH_SEGREGATED_PORTFOLIO_REGISTER USER_PROVIDED_DATA_MATCH_SERIES_DESIGNATION_SCHEDULE USER_PROVIDED_DATA_MATCH_SUB_FUND_REGISTER USER_PROVIDED_DATA_MATCH_OWNERSHIP_REGISTER USER_PROVIDED_DATA_MATCH_BANK_STATEMENT USER_PROVIDED_DATA_MATCH_AUTHORITY_TO_INVESTMENT USER_PROVIDED_DATA_MATCH_VERIFICATION_LETTER USER_PROVIDED_DATA_MATCH_PROOF_OF_LICENSE USER_PROVIDED_DATA_MATCH_AML_LETTER
Example
VALID_PROOF_OF_ADDRESS
results
required

Array of validation results for this validation type

Array<object>
object
key
required

The key of the validation check

string
Example
ENTITY_NAME_MATCHES_USER_INPUT
isValid
required

Boolean indicating if the validation check passed

boolean
Example
true
label
required

Human-readable description of the validation check

string
Example
Contains Balance Sheet
value
required
One of:
string
explanation

Optional explanation providing context for the validation result (e.g., why it passed despite minor differences)

string
nullable
Example
Company name matches (minor formatting difference: "TechGrowth Inc" vs "TechGrowth")
validationAttempts

Number of validation attempts for this document type (starts at 1, increments on each upload)

number
Example
2
jobId
string
metadata

Any JSON metadata associated with the document

object
hidden
required

Whether the document is hidden

boolean
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
notes
Array<object>
object
id
required
string
Example
507f1f77bcf86cd799439011
entityType
required
string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION
Example
APPLICATION
entityId
required
string
Example
507f1f77bcf86cd799439012
content
required
string
Example
Applicant confirmed ownership structure during call
createdBy
required
string
Example
60d5ecb54b24003a7c8e92b2
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
deleted
required
boolean
createdByUser
required
object
id
required
string
Example
60d5ecb54b24003a7c8e92b2
externalId
required
string
Example
auth0|507f1f77bcf86cd799439011
firstName
required
string
Example
John
lastName
required
string
Example
Smith
email
required
string
Example
john.smith@example.com
title
required
string
Example
Compliance Officer
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedByUser
required
object
id
required
string
Example
60d5ecb54b24003a7c8e92b2
externalId
required
string
Example
auth0|507f1f77bcf86cd799439011
firstName
required
string
Example
John
lastName
required
string
Example
Smith
email
required
string
Example
john.smith@example.com
title
required
string
Example
Compliance Officer
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
screeningHit

Related screening hit details

object
id
required
string
Example
507f1f77bcf86cd799439011
entityId

Entity ID (individualId or businessId)

string
Example
507f1f77bcf86cd799439012
type
required
string
Allowed values: ADVERSE_MEDIA SANCTIONS WARNING PEP
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
status
required
string
Allowed values: IN_REVIEW CONFIRMED DISMISSED NOT_REVIEWED TRUE_MATCH FALSE_POSITIVE
source
required
string
Example
comply-advantage
details
required

Raw screening hit details from the provider

object
updatedBy
string
Example
60d5ecb54b24003a7c8e92b2
enriched
required
boolean
Example
true
matchResult
object
isMatch
required
boolean
Example
true
confidence
required
number
Example
0.85
reviewNote
required
string
Example
Name and date of birth match the screening profile
incidentSummary
required
string
Example
Individual listed on OFAC SDN list since 2020 for involvement in money laundering activities
riskLevel
required
string
Example
HIGH
severity
string
nullable
categories
required
Array<object>
object
label
required
string
Example
Financial Crime
description

Concise (≤12 word) description of the risk type shown on the (i) hover

string
nullable
individualId
string
Example
507f1f77bcf86cd799439013
storyId

Id of the adverse-media story this hit belongs to.

string
nullable
notes
Array<object>
object
id
required
string
Example
507f1f77bcf86cd799439011
entityType
required
string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION
Example
APPLICATION
entityId
required
string
Example
507f1f77bcf86cd799439012
content
required
string
Example
Applicant confirmed ownership structure during call
createdBy
required
string
Example
60d5ecb54b24003a7c8e92b2
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
deleted
required
boolean
createdByUser
required
object
id
required
string
Example
60d5ecb54b24003a7c8e92b2
externalId
required
string
Example
auth0|507f1f77bcf86cd799439011
firstName
required
string
Example
John
lastName
required
string
Example
Smith
email
required
string
Example
john.smith@example.com
title
required
string
Example
Compliance Officer
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedByUser
required
object
id
required
string
Example
60d5ecb54b24003a7c8e92b2
externalId
required
string
Example
auth0|507f1f77bcf86cd799439011
firstName
required
string
Example
John
lastName
required
string
Example
Smith
email
required
string
Example
john.smith@example.com
title
required
string
Example
Compliance Officer
createdAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt
required
string format: date-time
Example
2026-03-30T12:00:00.000Z
assigneeId

ID of the user assigned to this task

string
Example
60d5ecb54b24003a7c8e92b2
reviewerId

ID of the user reviewing this task

string
Example
60d5ecb54b24003a7c8e92b2
createdAt
required

Date the task was created

string format: date-time
Example
2026-03-30T12:00:00.000Z
updatedAt

Date the task was last updated

string format: date-time
Example
2026-03-30T12:00:00.000Z
Example
{
  "id": "507f1f77bcf86cd799439011",
  "applicationId": "507f1f77bcf86cd799439011",
  "status": "PENDING",
  "type": "MISSING_DOCUMENT",
  "title": "Review proof of address document",
  "description": "Verify the uploaded utility bill matches the applicant address",
  "entityType": "DOCUMENT",
  "entityId": "507f1f77bcf86cd799439012",
  "document": {
    "id": "507f1f77bcf86cd799439011",
    "type": "PROOF_OF_ADDRESS",
    "subType": {},
    "title": "Proof of Address",
    "fileName": "utility_bill.pdf",
    "url": "https://storage.example.com/documents/utility_bill.pdf",
    "validations": [],
    "metadata": {},
    "hidden": false,
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:00:00.000Z",
    "notes": []
  },
  "screeningHit": {
    "id": "507f1f77bcf86cd799439011",
    "entityId": "507f1f77bcf86cd799439012",
    "type": {},
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:00:00.000Z",
    "status": {},
    "source": "comply-advantage",
    "details": {},
    "updatedBy": "60d5ecb54b24003a7c8e92b2",
    "enriched": true,
    "individualId": "507f1f77bcf86cd799439013",
    "storyId": "string",
    "notes": []
  },
  "assigneeId": "60d5ecb54b24003a7c8e92b2",
  "reviewerId": "60d5ecb54b24003a7c8e92b2",
  "createdAt": "2026-03-30T12:00:00.000Z",
  "updatedAt": "2026-03-30T12:00:00.000Z"
}

404

Section titled “404 ”

Task not found