Skip to content
Developers
Back to Steward

Get document

GET
/api/v1/documents/{documentId}

Get document details and validation status

Authorizations

Section titled “ Authorizations ”

Parameters

Section titled “ Parameters ”

Path Parameters

Section titled “ Path Parameters ”
documentId
required
string

Responses

Section titled “ Responses ”

200

Section titled “ 200 ”

Document details with validation status

Media type application/json
object
id
required
string
type
required
string
Allowed values: COMPANY_PROFILE ARTICLES_OF_INCORPORATION ARTICLES_OF_ASSOCIATION MEM_AND_ARTS STATUTS REGISTER_OF_DIRECTORS REGISTER_OF_SHAREHOLDERS LISTE_DES_ASSOCIES REGISTER_OF_BENEFICIARIES SOURCE_OF_WEALTH SOURCE_OF_FUNDS SIGNATURE ID_CARD ID_CARD_BACK PROOF_OF_ADDRESS STRUCTURE_CHART PARTNERSHIP_AGREEMENT REGISTER_OF_MEMBERS TRUST_DEED CERTIFICATE_OF_TRUST DEED_OF_APPOINTMENT_OF_TRUSTEES DEED_OF_APPOINTMENT_OF_BENEFICIARIES COUNCIL_REGISTER FOUNDATION_CHARTER FOUNDATION_STATUTES REGISTER_OF_BOARD_MEMBERS REGISTER_OF_BOARD_COUNCIL_MEMBERS CAP_TABLE ORG_CHART PERIODIC_REVIEW_FORM CDD_FORM SHAREHOLDERS_AGREEMENT FINANCIAL_STATEMENTS BUDGET_USE_OF_FUNDS AUTHORISED_SIGNATORY_LIST POWERS_OF_ATTORNEY INVESTMENT_MEMO COMPANY_DECK UBO_REGISTER_EXTRACT RBE CERTIFICATE_OF_REGISTRATION CERTIFICATE_OF_FORMATION CERTIFICATE_OF_GOOD_STANDING CERTIFICATE_OF_LIMITED_PARTNERSHIP REGISTER_OF_PARTNERS REGISTER_OF_MANAGERS OPERATING_AGREEMENT CORPORATE_BYLAWS SERIES_DESIGNATION_SCHEDULE REGISTER_OF_TRUSTEES CONSTITUTION COMPANY_REGISTRY_EXTRACT K_BIS_EXTRACT CELL_REGISTER SEGREGATED_PORTFOLIO_REGISTER SUB_FUND_REGISTER PROSPECTUS AIFM_APPOINTMENT_PROOF CONSTITUTIONAL_DOCUMENT AML_REPRESENTATION UBO_LETTER W_8 W_8_BEN_E W_8_IMY W_9 SUBSCRIPTION_AGREEMENT INVESTOR_INFORMATION_FORM CORPORATE_RESOLUTION INVESTMENT_MANAGEMENT_AGREEMENT CERTIFICATE_OF_INCUMBENCY SIGNED_DIRECTOR_REGISTER FINANCIAL_FORECAST CHANGE_OF_NAME SOURCE_OF_FUNDS_WEALTH_DECLARATION FATCA_CRS_DECLARATION PROOF_OF_REGULATION SPECIMEN_SIGNATURES OWNERSHIP_CHART TRANSACTION_AUTHORISATION_LETTER AUTHORISED_TO_ACT_RESOLUTION PROOF_OF_GUARDIANSHIP_CUSTODIAN PROOF_OF_PLAN PROOF_OF_LISTING PROOF_OF_OWNERSHIP_BY_LISTED_COMPANY TEN_K_EXHIBIT_21 OFFERING_DOCUMENT AML_LETTER OFFICIAL_WEBSITE_EXTRACT_PURPOSE WILL_OR_LETTER_OF_ADMINISTRATION DEATH_CERTIFICATE GRANT_OF_PROBATE PENSION_PLAN COUNCIL_APPROVAL_TO_INVEST PROOF_OF_NON_PROFIT_STATUS OWNERSHIP_REGISTER SCREENING_REPORT BANK_STATEMENT AUTHORITY_TO_INVESTMENT LIVENESS STEWSIGN_DOCUMENT VERIFICATION_LETTER ACCREDITATION_PROOF PROOF_OF_NET_ASSETS CV_RESUME PROOF_OF_LICENSE REGISTRY_EXTRACT IRS_DETERMINATION_LETTER ONGOING_SCREENING_RECORD AUDIT_LOG COMPLIANCE_APPROVAL RISK_ASSESSMENT PAYMENT_INSTRUCTION CAPITAL_CALL_NOTICE CONTACT_LIST CORRESPONDENCE COVER_PAGE NOMINEE_DECLARATION CERTIFICATE_OF_REDOMICILIATION OTHER
originSystem
string
Allowed values: ONFIDO TRULIOO
subType
string
Allowed values: PASSPORT DRIVING_LICENSE ID_CARD
title
required

