evictions_send_intake_file

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

Use this when the person asks you to send a file (their lease, the tenant ledger, emails or messages with the tenant) to Evictions API before a case exists. Input: `filename`, `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/intake/files` with the person’s key) and optionally `purpose` and a short `note`. The file waits in the person’s inbox, where they start a case from it. Needs a live key: with a test key, create a test case and use evictions_add_case_document. Returns the file’s id, its type, the purpose guessed for it and when it leaves the inbox if no case is started from it. Each call sends one more file, but a repeat with the same `idempotencyKey` is safe (it returns the first answer). Do not use this when the case already exists (use evictions_add_case_document), and do not create the case yourself: the person starts it from the inbox. Needs the person’s account: sign-in or an API key.