Skip to main content
POST
/
api
/
v1
/
tax-home-docs
/
upload-url
Get Tax Home Doc Upload URL
curl --request POST \
  --url https://api.example.com/api/v1/tax-home-docs/upload-url \
  --header 'Content-Type: application/json' \
  --data '
{
  "doc_type": "<string>",
  "month": 123,
  "year": 123,
  "file_name": "<string>",
  "content_type": "<string>",
  "file_size": 123
}
'
{
  "uploadUrl": "https://s3.amazonaws.com/bucket/tax-home-docs/1/...",
  "s3Key": "tax-home-docs/1/rent-jan-2025.pdf"
}

Request Body

doc_type
string
required
Document type: rent_receipt or utility_bill.
month
integer
required
Month (1–12).
year
integer
required
Year (YYYY).
file_name
string
required
Original file name.
content_type
string
required
MIME type: application/pdf, image/jpeg, or image/png.
file_size
integer
required
File size in bytes (1–10MB).

Response

{
  "uploadUrl": "https://s3.amazonaws.com/bucket/tax-home-docs/1/...",
  "s3Key": "tax-home-docs/1/rent-jan-2025.pdf"
}