Evictions API

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.

Use this when the person wants to start an eviction case and has given you its facts: the ground, where the case starts, the property, the parties and their own attestations. Creates a draft case in the person’s account. Nothing is submitted. Add its documents with evictions_add_case_document. Pass an `idempotencyKey` and reuse it if you repeat the call, so a retry never makes a second case. For a property manager, `landlordId` (from evictions_list_landlords) names the owner the case is for and adds its saved management agreement to the case. Do not use this to change a case that already exists (use evictions_update_case). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.

Use this when you need one case in full: where it stands and what it is waiting on. Input: the case `id`. Returns its facts, deadlines, documents and, for a live case, the attorney once recorded. Do not use this to find a case whose id you do not have (use evictions_list_cases) or for its history (use evictions_get_case_events). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Needs the person’s account: sign-in or an API key.

Use this when the person asks what has happened on a case so far. Input: the case `id`. Returns the events the person may see, oldest first, each with what happened, the state before and after, and when. Do not use this for where the case stands now (use evictions_get_case) or for messages (use evictions_list_case_messages). Needs the person’s account: sign-in or an API key.

Use this when the person wants to pay a due charge on a case. Input: the case `id` and the `chargeId` from evictions_list_case_charges. Opens a hosted checkout for one due charge and returns its URL; asked again while that checkout is open, it returns the same URL. Give the URL to the person: paying is theirs to do, and no tool takes card details. Refused when the charge is not due or online payment is off. Do not use this to see whether a charge is paid (use evictions_list_case_charges). Needs the person’s account: sign-in or an API key.

Use this when the person asks what a case costs or about refunds. Takes no input. Returns the platform fee, the costs that are separate from it and the refund rule, word for word as the pricing page says them, with its link. Do not use this for the charges already on a case (use evictions_list_case_charges). No key needed.

Use this when the person asks what Evictions API is, what is available today, how a real case is handled or who operates it. Takes no input. Returns the service’s description, its current status and who operates it, in the site’s own words, with links to the home and how-it-works pages. Do not use this for fees (use evictions_get_pricing) or for one state’s rules (use evictions_get_state_eviction_facts). No key needed.

Use this when the person has no account or key yet, or asks how to connect an agent. Takes no input. Returns the sign-up link, what test and live keys are, how this MCP server is reached and signed in to, and the links to the docs and the OpenAPI document. Do not use this to check a key the person already has: any tool that works with cases says so when its key is missing or refused. No key needed.

Use this when the person asks how eviction works in one state, such as the notice for nonpayment of rent or the court. Input: `state`, as a two-letter code, a name or a slug. Returns the page’s opening answer and only the facts published as verified and sourced for that state, each with its citation, source link, the date it was checked and a short quote of the cited text where there is one (a fact checked more than 90 days ago is left out), plus the state’s page and a notice that this is general information, not legal advice; a state with none says so. Do not use this for whether a case can be opened at an address (use evictions_resolve_jurisdiction) or for advice on a particular case. No key needed.

Use this when the person asks what they owe on a case or whether a charge is paid. Input: the case `id`. Returns the charges on a case, oldest first, each with its id, kind, amount in cents and status (due, paid, void or refunded), and whether online payment is available. Do not use this for the published prices (use evictions_get_pricing). Next: evictions_get_payment_link for a due charge. Needs the person’s account: sign-in or an API key.

Use this when the person asks whether the Evictions API team has written about a case, or before writing to it. Input: the case `id`. Returns the messages on a case, the person’s own and the team’s, oldest first, each with its author, text and time. Do not use this for the case’s events (use evictions_get_case_events). Next: evictions_send_case_message to reply. Needs the person’s account: sign-in or an API key.

Use this when you need the person’s cases, or the id of a case you do not have. Input: optional `limit` and `cursor`, and `landlordId` for only one landlord’s cases (`none` for the cases with no landlord). Returns the cases of the key’s organization and mode (test or live), newest first, a page at a time, each with its `state` and `nextAction`, and `nextCursor` for the next page (null on the last). Do not use this when you already have the case id (use evictions_get_case). Needs the person’s account: sign-in or an API key.