Human-readable label for the document type

string
fileName
required
string
key
required
string
contentType
required
string
url
required

Freshly signed S3 URL (re-signed on every read, ~7-day TTL). Null when the document has no underlying S3 object.

string
nullable
hidden
required
boolean
hiddenSource
required

Who hid the document: CLIENT when it was hidden from the platform or through the API, STEWARD when Steward hid it. Null while the document is visible. A hidden document with no recorded source reports STEWARD.

string
Allowed values: CLIENT STEWARD
replaced
required

True when a newer version of this document (a later-expiring ID card, a later proof of address, a later-signed tax form or FATCA/CRS declaration about the same subject) has passed all its checks and replaces it. A replaced document raises no review; its check results are unchanged.

boolean
applicationId
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

JSON metadata associated with the document

object
subject

The chain entity this document is about, when it is not the applicant. Stamped at submission from the same resolution the onboarding profile drawer files chain documents by; null for the applicant’s own documents and for any document uploaded outside a dynamic onboarding.

object
entityKey
required

Stable ownership key for the entity: entityType|lowercased name.

string
name
required

The entity name as the source document stated it.

string
entityType
required
string
Allowed values: business individual
createdAt
required
string format: date-time
updatedAt
required
string format: date-time
notes
required

Notes attached to the document

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
arrival
required

When in the relationship this document arrived. Derived on read from the request or review it is stamped with, or the review cycle its upload fell inside; never stored, so every document ever uploaded carries one.

string
Allowed values: initial_onboarding periodic_review additional_info_request
duplicateOf

The earlier, byte-identical copy this document duplicates. Null when it is the first of its bytes on the application.

object
documentId
required
string
fileName
required
string
createdAt
required
string format: date-time
supersededBy

The document that replaced this one. Only ever present on a row returned by includeSuperseded.

object
documentId
required
string
additionalInfoRequest

The additional-information request this document answers, when it answers one.

object
requestId
required
string
itemId
string
nullable
reason

Why the reviewer asked, as recorded on the request.

string
nullable
requestedByName
string
nullable
ownerLabel

Who the ask was about, when it named someone other than the applicant.

string
nullable
addedBy

The platform user who uploaded this document. Null for anything an applicant supplied.

object
userId
required
string
name
required
string
workflowOrder

Position of this document’s type in the order the application’s workflow asks for its documents. Null when the workflow names no order or does not name this type. The client sorts those last.

number
nullable
Examples
{
  "id": "507f1f77bcf86cd799439011",
  "type": "PROOF_OF_ADDRESS",
  "originSystem": null,
  "subType": null,
  "title": "Proof of Address",
  "fileName": "utility_bill.pdf",
  "key": "documents/utility_bill.pdf",
  "contentType": "application/pdf",
  "url": "https://storage.example.com/documents/utility_bill.pdf",
  "hidden": false,
  "hiddenSource": null,
  "replaced": false,
  "applicationId": "507f1f77bcf86cd799439012",
  "validations": [
    {
      "type": "VALID_PROOF_OF_ADDRESS",
      "results": [
        {
          "key": "validAddress",
          "isValid": true,
          "label": "Valid Address",
          "value": "John Smith, 123 Main Street, London EC1A 1BB",
          "explanation": "Individual addressee at a residential address, not a PO box or business address."
        }
      ],
      "validationAttempts": 2,
      "jobId": "3f6c2a9e-8b1d-4c7a-9e2f-5d4b1a6c8e03"
    }
  ],
  "supersededCheckKeys": [],
  "metadata": {},
  "subject": null,
  "createdAt": "2026-03-30T12:00:00.000Z",
  "updatedAt": "2026-03-30T12:00:00.000Z",
  "notes": [
    {
      "id": "507f1f77bcf86cd799439011",
      "entityType": "DOCUMENT",
      "entityId": "507f1f77bcf86cd799439011",
      "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
    }
  ],
  "arrival": "initial_onboarding",
  "duplicateOf": null,
  "supersededBy": null,
  "additionalInfoRequest": null,
  "addedBy": null,
  "workflowOrder": null
}

404

Section titled “ 404 ”

Document not found