SIsignalshq
Public Intake Requests

Get Intake Request Details (Public)

Get details about an intake request using the secure token from X-Intake-Token header. No authentication required.

get/api/public/intake

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

Headers

X-Intake-Tokenstring required

Secure intake token for document upload request

Response

Successful Response

request_titlestring required

Title of the upload request

instructionsstring nullable

General instructions

tax_yearstring nullable

Tax year

expires_atstring date-time required

When the upload link expires

status'DRAFT' | 'EMAIL_SENT' | 'ACTIVE' | 'COMPLETED' | 'EXPIRED' | 'REVOKED' required

Enum for intake request status

max_edits_per_iteminteger required

Maximum number of edits/reuploads allowed per item

completion_ratenumber required

Completion rate as a decimal (0.0 to 1.0, e.g., 0.2 for 20%)

completion_statusstring required

Completion status: 'Pending', 'In Progress', or 'Completed'

total_documentsinteger required

Total number of documents requested

completed_documentsinteger required

Number of documents completed/uploaded

pending_documentsinteger required

Number of documents still pending

rejected_documentsinteger

Number of documents rejected by user

questionnaire_from_pyrstring nullable

Questionnaire processing status for previous year return (if applicable for this intake request)

document_checklist_suggestionstring nullable

Document checklist processing status for previous year return (if applicable for this intake request)

Example response

{
  "completion_rate": 0.2,
  "completion_status": "In Progress",
  "total_documents": 8,
  "completed_documents": 2,
  "pending_documents": 6,
  "items": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "additional_documents": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "voluntary_documents": [
    {
      "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"
          }
        }
      ]
    }
  ],
  "questionnaire_from_pyr": "COMPLETED",
  "document_checklist_suggestion": "COMPLETED"
}

Changes

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