SIsignalshq
Public Intake Requests

Upload Voluntary Document (Public)

Upload a document voluntarily without document type. These documents are not counted in request totals. Uses X-Intake-Token header. No authentication required.

post/api/public/intake/voluntary-documents

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

Request body multipart/form-data

filestring binary required

Document file to upload

descriptionstring nullable

Description of the voluntary document

Response

Successful Response

successboolean

Whether the upload was successful

messagestring required

Success message

item_idstring uuid required

ID of the request item that was uploaded

document_idstring uuid required

ID of the uploaded document

document_namestring required

Name of the uploaded document

file_sizeinteger required

Size of the uploaded file in bytes

uploaded_atstring date-time required

When the document was uploaded

Example response

{
  "message": "Document uploaded successfully",
  "request_info": {
    "request_title": "2024 Tax Documents",
    "completed_items": 2,
    "total_items": 3,
    "remaining_items": 1,
    "uploaded_items": 2,
    "status": "ACTIVE",
    "can_submit": true
  }
}

Changes

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