Skip to content
Developers
Back to Steward

Get a specific task by ID

GET
/api/v1/tasks/{taskId}

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
taskId
required
string

Task ID

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Task retrieved successfully

Media type application/json
object
id
required

Task ID

string
applicationId
required

ID of the application this task belongs to

string
entityName
required

Display name of the entity that OWNS this task’s application: the business name for a business application, the individual’s full name for a person’s (e.g. a key person’s own application). Never the caller’s application; always the task’s.

string
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 COMPLIANCE_PRECONDITION_UNMET INTERNAL_REVIEW OWNERSHIP_DOCUMENT_REVIEW
title
required

Title of the task

string
description

Detailed description of the task

string
fieldKey

Profile field key for a missing-field review

string
entityType

Entity type the task relates to

string
Allowed values: DOCUMENT SCREENING_HIT APPLICATION PROFILE_FIELD INDIVIDUAL
entityId

ID of the related entity

string
documentFileName

File name of the document this task points at. Present when the task is about a document whose file name is known.

string
document

Related document details

object
id
required
string
type
required
string
originSystem
string
Allowed values: ONFIDO TRULIOO
subType
string
Allowed values: PASSPORT DRIVING_LICENSE ID_CARD
title
required
string
fileName
required
string
url
required

Freshly signed S3 URL. Null when the document has no underlying S3 object.

string
nullable
validations
required
Array<object>
object
type
required

The type of document validation

string
Allowed values: VALID_PROOF_OF_ADDRESS PERIODIC_REVIEW_REPORTED_CHANGE_MATCH 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_REGISTRY_EXTRACT USER_PROVIDED_DATA_MATCH_IRS_DETERMINATION_LETTER USER_PROVIDED_DATA_MATCH_W8 USER_PROVIDED_DATA_MATCH_W8_BEN_E USER_PROVIDED_DATA_MATCH_W8_IMY 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_GOOD_STANDING 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 USER_PROVIDED_DATA_MATCH_PROOF_OF_NET_ASSETS USER_PROVIDED_DATA_MATCH_CV_RESUME
results
required

Array of validation results for this validation type

Array<object>
object
key
required

The key of the validation check

string
isValid
required

Boolean indicating if the validation check passed

boolean
label
required

Human-readable description of the validation check

string
value
required
One of:
string
explanation

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

string
nullable
validationAttempts

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

number
jobId
string
supersededCheckKeys
required

Steward check keys superseded by an IDV vendor verdict on the same concern. Derived on read from the validations array, never persisted. The vendor is authoritative where the two overlap. Consumers must exclude these keys from pass/fail counts and hide them from display, while passing the underlying results back unchanged on write. The keys are a display and gating projection, never an instruction to delete stored data.

Array<string>
metadata

Any JSON metadata associated with the document

object
hidden
required

Whether the document is hidden

boolean
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
notes
Array<object>
object
id
required

Note ID

string
entityType
required

Type of parent entity this note belongs to

string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG
entityId
required

ID of the parent entity

string
content
required

Content of the note

string
attachments
required

File attachments

Array<object>
object
key
required

S3 key of the attachment

string
fileName
required

Original file name

string
contentType
required

MIME type of the file

string
fileUrl
required

URL to access the file

string
createdBy
required

ID of the user who created the note

string
updatedBy

ID of the user who last updated the note

string
createdByUser
required

User who created the note

object
firstName
required

First name of the user

string
lastName
required

Last name of the user

string
email
required

Email address of the user

string
updatedByUser

User who last updated the note

object
firstName
required

First name of the user

string
lastName
required

Last name of the user

string
email
required

Email address of the user

string
createdAt
required

Date the note was created

string format: date-time
updatedAt
required

Date the note was last updated

string format: date-time
stewardOnly
required

True when the note was written as Steward-only and stays off the client feed. Customer writes cannot set it.

boolean
sourceLabel

Label for the parent entity, for cross-entity listings that render notes from several sources in one feed. The document file name for DOCUMENT notes, “Screening” for SCREENING_HIT notes, the annotated event headline for AUDIT_LOG notes, null for APPLICATION notes. Only populated by the by-application listing.

string
nullable
sourceLinkId

ID the client needs to navigate back to the note’s source. The document ID for DOCUMENT notes; for SCREENING_HIT notes the screened entity (individual or business) ID, which is what the Screening tab keys its deep link on, not the hit ID; for AUDIT_LOG notes the audit entry ID, which the Audit Log tab opens off ?auditLogId=. Null for APPLICATION notes. Only populated by the by-application listing.

string
nullable
screeningHit

Related screening hit details

object
id
required
string
entityId

Entity ID (individualId or businessId)

string
type
required
string
Allowed values: ADVERSE_MEDIA SANCTIONS WARNING PEP
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
status
required
string
Allowed values: IN_REVIEW CONFIRMED DISMISSED NOT_REVIEWED TRUE_MATCH FALSE_POSITIVE
source
required
string
details
required

Raw screening hit details from the provider

