SIsignalshq
DOCUMENT

Set whose document this is (taxpayer / spouse / joint)

Records the CPA's decision about which person on a joint return a document belongs to. A manual edit LOCKS the value: no later system write — resolver or backfill — may overwrite it. Rejects a role the document's type does not permit (a W-2 has one employee; an IRA has exactly one owner under IRC 408(a)), and rejects the v2-reserved roles. Joint returns only.

patch/internal/api/document/{document_id}/party

Request

  • Base URL
    https://api.signalshq.io (the document declares no server; this is the origin it was published from)
  • Auth
    OAuth 2
    Password
    Token URL: /auth/login

Path parameters

document_idstring uuid required

Document to attribute

Request body

client_idstring uuid required

Client ID for the document

party_rolestring nullable required

TAXPAYER | SPOUSE | JOINT, or null to clear back to undecided. Rejected when the document's type does not permit the role, or when it is a v2-reserved role (DEPENDENT / NOT_ON_RETURN).

Example request

{
  "party_role": "SPOUSE"
}

Response

Successful Response

applied_countinteger required
skipped_countinteger required

Example response

{
  "outcomes": [
    {
      "reason": "FORM_5498 does not permit JOINT"
    }
  ]
}

Changes

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