Documents Overview
The Documents API gives integrations controlled access to files uploaded to a household — applicant paystubs, identification, letters and other supporting documents. Documents are uploaded through the resident portal and listed per household; this section covers reading a document’s contents.
Key Concepts
Signed download URLs
Document bytes never travel through the API. Instead you request a short-lived signed URL and fetch the file directly with a plain GET and no auth header. URLs expire after 300 seconds by default (900 maximum) and every issued URL is access-logged, so pass the requirementId when you are reviewing a requirement.
Related endpoints
Documents are created and listed per household through /households/{householdId}/documents in the Households section.