Move a waiting file of the intake inbox onto a live case as a document of `purpose`, as an upload of the same file would be (the same checks apply: 409 `invalid_state` once a case is submitted, except `purpose: "other"`). The text of a forwarded email (`text/plain`) moves only as `correspondence`; any other purpose answers 415 `unsupported_media_type`. The file leaves the inbox. Moving a file already moved onto this case answers 200 with the same document; a test case answers 422 `live_only`

post/v1/cases/{id}/documents/from-intake

Request

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

Path parameters

idstring required

Request body

intakeFileIdstring required
purpose'lease' | 'ledger' | 'correspondence' | 'other' required

Response

The new document (200: the file was already moved onto this case, and this is its 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.