Use this when the person is a property manager and you need the owner a case is for, or to list one owner’s cases. Input: optional `includeArchived`. Returns the organization’s landlords (the owners it acts for, saved in the app), by name, each with its `id`, `name`, whether it is `archived` and how many cases in this mode name it; their contact details stay in the app. Live keys only: with a test key the list is always empty, since landlords are real owners, and a test case cannot take one. Do not use this to add or change a landlord (the person does that on the Landlords page of the app). Next: evictions_create_case with `landlordId`, or evictions_list_cases with `landlordId`. Needs the person’s account: sign-in or an API key.

Use this when you need every place the service covers, or the exact code or slug of a state. Takes no input. Returns the 50 states and DC, each with its two-letter code, name, slug and page on the site. Do not use this for one state’s eviction rules (use evictions_get_state_eviction_facts). No key needed.

Use this when you need to know, before creating a case, whether a case can be opened for a property’s location and which facts each ground of eviction needs there. Input: `state`, and `county` and `city` when known. Returns whether the jurisdiction is served and, for each ground, the facts a case needs, and with a test key also the notice rules of the fictional state ZZ. Do not use this for a state’s published facts with their sources (use evictions_get_state_eviction_facts, which needs no key). Next: evictions_create_case. Needs the person’s account: sign-in or an API key.

Use this when the person asks you to write to the Evictions API team about one of their live cases. Input: the case `id` and `body`. Sends the team a message about a live case, in the person’s name, and the team is told by email. Send only what the person asked to say. Each call sends one more message; a test case is refused, and an organization can send at most 20 every 10 minutes. Returns the message as stored. Do not use this to change a draft (use evictions_update_case). Needs the person’s account: sign-in or an API key.

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.

Use this when the person has said yes to submitting a draft that passes every check. Input: the case `id` and `confirmedByPerson`. A live case moves to `submitted`, its platform fee becomes a due charge, and a licensed attorney in the property’s state is engaged for it; nothing is served or filed until that attorney has reviewed it. With a test key the case is fictional and goes through a simulated review instead. With a live key this acts on a real case. Confirm with the person first, then pass `confirmedByPerson: true`. The case’s attestations must be the person’s own statements; never fill them in yourself. Do not use this to check a draft (use evictions_validate_case). Returns the case and its check results. Next: evictions_list_case_charges for the fee. Needs the person’s account: sign-in or an API key.

Use this when a draft’s facts need correcting or completing, for example after evictions_validate_case says what is missing. Input: the case `id` and only the fields to change; each one replaces the stored value, and an object such as `property` is replaced whole. Works only on a draft, and `ground` and `entryPoint` cannot change (create a new case instead). Do not use this on a submitted case (use evictions_send_case_message to tell the team what changed). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Next: evictions_validate_case. Needs the person’s account: sign-in or an API key.

Use this when a draft looks complete, before asking the person to confirm its submission. Input: the case `id`. Runs the submission checks on a draft and returns each check’s result, with the reason when it does not pass, and whether all passed. Changes nothing. Do not use this to submit (use evictions_submit_case). Next: evictions_update_case to fill a gap, or the person’s yes and then evictions_submit_case. Needs the person’s account: sign-in or an API key.

Use this when the person has decided to withdraw a case and stop it. Input: the case `id` and `confirmedByPerson`. A live case with an attorney already engaged goes on hold instead and is withdrawn once the attorney has confirmed that all work has stopped. With a live key this acts on a real case. Confirm with the person first, then pass `confirmedByPerson: true`. Do not use this to report that the tenant has paid or to ask a question (use evictions_send_case_message). The result is the case, with `state` and `nextAction` (who it is waiting on and for what). Needs the person’s account: sign-in or an API key.