Upload evidence for a draft case: a PDF, JPEG or PNG, decided by the file's contents (415 `unsupported_media_type` otherwise, for a live case). A `correspondence` document may also be plain UTF-8 text, such as the body of a forwarded email, stored as `text/plain`. For a live case, `purpose: "other"` files can also be added after submission, until the case is finished

post/v1/cases/{id}/documents

Request

  • Base URL: https://api.evictionsapi.com
  • URL: https://api.evictionsapi.com/v1/cases/{id}/documents
  • Auth: one of:
    • HTTP bearer
    • HTTP bearer

Path parameters

idstring required

Request body

filenamestring required
purpose'authority' | 'prior_notice' | 'prior_notice_proof' | 'other' | 'lease' | 'ledger' | 'correspondence' required
contentBase64string required

Response

The stored document.

idstring required
kind'evidence' | 'notice' | 'filing' | 'proof' | 'other' required
specIdstring nullable
purposeunknown
filenamestring required
contentType'application/pdf' | 'image/jpeg' | 'image/png' | 'text/plain'

Decided from the file's first bytes when it was stored, never from its name. text/plain only for a correspondence document that is plain text (the body of a forwarded email).

contentHashstring required

SHA-256 of the document bytes. An attorney approval names these.

createdAtstring date-time

Changes

No recorded changes to this operation across all 1 revision of this API.