SIsignalshq
CLIENT
Intake Requests

Upload Document for Intake Request Item

Upload a document for a specific intake request item (CPA dashboard). Allows CPAs to upload documents on behalf of clients.

post/internal/api/clients/{client_id}/intake-requests/{request_id}/upload

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

request_idstring uuid required
client_idstring uuid required

Client ID

Request body multipart/form-data

filestring binary required

Document file to upload

item_idstring uuid required

ID of the specific request item being fulfilled

notesstring nullable

Optional notes about this 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.