Logo

Documents

Integrate document management capabilities into your application. Upload customer documents, associate them with the relevant record such as a tax return or plan, and retrieve them when needed.

GET/documents/:docId

Get document details

This endpoint retrieve the uploaded document details and file content by its Document ID.

Required attributes

  • Name
    docId
    Type
    string
    Description

    The unique document identifier returned when the document was originally uploaded.

Request

GET
/documents/:docId
curl https://beta-api.uprise.us/documents/f42ed07e-0c4c-4922-b6e3-ffe681fff3e7 \
  -H "Authorization: Bearer {token}"

Response

{
  "id": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7",
  "type": "image/png",
  "name": "plan_image.png",
  "content": "iVBORw0KGgoAAAANSUhEUgAABd4AAAOICAYAAADID+OCAAAMPmlDQ1BJQ0MgUHJvZmlsZQAASImVVwdYU8kWnluSkJDQAghICb0JIjWAlBBaAOndRkgChBJjIKjYkUUF14KKBWzoqohip9kRO4ti74sFFWVdLNiVNymg677yvfN9c+9//znznzPnzi0DgPpxrlici2oAkCcqkMSGBDCSU1IZpKcAAQRABTbAjMvLF7OioyMAtMHz3+3ddegN7YqDTOuf/f/VNPmCfB4ASDTE6fx8Xh7EBwDAq3liSQEARBlvPqVALMOwAW0JTBDiBTKcqcDVMpyuwHvkPvGxbIjbAFChcrmSTADULkGeUcjLhBpqfRA7ifhCEQDqDIh98/Im8SFOg9gG+oghlukz03/QyfybZvqQJpebOYQVc5GbSqAwX5zLnfZ/luN/W16udDCGFWzULElorGzOsG43cyaFyzAV4l5RemQUxFoQfxDy5f4Qo5QsaWiCwh815OWzYc2ALsROfG5gOMSGEAeLciMjlHx6hjCYAzFcIehUYQEnHmI9iBcI8oPilD4bJZNilbHQhgwJm6Xkz3Il8riyWPelOQkspf7rLAFHqY+pFWXFJ0FMgdiiUJgYCbEaxI75OXHhSp/RRVnsyEEfiTRWlr8FxLECUUiAQh8rzJAExyr9y/LyB+eLbcwSciKVeF9BVnyooj5YG48rzx/OBbskELESBnUE+ckRg3PhCwKDFHPHnglECXFKnQ/igoBYxVicIs6NVvrjZoLcEBlvBrFrfmGcciyeWAAXpEIfzxAXRMcr8sSLsrlh0Yp88KUgArBBIGAAKWzpYBLIBsKO3sZeeKXoCQZcIAGZQAAclMzgiCR5jwge40AR+BMiAcgfGhcg7xWAQsh/HWIVRweQIe8tlI/IAU8gzgPhIBdeS+WjREPREsFjyAj/EZ0LGw/mmwubrP/”
}
POST/documents

Upload a document

This endpoint is used to upload a file to the system and returns a unique document ID that can be used to reference the uploaded file in future operations.

Required attributes

  • Name
    userId
    Type
    string
    Description

    The ID of the customer

  • Name
    category
    Type
    string
    Description

    Document category for organization and processing. Choose the most appropriate category:

    • tax_return - Prior-year or filed tax returns (personal or business)
    • tax_source - Income and deduction source forms: W-2s, 1099s, K-1s, 1098s, brokerage tax forms
    • business_financials - P&L statements, balance sheets, payroll summaries, depreciation schedules
    • tax_notice - IRS or state tax notices and correspondence
    • identity - Driver's license, SSN documentation, IP PIN, and similar identity/verification documents
    • benefits - Health insurance, retirement plan, and benefit statements
    • financial_plan - Existing financial plans and investment strategies
    • personal_financial - Bank statements, account summaries, and other personal financial records
    • usr_msg - Supporting documents attached to customer messages
    • other - Anything that does not fit the categories above
  • Name
    file
    Type
    file
    Description

    The document file to upload. Supports PDF, DOC, DOCX, JPG, PNG, and other common document formats.

Optional attributes

These attributes link an uploaded document to the parent record it belongs to (for example, attaching a W-2 to a specific tax return). They describe which record the document is filed under and are unrelated to business entity type.

  • Name
    associatedRecordType
    Type
    string
    Description

    The type of record this document is attached to. One of: tax_return, plan, meeting, message.

  • Name
    associatedRecordId
    Type
    string
    Description

    The id of the record the document is attached to. Required when associatedRecordType is provided.

Request

POST
/documents
curl https://beta-api.uprise.us/documents \
  -H "Authorization: Bearer {token}" \
  -F "userId=b4a2954b-4a6e-47f8-8374-6e11bfa88ee8" \
  -F "category=tax_source" \
  -F "associatedRecordType=tax_return" \
  -F "associatedRecordId=5c59c810-3aaf-4995-b736-bd324aef45af" \
  -F "file=@/path/to/w2.pdf"

Response

{
  "id": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7",
  "userId": "b4a2954b-4a6e-47f8-8374-6e11bfa88ee8",
  "category": "tax_source",
  "associatedRecordType": "tax_return",
  "associatedRecordId": "5c59c810-3aaf-4995-b736-bd324aef45af",
  "fileName": "w2.pdf",
  "uploadedAt": "2026-01-15T10:30:00.000Z",
  "status": "uploaded"
}
POST/documents/tax-returns/:taxReturnId

Upload a document for a tax return

This endpoint uploads a file and attaches it to a specific tax return. Use this when linking source documents (such as a W-2 or 1099) directly to an in-progress tax filing.

Required attributes

  • Name
    taxReturnId
    Type
    string
    Description

    The unique id of the tax return to attach the document to.

  • Name
    userId
    Type
    string
    Description

    The ID of the customer who owns the tax return.

  • Name
    category
    Type
    string
    Description

    Document category for organization and processing. Choose the most appropriate category:

    • tax_return - Prior-year or filed tax returns (personal or business)
    • tax_source - Income and deduction source forms: W-2s, 1099s, K-1s, 1098s, brokerage tax forms
    • business_financials - P&L statements, balance sheets, payroll summaries, depreciation schedules
    • tax_notice - IRS or state tax notices and correspondence
    • identity - Driver's license, SSN documentation, IP PIN, and similar identity/verification documents
    • benefits - Health insurance, retirement plan, and benefit statements
    • financial_plan - Existing financial plans and investment strategies
    • personal_financial - Bank statements, account summaries, and other personal financial records
    • usr_msg - Supporting documents attached to customer messages
    • other - Anything that does not fit the categories above
  • Name
    file
    Type
    file
    Description

    The document file to upload. Supports PDF, DOC, DOCX, JPG, PNG, and other common document formats.

Request

POST
/documents/tax-returns/:taxReturnId
curl https://beta-api.uprise.us/documents/tax-returns/5c59c810-3aaf-4995-b736-bd324aef45af \
  -H "Authorization: Bearer {token}" \
  -F "userId=b4a2954b-4a6e-47f8-8374-6e11bfa88ee8" \
  -F "category=tax_source" \
  -F "file=@/path/to/w2.pdf"

Response

{
  "docId": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7"
}