Documents

Integrate document management capabilities into your application. Upload customer documents to financial planning purposes 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:
- benefits - Health insurance, retirement plans, benefit statements
- financial_plan - Existing financial plans, investment strategies
- employment - Pay stubs, W-2s, employment contracts
- partner - Spouse/partner financial documents
- business - Business tax returns, profit/loss statements
- personal - Tax returns, bank statements, personal financial records
- usr_msg - Supporting documents attached to customer messages
Name
file
Type
file
Description
The document file to upload. Supports PDF, DOC, DOCX, JPG, PNG, and other common document formats.

Request

POST

/documents

curl https://beta-api.uprise.us/documents \
  -H "Authorization: Bearer {token}" \
  -F "userId=b4a2954b-4a6e-47f8-8374-6e11bfa88ee8" \
  -F "category=personal" \
  -F "file=@/path/to/tax_document.pdf"

Response

{
  "id": "f42ed07e-0c4c-4922-b6e3-ffe681fff3e7",
  "userId": "b4a2954b-4a6e-47f8-8374-6e11bfa88ee8",
  "category": "personal",
  "fileName": "tax_document.pdf",
  "uploadedAt": "2024-01-15T10:30:00.000Z",
  "status": "uploaded"
}