object
updatedBy
string
enriched
required
boolean
matchResult
object
isMatch
required
boolean
confidence
required
number
reviewNote
required
string
matchExplanation
string
incidentSummary
required
string
riskLevel
required
string
severity
string
nullable
tierRationale
string
nullable
clearedReason

Why an automated pass cleared this hit, as a discrete value. Null while the hit is not cleared, on a reviewer’s own ruling, and on hits cleared before the reason was stored.

string
Allowed values: IDENTITY_MISMATCH NOTHING_ADVERSE_REPORTED SEARCH_RESULT_NOT_IDENTIFIED SOURCE_PAGE_UNREADABLE CONFIDENCE_BELOW_THRESHOLD NOMINAL_ROLE
categories
required
Array<object>
object
label
required
string
description

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

string
nullable
note
string
nullable
individualId
string
groupId

Id of the screening group this hit belongs to.

string
nullable
storyId

Deprecated alias for groupId on adverse-media hits.

string
nullable
notes
Array<object>
object
id
required
string
entityType
required
string
Allowed values: APPLICATION SCREENING_HIT DOCUMENT WORKFLOW_VERSION AUDIT_LOG
entityId
required
string
content
required
string
createdBy
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
deleted
required
boolean
createdByUser
required
object
id
required
string
externalId
required
string
firstName
required
string
lastName
required
string
email
required
string
title
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
updatedByUser
required
object
id
required
string
externalId
required
string
firstName
required
string
lastName
required
string
email
required
string
title
required
string
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
origin

Which screen raised this hit. Null for hits written before origin was recorded.

string
Allowed values: INITIAL_SCREENING ONGOING_MONITORING
reviewedHitIds

For a screening review: every screening hit it covers, meaning the hit it points at, its story group, and the other hits of the same identity decision. Resolving the review resolves them all.

Array<string>
assigneeId

ID of the user assigned to this task

string
reviewerId

ID of the user reviewing this task

string
resolutionNote

Why a reviewer accepted this review. Recorded when it is resolved from the product; absent on auto-resolved reviews.

string
resolvedByName

Name of the user who resolved this review from the product

string
createdAt
required

Date the task was created

string format: date-time
updatedAt

Date the task was last updated

string format: date-time
Examples
{
  "id": "507f1f77bcf86cd799439011",
  "applicationId": "507f1f77bcf86cd799439011",
  "entityName": "Acme Corporation",
  "status": "PENDING",
  "type": "DOCUMENT_VALIDATION_FAILED",
  "title": "Review Proof of Address",
  "description": "Failed 1 check: Valid Address.",
  "entityType": "DOCUMENT",
  "entityId": "507f1f77bcf86cd799439012",
  "documentFileName": "source-of-wealth.pdf",
  "document": {
    "id": "507f1f77bcf86cd799439012",
    "type": "PROOF_OF_ADDRESS",
    "subType": null,
    "title": "Proof of Address",
    "fileName": "utility_bill.pdf",
    "url": "https://storage.example.com/documents/utility_bill.pdf",
    "validations": [
      {
        "type": "VALID_PROOF_OF_ADDRESS",
        "results": [
          {
            "key": "validAddress",
            "isValid": false,
            "label": "Valid Address",
            "value": "Acme Corporation, 123 Main Street, London EC1A 1BB",
            "explanation": "Addressed to a business, not to the individual at a residential address."
          }
        ],
        "validationAttempts": 2,
        "jobId": "3f6c2a9e-8b1d-4c7a-9e2f-5d4b1a6c8e03"
      }
    ],
    "supersededCheckKeys": [],
    "metadata": {},
    "hidden": false,
    "createdAt": "2026-03-30T12:00:00.000Z",
    "updatedAt": "2026-03-30T12:00:00.000Z",
    "notes": [
      {
        "id": "507f1f77bcf86cd799439011",
        "entityType": "DOCUMENT",
        "entityId": "507f1f77bcf86cd799439012",
        "content": "Applicant confirmed ownership structure during call",
        "attachments": [
          {
            "key": "uploads/uuid_document.pdf",
            "fileName": "document.pdf",
            "contentType": "application/pdf",
            "fileUrl": "https://bucket.s3.amazonaws.com/uploads/uuid_document.pdf"
          }
        ],
        "createdBy": "60d5ecb54b24003a7c8e92b2",
        "updatedBy": "60d5ecb54b24003a7c8e92b2",
        "createdByUser": {
          "firstName": "John",
          "lastName": "Smith",
          "email": "john.smith@example.com"
        },
        "updatedByUser": {
          "firstName": "John",
          "lastName": "Smith",
          "email": "john.smith@example.com"
        },
        "createdAt": "2026-03-30T12:00:00.000Z",
        "updatedAt": "2026-03-30T12:00:00.000Z",
        "stewardOnly": false,
        "sourceLabel": null,
        "sourceLinkId": null
      }
    ]
  },
  "reviewedHitIds": [
    "string"
  ],
  "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