SIsignalshq
Public Intake Requests

Update Client Notes (Public)

Add or update notes for a specific document item. Uses X-Intake-Token header. No authentication required.

patch/api/public/intake/items/{item_id}/notes

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    none declared. Required headers: X-Intake-Token

Path parameters

item_idstring uuid required

Headers

X-Intake-Tokenstring required

Secure intake token for document upload request

Request body

notesstring required

Notes to add or update for this document item

Example request

{
  "notes": "This is my W-2 from Acme Corporation"
}

Response

Successful Response

document_type'W2' | 'W2_AS' | 'W2_CM' | 'W2_GU' | 'W2_VI' | 'FORM_W2G' | 'FORM_W3' | 'FORM_1040' | 'FORM_1040_SCHEDULE_A' | 'FORM_1040_SCHEDULE_B' | 'FORM_1040_SCHEDULE_E' | 'FORM_1040_SCHEDULE_F' | 'FORM_1040_SENIOR' | 'FORM_1098' | 'FORM_1098_C' | 'FORM_1098_E' | 'FORM_1098_T' | 'FORM_1099_INT' | 'FORM_1099_A' | 'FORM_1099_B' | 'FORM_1099_CAP' | 'FORM_1099_CONSOLIDATED_STATEMENT' | 'FORM_1099_DIV' | 'FORM_1099_R' | 'FORM_1099_G' | 'FORM_1099_MISC' | 'FORM_1099_NEC' | 'FORM_1099_C' | 'FORM_1099_K' | 'FORM_1099_LTC' | 'FORM_1099_OID' | 'FORM_1099_PATR' | 'FORM_1099_QA' | 'FORM_1099_SA' | 'FORM_1099_Q' | 'FORM_1099_DA' | 'FORM_RRB_1099' | 'FORM_RRB_1099R' | 'FORM_1099_S' | 'FORM_1042_S' | 'FORM_8805' | 'FORM_8288_A' | 'FORM_1095_A' | 'FORM_1095_C' | 'FORM_SSA_1099' | 'FORM_2439' | 'FORM_3921' | 'FORM_3922' | 'FORM_5498' | 'FORM_5498_SA' | 'SCHEDULE_K1_GENERIC' | 'SCH_K1_1041' | 'SCH_K1_1065' | 'SCH_K1_1120S' | 'FORM_1041_SCHEDULE_K1' | 'FORM_1065_SCHEDULE_K1' | 'FORM_1120S_SCHEDULE_K1' | 'INVOICE' | 'RECEIPT' | 'TAX_FORM' | 'PROFIT_AND_LOSS_STATEMENT' | 'PROFIT_AND_LOSS_STATEMENT_BUSINESS' | 'PROFIT_AND_LOSS_STATEMENT_FARM' | 'PROFIT_AND_LOSS_STATEMENT_RENTAL' | 'INCOME_STATEMENT' | 'GENERAL_LEDGER' | 'TRIAL_BALANCE' | 'BALANCE_SHEET' | 'SCHEDULE_C_INPUT' | 'PREVIOUS_YEAR_RETURN' | 'BROKERAGE_STATEMENT' | 'ASSETS_PURCHASED_BUSINESS' | 'ASSETS_SOLD_BUSINESS' | 'ASSETS_PURCHASED_RENTAL' | 'ASSETS_SOLD_RENTAL' | 'ASSETS_PURCHASED_FARM' | 'ASSETS_SOLD_FARM' | 'MEDICAL_EXPENSES' | 'CHARITABLE_CONTRIBUTIONS_CASH' | 'CHARITABLE_CONTRIBUTIONS_NON_CASH' | 'PERSONAL_PROPERTY_TAXES' | 'SALES_AND_USE_TAXES' | 'VEHICLE_EXPENSES' | 'DAY_CARE_EXPENSES' | 'MAJOR_PURCHASES' | 'PROPERTY_TAX_STATEMENT' | 'ESTIMATED_TAX_PAYMENT_RECEIPTS' | 'CLOSING_STATEMENT_REAL_ESTATE' | 'PREVIOUS_YEAR_TAX_RETURNS' | 'TAX_RETURN' | 'TAX_ORGANIZER' | 'TAX_PLANNING' | 'REPAIRS_AND_IMPROVEMENTS_RENTAL' | 'PAYROLL_TAX_REPORT' | 'CLIENT_INTAKE_FORM' | 'GOVERNMENT_ISSUED_IDENTIFICATION' | 'IRS_NOTICE_OR_LETTER' | 'DEPENDENT_DOCUMENTATION' | 'FOREIGN_FINANCIAL_ACCOUNTS' | 'FOREIGN_INCOME_DOCUMENTATION' | '529_PLAN_STATEMENT' | '83B_ELECTION_STATEMENT' | 'SALES_BY_STATE_REPORT' | 'STATES_FILING_SALES_TAX_RETURNS' | 'VEHICLE_SELLER_REPORT' | 'HEALTH_INSURANCE_PREMIUM_STATEMENT' | 'BIRTH_CERTIFICATE' | 'DRIVERS_LICENSE' | 'DIRECT_DEPOSIT' | 'REGISTRATION_RENEWAL_NOTICE' | 'ENGAGEMENT_LETTER' | 'SERVICE_AGREEMENT' | 'CLIENT_NOTE' | 'BUNDLED_DOCUMENT' | 'OTHER_DOCUMENTS' | 'UNCATEGORIZED' | 'VESTING_STATEMENT' | 'EXERCISE_CONFIRMATION' | 'CLERGY_INFORMATION' | 'OTHER'
descriptionstring nullable

Additional instructions for this specific document type

notesstring nullable

Optional notes from CPA for this specific document type request

tagsstring[] nullable

Tags/instance names associated with this document item

is_optionalboolean

Whether this document is optional or required

is_additional_documentboolean

Whether this is an additional document added by the client

is_voluntary_documentboolean

Whether this is a voluntary document (no document type, not counted in totals)

extraction_enabledboolean

Whether to automatically start document extraction after upload for this specific item

max_files_per_iteminteger

Maximum number of files allowed for this specific document type

idstring uuid required

Unique identifier for the request item (scoped to this upload request only, validated via token on each request)

display_orderinteger required

Display order in the UI

status'DRAFT' | 'PENDING' | 'UPLOADED' | 'MAPPED' | 'ANSWERED' | 'SKIPPED' | 'REJECTED' required

Enum for intake request item status

edit_countinteger required

Number of times this item has been edited/reuploaded

client_notesstring nullable

Optional notes added by the client/user for this document item

document_type_labelstring nullable

Human-readable label for the document type (None for voluntary documents)

can_modifyboolean

Whether this item can still be modified (false if UPLOADED)

rejection_reasonstring nullable

Reason provided when rejecting this document item (only set when status is REJECTED)

created_atstring date-time required

When the item was created

updated_atstring date-time required

When the item was last updated

Example response

{
  "description": "Please upload all W-2 forms from 2024",
  "notes": "Client mentioned they will upload this next week",
  "tags": [
    "CORP - PERSON_ABC",
    "CHASE BANK"
  ],
  "client_notes": "This is my W-2 from Acme Corporation",
  "document_type_label": "W-2",
  "can_modify": true,
  "rejection_reason": "Document not available",
  "uploaded_documents": [
    {
      "document_matching": {
        "document_classification": "Form W-2",
        "document_type_identifier": "W2",
        "document_type_display_name": "Form W-2",
        "instance_name": "ACME Corporation",
        "document_classification_status": "COMPLETED"
      }
    }
  ]
}

Changes

No recorded changes to this operation across all 1 revision of this API.