evictions_add_case_document

io.github.evictionsapi/evictions-api · Verify this server

Use this when the person asks you to add a document to a draft case: the lease, the tenant ledger, emails or messages with the tenant, proof that they own or manage the property, or a notice already served and its proof of service. Input: the case `id`, `filename`, `purpose` and `contentBase64` (a PDF, JPEG or PNG of about 700 KB at most through this server; a file up to 4 MB goes through `POST /v1/cases/{id}/documents` with the person’s key). Adds the document to the case; each call adds one more, but a repeat with the same `idempotencyKey` is safe (it returns the first answer). Works on a draft; after a live case is submitted, only a document with the purpose `other` can be added. Returns the document as stored. Do not use this when no case exists yet (use evictions_send_intake_file) or to change the case’s facts (use evictions_update_case). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.