Called with an organization API key (or, from the website, a signed-in session). Everything you need to create, check, submit and follow a case.
The examples use https://api.evictionsapi.com and placeholder keys. Conventions shared by all endpoints (errors, idempotency, pagination) are in the API reference.
What is available todayYou can start a real eviction case with Evictions API for a rental property in any US state or DC. After you submit a case, we engage a licensed attorney in the property’s state for it and confirm by email. Nothing is served on a tenant or filed in court until that attorney has reviewed the case.The full statement
Endpoints
GET/v1/jurisdictions/resolve
Whether a jurisdiction is served, and its notice rules
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
state
query
string
Yes
Two-letter state code. With a test key, ZZ is the fictional test state.
county
query
string
No
County name, to include county-level rules.
city
query
string
No
City name, to include city-level rules.
Responses
Status
Meaning
Body
200
Served status, `handling`, jurisdiction ids and the grounds. With a live key every US state and DC is served, with the `handling` a case created there gets (`"agent_filed"` where `fullService` is true, `"attorney_direct"` elsewhere), `action: null` and, for each ground, `notice: null` and the facts intake requires (`requiredFacts`) and, where `fullService` is true, the facts that place's documents ask for beyond them (`documentFacts`: `notice` and `filing`, by where the case starts, and `conditional`, facts asked for only when another holds (with `past: true`, when that fact is a date before today, such as a lease end date that has passed), `ledgerItemised`, where the place's documents itemise the ledger by kind of charge (`notice`: the notice demands only what is past due on its date; `filing`: the filing states the amounts by kind), `claimKinds`, the kinds of charge besides rent (`late_fee`, `utilities`, `other_fee`) a full-service money claim may include there, each from the ledger's own unpaid charges of that kind and sent as `managedContext.relief.items` with `leaseProvidesCharges: true`, and `defaults`, the pack's own default where a fact has one). They apply to a full-service case: ask an attorney-path case for the intake facts alone; anything else is `served: false`. With a test key (`handling: "automated"`) the fictional test state answers with its notice rules for each ground. `fullService` says whether a case created here with `service: "full"` is handled by us as your agent (no attorney reviews it); where it is false, a managed-service request answers 409 `service_unavailable` with its operational reason. This does not establish a legal requirement for counsel. `county` may be written as the US Census Bureau lists it or by its short name, in any case ("Henry County", "henry"); a county the state does not have answers 400 `invalid_request`. `court` is the court the place's rules say a case goes to, with the county ("Magistrate court of Henry County"), or `null` where no rule pack covers the place. `courts` lists, where `fullService` is true, the courts a full-service case's `managedContext.courtId` may name, each with the `forums` its `managedContext.forum` may name; it is empty otherwise.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Find the county of a street address, from the US Census geocoder. The address goes in the body, never the URL; the unit is not passed on, and nothing is stored. When the county cannot be found (no match, a match in another state or in more than one county, or the geocoder failing or taking over 5 seconds) the answer is `{ "county": null }`, never an error. At most 60 an hour per organization (429 `rate_limited`)
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
line1
string
Yes
1 to 200 characters.
unit
string
No
1 to 50 characters.
city
string
No
1 to 100 characters.
state
string
Yes
Pattern ^[A-Za-z]{2}$.
zip
string
No
Pattern ^\d{5}(-\d{4})?$.
Responses
Status
Meaning
Body
200
The address as sent, with `city` and `zip` filled in from the geocoder where they were missing, and the county as a case stores it: its short name in the US Census Bureau's county list, without the word "County" or "Parish" (an independent city keeps "City", for example "Baltimore City"); or `{ "county": null }`, also when the geocoder names a county the list does not have.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The organization's email intake address, `cases+<token>@<domain>`: email sent to it by a member of the organization whose address is confirmed puts its attachments and its text in the intake inbox. Made on the first call, the same afterwards. Live only: a test key answers 422 `live_only`
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Replace the organization's email intake address with a new one. Email sent to the old address is no longer received. A signed-in owner only (an API key answers 403). Live only
Authentication: Session token, as Authorization: Bearer ess_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/intake/address/rotate \
-H"Authorization: Bearer ess_..."
GET/v1/integrations
List the organization's stored property-management connections (Buildium, DoorLoop), without their credentials. A signed-in session in live mode only: an API key answers 403
Authentication: Session token, as Authorization: Bearer ess_...
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Connect Buildium (`credentials: { clientId, clientSecret }`) or DoorLoop (`credentials: { token }`) for the organization. The key is checked with one read-only call to the system, then stored encrypted, replacing any earlier one; it is never returned. An owner's signed-in session in live mode only
Authentication: Session token, as Authorization: Bearer ess_...
Parameters
Name
In
Type
Required
Description
system
path
string
Yes
—
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
label
string
No
1 to 100 characters. Pattern ^[^\u0000-\u001f\u007f]*$.
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Search the connected system's leases: by tenant name in Buildium, by lease name (which names its unit and tenants) in DoorLoop. At most 20 leases. A signed-in session in live mode only
Authentication: Session token, as Authorization: Bearer ess_...
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Read one lease from the connected system as suggested answers for a new case: the address, the tenants, the lease dates and rent, the ledger and the system's balance, and its lease PDF when it has one. A part the system no longer has (a tenant, the unit) is left out. Nothing is stored or filed by this. A signed-in session in live mode only
Authentication: Session token, as Authorization: Bearer ess_...
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
List the files waiting in the organization's intake inbox, oldest first: files the customer already has (a lease, a ledger, an email) kept until a case is started. Live only: a test key answers 422 `live_only`
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Keep a file in the organization's intake inbox until a case is started: a PDF, JPEG or PNG of at most 4 MB, decided by its contents. The inbox holds 50 waiting files (409 `inbox_full`), each for 30 days. Live only: a test key answers 422 `live_only`
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
filename
string
Yes
1 to 255 characters.
purpose
string
No
One of: "lease", "ledger", "correspondence", "other".
note
string
No
1 to 500 characters.
contentBase64
string
Yes
1 to 5592408 characters.
Responses
Status
Meaning
Body
201
The stored file, without its name or note: the list gives them back while the file waits.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
curl-X POST https://api.evictionsapi.com/v1/intake/files \
-H"Authorization: Bearer eak_test_..." \
-H"Content-Type: application/json" \
-d'{
"filename": "lease.pdf",
"note": "Lease for unit 2B",
"contentBase64": "JVBERi0xLjcK"
}'
POST/v1/extract
Read a lease (PDF, JPEG or PNG, at most 4 MB and, for a PDF, 40 pages, as base64) with an AI service (Claude Haiku 4.5 through OpenRouter) and answer the facts the new-case form takes. For a file the free reading on the device could not read. With `kind: "correspondence"` and `files` (1 to 10 messages with the tenant: PDF, JPEG, PNG, plain text `text/plain`, or a saved email `message/rfc822` (`.eml`, at most 1 MB, turned into its text before it is sent); 8 MB, 40 PDF pages and 200,000 characters of text in all), it drafts what happened for a lease-violation case (`violationDescription`, `violationDate`): a draft for the person to read and correct, never a checked answer. One request counts once against the hourly limit, whatever the number of files. With `kind: "ledger"` and one `file` (a tenant ledger PDF, at most 4 MB and 40 pages), it answers the ledger's rows (`rows`, each `{ date, type: "charge" | "payment", amountCents, memo }`, at most 500, in the order printed) a balance brought forward from before them (`openingBalanceCents`, null when none) and the ending balance the ledger states (`endingBalanceCents`, null when it states none), for the caller to check: the balance brought forward and the rows should add up to the ending balance, and the website fills in nothing when they do not. A row dated after today is left out. The files are sent to OpenRouter only for this one reading, under fixed names (the `name` you send is never passed on), on endpoints that keep no data; nothing is stored and nothing of the files or the answer is logged. Every answer is a suggestion for a person to check: a fact the reading is unsure of is left out, never guessed. When the service refuses, fails or takes over 30 seconds, the answer is empty (`{ "suggestions": {}, "confidence": {} }`, or for a ledger `{ "rows": [], "openingBalanceCents": null, "endingBalanceCents": null }`), never an error. For now only the signed-in app and test keys can use it: a live API key answers 503 `extract_unavailable`. At most 20 an hour per organization (429 `rate_limited`); 503 `extract_unavailable` when the server has no AI service set
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. The body is one of these shapes. Fields not listed are rejected.
When kind is "lease"
Name
Type
Required
Description
kind
string
Yes
Always "lease".
file
object
Yes
—
file.name
string
Yes
1 to 255 characters.
file.contentType
string
Yes
1 to 100 characters.
file.contentBase64
string
Yes
At least 1 characters.
When kind is "correspondence"
Name
Type
Required
Description
kind
string
Yes
Always "correspondence".
files
array of object
Yes
1 to 10 items.
files[].name
string
Yes
1 to 255 characters.
files[].contentType
string
Yes
1 to 100 characters.
files[].contentBase64
string
Yes
At least 1 characters.
When kind is "ledger"
Name
Type
Required
Description
kind
string
Yes
Always "ledger".
file
object
Yes
—
file.name
string
Yes
1 to 255 characters.
file.contentType
string
Yes
1 to 100 characters.
file.contentBase64
string
Yes
At least 1 characters.
Responses
Status
Meaning
Body
200
The answers found, in the same shape as the website's lease reading: each a `{ value, source: "lease_file" }` (`source: "messages"` for the messages' draft), and how sure the reading is of each (`high` or `medium`). Dates are `YYYY-MM-DD`, `monthlyRent` is dollars with cents ("1450.00"), `noticePeriod` is whole days ("3"), `state` is the two-letter code; `parties` lists the landlord (`plaintiff`) and the tenants (`defendant`). From messages: `violationDescription` (a few plain sentences, at most 2,000 characters) and `violationDate` (never later than today).
object
400
The request is invalid (`invalid_request`): `kind` must be `lease` or `ledger` with one `file`, or `correspondence` with `files` (1 to 10), and each file must have exactly `name`, `contentType` and `contentBase64` (valid base64).
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
`payload_too_large`: a file is over 4 MB, a PDF has more than 40 pages, a text or `.eml` message is over 1 MB, or the messages together are over 8 MB, 40 PDF pages or 200,000 characters of text (the body itself may be at most 14 MB).
`unsupported_media_type`: a file is not a PDF, JPEG or PNG (or, for a message, plain UTF-8 text or a `.eml` email; for a ledger, only a PDF), `contentType` is not the type of its bytes, a `.eml` file is not an email, or a PDF's pages could not be counted.
`rate_limited`: the organization has made 20 requests this hour (the server may set another number). Every request counts, a refused one too: the limit is checked before any file is read. `Retry-After` gives the seconds to wait.
`extract_unavailable`: reading files with the AI service is not set up on this server, or is not open to live API keys yet (only the signed-in app and test keys can use it for now). Fill in the form by hand, or read the file on the device.
Download a waiting file of the intake inbox. A file moved onto a case is downloaded as that case's document instead (404 here). Live only
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The intake file id.
Responses
Status
Meaning
Body
200
The file's bytes, with the stored `Content-Type`: `application/pdf`, `image/jpeg` or `image/png`, or `text/plain; charset=utf-8` for the text of a forwarded email, as an attachment.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Create a draft case. For a live case the property must be in a US state or DC (422 `unsupported_state`) and the case takes the full-service path (we act as your agent, no attorney reviews the case) wherever that path is open for the property; elsewhere it is an attorney-direct case. The case's `handling` says which. `service` is not needed for a live case: `"attorney"` selects nothing, and `"full"` where the path is not open answers 409 `service_unavailable` without creating a different service. A test case takes the full-service path only with `service: "full"`
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
ground
string
Yes
One of: "nonpayment", "lease_violation", "holdover".
entryPoint
string
Yes
One of: "notice", "filing".
property
object
Yes
—
property.line1
string
Yes
1 to 200 characters.
property.unit
string
No
1 to 50 characters.
property.city
string
Yes
1 to 100 characters.
property.county
string
No
The county, as the US Census Bureau lists it or by its short name, in any case ("Henry County", "Henry", "henry"). It is stored by its short name ("Henry"); a county the state does not have is refused (400 `invalid_request`). 1 to 100 characters.
property.state
string
Yes
Pattern ^[A-Za-z]{2}$.
property.zip
string
Yes
Pattern ^\d{5}(-\d{4})?$.
property.ownerOfRecord
string
Yes
1 to 200 characters.
parties
array of object
Yes
Up to 20 items.
parties[].role
string
Yes
One of: "plaintiff", "defendant".
parties[].name
string
Yes
1 to 200 characters.
parties[].isEntity
boolean
No
—
parties[].phone
string
No
1 to 40 characters.
lease
object
No
—
lease.startDate
string
No
—
lease.endDate
string
No
—
lease.monthlyRentCents
integer
No
0 or more.
lease.noticePeriodDays
integer
No
1 to 365.
lease.monthToMonth
boolean
No
—
lease.terminationNoticeDate
string
No
—
lease.noticeMethods
string
No
The additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. Asked for where a place's notice states them (Georgia): the notice is posted on the door and says it is also delivered by these methods, or that the rental agreement provides none. 1 to 500 characters.
ledger
array of object
No
Up to 1000 items.
ledger[].date
string
If ledger is sent
—
ledger[].type
string
If ledger is sent
One of: "charge", "payment".
ledger[].amountCents
integer
If ledger is sent
0 or more.
ledger[].memo
string
No
1 to 500 characters.
ledger[].kind
string
No
What a charge is for: `rent`, `late_fee`, `utilities`, `other_fee` (any other charge), or a cost of the eviction itself: `eviction_fee`, `attorney_fee` or `court_cost`. A charge only; a payment has none. Where every charge has a kind, a place's documents itemise what is past due by kind (Georgia's notice demands only charges dated on or before its date, and never an `eviction_fee`, `attorney_fee` or `court_cost`, which are not owed before filing); a charge without a kind is accepted, except where the place's documents itemise the ledger by kind (Georgia full-service nonpayment cases today), where every charge must have a kind at submission. One of: "rent", "late_fee", "utilities", "other_fee", "eviction_fee", "attorney_fee", "court_cost".
amountOwedCents
integer
No
0 or more.
ledgerPaymentsApplied
string
No
How the payments on the ledger are applied to its charges. Absent or `oldest_first`: each payment goes to the oldest unpaid charge, whatever it is for. `rent_first`: every payment goes to rent before any other charge, for a lease that says so. It decides the rent past due and the other amounts a place's documents itemise from the ledger, and the most `rentOwedCents` may be there. One of: "oldest_first", "rent_first".
rentOwedCents
integer
No
0 or more.
violation
object
No
—
violation.description
string
If violation is sent
1 to 5000 characters.
violation.date
string
If violation is sent
—
attestations
object
Yes
—
attestations.authority
boolean
No
—
attestations.notRetaliatory
boolean
No
—
attestations.notDiscriminatory
boolean
No
—
attestations.servicemember
string
No
One of: "no", "yes", "unknown".
attestations.caresCovered
boolean
No
—
attestations.subsidized
boolean
No
—
attestations.lateBeforeNoticeMonth
boolean
No
—
plaintiffContact
object
No
—
plaintiffContact.address
string
If plaintiffContact is sent
1 to 500 characters.
plaintiffContact.phone
string
If plaintiffContact is sent
1 to 40 characters.
plaintiffContact.email
string
No
Format: email. Up to 254 characters. Pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$.
priorNotice
object
No
—
priorNotice.servedDate
string
If priorNotice is sent
—
priorNotice.method
string
If priorNotice is sent
One of: "personal", "substitute", "posting", "certified_mail", "first_class_mail", "text_message", "email".
priorNotice.periodDays
integer
If priorNotice is sent
1 to 365.
priorNotice.type
string
No
One of: "notice_to_vacate", "notice_to_pay_rent_or_vacate", "pay_or_quit", "cure_or_quit".
priorNotice.sealedEnvelope
boolean
No
Whether the notice already served was posted in a sealed envelope on the door of the premises, as the person states it. Asked for where a place's filing states it (Georgia): the filing says so, and a posted notice answered `false` there does not pass the prior-notice check.
managedContext
object
No
—
managedContext.plaintiffType
string
If managedContext is sent
One of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedContext.courtId
string
If managedContext is sent
1 to 200 characters.
managedContext.forum
string
If managedContext is sent
1 to 100 characters.
managedContext.residential
boolean
If managedContext is sent
—
managedContext.phase
string
If managedContext is sent
One of: "initial", "contested", "jury", "appeal", "post_judgment".
One of: "lease_file", "buildium", "doorloop", "address", "ledger_file", "messages", "draft_file", "agent".
managedFacts.declarations[].provenance.confidence
number
No
0 to 1.
managedFacts.declarations[].provenance.label
string
If managedFacts.declarations[].provenance is sent
1 to 200 characters.
managedFacts.dismissed
array of string
No
1 to 7 items.
landlordId
string
No
The owner the organization acts for on this case: the id of one of its active landlords (`GET /v1/landlords`). On a draft only. Choosing one adds its current management agreement to the case as an authority document, unless the case already has that file; changing it later adds the new landlord's agreement and removes nothing. Live cases only: landlords are real owners, so a test case never takes one. 422 `landlord_not_found` for a landlord that is not one of the organization's active landlords, and for any landlord on a test case. 1 to 64 characters. Pattern ^[A-Za-z0-9_-]+$.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
List the cases of the key's organization and mode, optionally only those one person opened (`openedBy`), or those of one landlord (`landlordId`, or `none` for the cases with no landlord)
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
cursor
query
string
No
The nextCursor of the previous page. Omit it for the first page.
limit
query
string
No
Page size, 1 to 100. Default 20; a larger value is treated as 100.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
What your draft cases still need before they can be submitted: for each draft with something open (your 25 newest drafts, with `more` true when there are others; or the one case `caseId` names), every failing submission check and every detail still asked for, each as one sentence (`message`) with at most one `action`. `open_field`: enter it (`field` is the case-data path). `upload`: add the document with that `purpose` (`POST /v1/cases/{id}/documents`). `apply`: send `code` and `shownCents` to `POST /v1/cases/{id}/gaps/apply` to set a figure that follows from the case's own ledger (the value is in `label`); it is offered only for the amount owed and the rent owed, and never for a figure of zero. A draft whose checks could not be run is listed with `unavailable: true` and no gaps. `action` is null where nothing you can change closes the gap. A case that is not a draft has none
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Set a draft's amount owed (`amount_owed`) or rent owed (`rent_owed`) to the figure its own ledger gives, as `GET /v1/cases/gaps` offered it. The figure is worked out again by the server and stored with the source `ledger_rows`; `shownCents` is only compared with it
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
`gap_changed`: the ledger changed since the figure was offered, or there is nothing to set (no ledger, a ledger that owes nothing, a figure the case already holds). Nothing was written.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Change the facts of a draft case, or (`paymentMethodId`, in any state) the saved card a full-service case is charged to. 409 `not_agent_filed` for a card on a case that is not full-service; 422 `payment_method_not_found` for a card that is not one of the organization's usable cards in this mode
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
ground
string
No
One of: "nonpayment", "lease_violation", "holdover".
entryPoint
string
No
One of: "notice", "filing".
property
object
No
—
property.line1
string
If property is sent
1 to 200 characters.
property.unit
string
No
1 to 50 characters.
property.city
string
If property is sent
1 to 100 characters.
property.county
string
No
The county, as the US Census Bureau lists it or by its short name, in any case ("Henry County", "Henry", "henry"). It is stored by its short name ("Henry"); a county the state does not have is refused (400 `invalid_request`). 1 to 100 characters.
property.state
string
If property is sent
Pattern ^[A-Za-z]{2}$.
property.zip
string
If property is sent
Pattern ^\d{5}(-\d{4})?$.
property.ownerOfRecord
string
If property is sent
1 to 200 characters.
parties
array of object
No
Up to 20 items.
parties[].role
string
If parties is sent
One of: "plaintiff", "defendant".
parties[].name
string
If parties is sent
1 to 200 characters.
parties[].isEntity
boolean
No
—
parties[].phone
string
No
1 to 40 characters.
lease
object
No
—
lease.startDate
string
No
—
lease.endDate
string
No
—
lease.monthlyRentCents
integer
No
0 or more.
lease.noticePeriodDays
integer
No
1 to 365.
lease.monthToMonth
boolean
No
—
lease.terminationNoticeDate
string
No
—
lease.noticeMethods
string
No
The additional ways the rental agreement says a notice must be delivered, exactly as the lease states them, or the word `none`. Asked for where a place's notice states them (Georgia): the notice is posted on the door and says it is also delivered by these methods, or that the rental agreement provides none. 1 to 500 characters.
ledger
array of object
No
Up to 1000 items.
ledger[].date
string
If ledger is sent
—
ledger[].type
string
If ledger is sent
One of: "charge", "payment".
ledger[].amountCents
integer
If ledger is sent
0 or more.
ledger[].memo
string
No
1 to 500 characters.
ledger[].kind
string
No
What a charge is for: `rent`, `late_fee`, `utilities`, `other_fee` (any other charge), or a cost of the eviction itself: `eviction_fee`, `attorney_fee` or `court_cost`. A charge only; a payment has none. Where every charge has a kind, a place's documents itemise what is past due by kind (Georgia's notice demands only charges dated on or before its date, and never an `eviction_fee`, `attorney_fee` or `court_cost`, which are not owed before filing); a charge without a kind is accepted, except where the place's documents itemise the ledger by kind (Georgia full-service nonpayment cases today), where every charge must have a kind at submission. One of: "rent", "late_fee", "utilities", "other_fee", "eviction_fee", "attorney_fee", "court_cost".
amountOwedCents
integer
No
0 or more.
ledgerPaymentsApplied
string
No
How the payments on the ledger are applied to its charges. Absent or `oldest_first`: each payment goes to the oldest unpaid charge, whatever it is for. `rent_first`: every payment goes to rent before any other charge, for a lease that says so. It decides the rent past due and the other amounts a place's documents itemise from the ledger, and the most `rentOwedCents` may be there. One of: "oldest_first", "rent_first".
rentOwedCents
integer
No
0 or more.
violation
object
No
—
violation.description
string
If violation is sent
1 to 5000 characters.
violation.date
string
If violation is sent
—
attestations
object
No
—
attestations.authority
boolean
No
—
attestations.notRetaliatory
boolean
No
—
attestations.notDiscriminatory
boolean
No
—
attestations.servicemember
string
No
One of: "no", "yes", "unknown".
attestations.caresCovered
boolean
No
—
attestations.subsidized
boolean
No
—
attestations.lateBeforeNoticeMonth
boolean
No
—
plaintiffContact
object
No
—
plaintiffContact.address
string
If plaintiffContact is sent
1 to 500 characters.
plaintiffContact.phone
string
If plaintiffContact is sent
1 to 40 characters.
plaintiffContact.email
string
No
Format: email. Up to 254 characters. Pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$.
priorNotice
object
No
—
priorNotice.servedDate
string
If priorNotice is sent
—
priorNotice.method
string
If priorNotice is sent
One of: "personal", "substitute", "posting", "certified_mail", "first_class_mail", "text_message", "email".
priorNotice.periodDays
integer
If priorNotice is sent
1 to 365.
priorNotice.type
string
No
One of: "notice_to_vacate", "notice_to_pay_rent_or_vacate", "pay_or_quit", "cure_or_quit".
priorNotice.sealedEnvelope
boolean
No
Whether the notice already served was posted in a sealed envelope on the door of the premises, as the person states it. Asked for where a place's filing states it (Georgia): the filing says so, and a posted notice answered `false` there does not pass the prior-notice check.
managedContext
object
No
—
managedContext.plaintiffType
string
If managedContext is sent
One of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other".
managedContext.courtId
string
If managedContext is sent
1 to 200 characters.
managedContext.forum
string
If managedContext is sent
1 to 100 characters.
managedContext.residential
boolean
If managedContext is sent
—
managedContext.phase
string
If managedContext is sent
One of: "initial", "contested", "jury", "appeal", "post_judgment".
One of: "lease_file", "buildium", "doorloop", "address", "ledger_file", "messages", "draft_file", "agent".
managedFacts.declarations[].provenance.confidence
number
No
0 to 1.
managedFacts.declarations[].provenance.label
string
If managedFacts.declarations[].provenance is sent
1 to 200 characters.
managedFacts.dismissed
array of string
No
1 to 7 items.
paymentMethodId
any
No
Full-service cases only: the id of the organization's saved card (`GET /v1/payment-methods`) to charge this case's costs to, or null to use the default card. A body with only this field needs the permission to manage payment methods; 422 `payment_method_not_found` when the card is not one of the organization's usable cards in this mode.
landlordId
any
No
The owner the organization acts for on this case: the id of one of its active landlords (`GET /v1/landlords`). On a draft only. Choosing one adds its current management agreement to the case as an authority document, unless the case already has that file; changing it later adds the new landlord's agreement and removes nothing. Live cases only: landlords are real owners, so a test case never takes one. 422 `landlord_not_found` for a landlord that is not one of the organization's active landlords, and for any landlord on a test case. null: no landlord (the documents stay). 409 `invalid_state` once the case is not a draft.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Which facts one proposed act of a managed case is missing. The facts are the customer's declaration, and an empty list is not permission to perform the act
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
action
query
string
Yes
—
Responses
Status
Meaning
Body
200
What the act is missing, and whether the facts are the customer's own declaration.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
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
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
filename
string
Yes
1 to 255 characters.
purpose
string
Yes
One of: "authority", "prior_notice", "prior_notice_proof", "other", "lease", "ledger", "correspondence".
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
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`
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
intakeFileId
string
Yes
Pattern ^intake_[A-Za-z0-9-]+$.
purpose
string
Yes
One of: "lease", "ledger", "correspondence", "other".
Responses
Status
Meaning
Body
201
The new document (200: the file was already moved onto this case, and this is its document).
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
docId
path
string
Yes
The document id.
Responses
Status
Meaning
Body
200
The document bytes, with the stored `Content-Type`: `application/pdf`, `image/jpeg` or `image/png`, or `text/plain; charset=utf-8` for a plain-text `correspondence` document, as an attachment.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../validate \
-H"Authorization: Bearer eak_test_..."
POST/v1/cases/{id}/submit
Submit a draft that passes every gate. A live case is submitted only with its platform fee paid. An attorney-direct case whose fee is not paid stays a draft and answers 402 `payment_required` with the charge to pay (`details.chargeId`, `details.amountCents`, `details.payAt`): open its checkout (`/v1/cases/{id}/charges/{chargeId}/checkout`), and when the payment is recorded the case moves to `submitted` by itself and we engage a licensed attorney in the property's state; nothing is served or filed until that attorney has reviewed it. A full-service case needs its signed authorization and a saved card, and its fee is charged to that card when we begin. Send no `Idempotency-Key` you already used for this case's submission: a stored 402 would be replayed after the payment. A test case enters review by the built-in test reviewer
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../submit \
-H"Authorization: Bearer eak_test_..."
GET/v1/cases/{id}/authorization
The authorization text of the case, and whether it is signed and still current: for a full-service case, the authorization for us to act as the owner's agent there; for any other live case, the general authorization the owner signs before paying the fee. 409 `not_agent_filed` for a test case that is not a full-service case
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Responses
Status
Meaning
Body
200
The text to sign, the signature in force and whether it is stale.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Sign the authorization of the case, for the facts as they are now: a full-service case only while it is a draft, any other live case while it is open (409 `invalid_state` otherwise); 409 `not_agent_filed` for a test case that is not a full-service case. Signing again replaces the earlier signature
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The complaint documents the owner must sign on an agent-filed case, and whether they are signed. 409 `not_required` when the county has us sign the complaint, or there is none yet; 409 `not_agent_filed` for any other case
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Responses
Status
Meaning
Body
200
The documents and whether this exact set is signed.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Sign the complaint of an agent-filed case, where the county requires the owner to. Only while the case waits for the signature in `filing_approved`; 409 `not_required` otherwise, and 409 `not_agent_filed` for any other case. The filing is queued once. Where the filing is an affidavit sworn by electronic verification (`sworn` on the GET), only the named affiant signs, `accept: true` is the oath, `signerName` must be the affiant's name as printed (case and spacing aside; 422 `affiant_name_mismatch`), and `documentHashes` must be the `sworn.documents` hashes read (409 `documents_changed` when the affidavit changed since, for example on a new day): those documents become the filing
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Download a sworn affidavit by its spec id. Before the oath (while the case waits for it in `filing_approved`): exactly as it will be filed if your named person swears it now, signed "/s/" with the affiant's name and dated today (the court's day). Once sworn: the affidavit that was sworn, as stored for the filing. 404 for any other document or case; 410 `erased` for an erased case
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../report-cure \
-H"Authorization: Bearer eak_test_..."
POST/v1/cases/{id}/withdraw
Withdraw the case. A live case with an attorney already engaged goes `on_hold` with a `withdrawal_requested` event instead, and is withdrawn once the attorney has confirmed that all work has stopped
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Responses
Status
Meaning
Body
200
The case: withdrawn, or on hold while the withdrawal is confirmed.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Open a hosted checkout for one due charge. 409 `authorization_required` until the owner has signed the case's authorization (`/v1/cases/{id}/authorization`); 409 `payments_unavailable` when online payment is off; 409 `charge_not_due` when the charge is paid, void or refunded; 409 `automatic_charge` for a charge taken from the saved card
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
chargeId
path
string
Yes
—
Responses
Status
Meaning
Body
200
The checkout URL to send the customer to. They return to the case page on the website.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl example for POST /v1/cases/{id}/charges/{chargeId}/checkout
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../charges/chargeId_.../checkout \
-H"Authorization: Bearer eak_test_..."
POST/v1/cases/{id}/charges/{chargeId}/confirm
Check with the payment provider whether the charge's checkout was paid, and record it if so. Safe to repeat. 409 `payments_unavailable` when online payment is off; 409 `automatic_charge` for a charge taken from the saved card
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl example for POST /v1/cases/{id}/charges/{chargeId}/confirm
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../charges/chargeId_.../confirm \
-H"Authorization: Bearer eak_test_..."
GET/v1/payment-methods
The organization's saved cards for the automatic charges of full-service cases, in the key's mode: the default first, then newest first. Anyone in the organization can read them
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Open the payment provider's page for adding a card. The card number is typed there and never reaches the API. The customer comes back to `returnPath` on the website with `setup_session` in the query (and `default=true` when `default` was asked for); send those to `confirm`. With a test key there is no card page and no real card: the returned URL only carries the setup's id in its `session` parameter; finish the setup with `POST /v1/payment-method/test-setup`, then `confirm` it. Needs the permission to manage payment methods. In live mode, 409 `live_unavailable` until live full-service cases are switched on; 503 `payments_unavailable` when online payment is off
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
returnPath
string
Yes
Up to 200 characters. Pattern ^\/app(\/[A-Za-z0-9_-]+)*$.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Add the card of a finished setup to the organization's cards in this mode. It becomes the default with `default: true`, or when the organization has no usable default. Every automatic charge still due is then retried shortly after, in the background. Safe to repeat: a card already added is answered as it is. 409 `setup_incomplete` while the card is not saved yet; 404 for a setup that is unknown, another organization's, or of a card removed since
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Name a card (`label`, null to clear it), make it the default (`default: true`), or say which saved landlord it is for (`landlordId`, null for none; 404 `landlord_not_found` when it is not one of the organization's landlords). 422 `payment_method_unusable` for a declined card made the default, and then nothing is changed. 404 for a card that is not one of the organization's in this mode. Each change is in the organization's activity log
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The case id.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
label
any
No
—
default
boolean
No
Always true.
landlordId
any
No
The saved landlord (`GET /v1/landlords`) whose card this is, or null for none. 404 `landlord_not_found` when it is not one of the organization's landlords.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Remove a card: it is detached at the payment provider and never charged again. When it was the default, the newest card left that works becomes the default; with none left, a full-service case with a cost due waits until a card is added. 404 for a card that is not one of the organization's in this mode
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Every charge of the organization's cases in this mode, newest first, optionally only one status, the charges created between two days (UTC), or the charges of one landlord's cases (`landlordId`, or `none` for the cases with no landlord), with the billing page's totals. Anyone in the organization can read them
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
cursor
query
string
No
The nextCursor of the previous page. Omit it for the first page.
limit
query
string
No
Page size, 1 to 100. Default 20; a larger value is treated as 100.
status
query
string
No
—
from
query
string
No
—
to
query
string
No
—
landlordId
query
string
No
—
Responses
Status
Meaning
Body
200
A page of charges, and the totals over all of them. `paymentsEnabled` false: online payment is off, and `checkout` answers 409 `payments_unavailable`.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The same charges as a CSV file (at most 10,000 rows, newest first), named `charges-YYYY-MM-DD.csv` after the day of the request. Columns: created_at, charge_id, case_id, state, landlord, kind, description, amount_usd, status, paid_at, receipt_url. `landlord` is the display name of the case's landlord, empty when it has none. No tenant names, addresses or payment-provider ids
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The organization's charges in this mode totalled per landlord of their cases (what a manager bills back to each owner): due, paid this calendar year (UTC), and how many charges. Only landlords with charges, archived ones included, by name; the cases with no landlord last, as "No landlord". The lines add up to the totals of `GET /v1/charges`. Anyone in the organization can read them
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The owners the organization acts for, by name, each with how many of its cases in this mode name them. Archived ones only with `includeArchived=true`. Anyone in the organization can read them with a live key or a signed-in session; a test key always gets an empty list, since landlords are real owners shared with the organization's live cases
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Save an owner the organization acts for. `ownerOfRecord` defaults to the name. Needs the permission to manage landlords. In the organization's activity log by its id only. 409 `landlord_limit` once the organization keeps 1,000 saved landlords, archived ones included. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
name
string
Yes
1 to 200 characters.
isEntity
boolean
Yes
—
plaintiffType
any
No
—
ownerOfRecord
string
No
1 to 200 characters.
contact
object
Yes
—
contact.address
string
Yes
1 to 500 characters.
contact.phone
string
Yes
1 to 40 characters.
contact.email
string
No
Format: email. Up to 254 characters. Pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
One landlord, archived or not, with its current management agreement. 404 `landlord_not_found` for one that is not the organization's, and for any landlord asked for with a test key
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The landlord id.
Responses
Status
Meaning
Body
200
The landlord, and its management agreement or null.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Change a landlord, archived or not: only the fields given change; `contact` is replaced whole; null clears `plaintiffType` and `notes`. Cases already opened keep what they were given; a change that leaves it as it was is not logged. 404 `landlord_not_found` for one that is not the organization's. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The landlord id.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
name
string
No
1 to 200 characters.
isEntity
boolean
No
—
plaintiffType
any
No
—
ownerOfRecord
string
No
1 to 200 characters.
contact
object
No
—
contact.address
string
If contact is sent
1 to 500 characters.
contact.phone
string
If contact is sent
1 to 40 characters.
contact.email
string
No
Format: email. Up to 254 characters. Pattern ^(?:[A-Za-z0-9_'+\-]+\.)*[A-Za-z0-9_'+\-]*[A-Za-z0-9_+-]@(?:[A-Za-z0-9][A-Za-z0-9\-]*\.)+[A-Za-z]{2,}$.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Archive a landlord: its cases and charges stay, and it can no longer be chosen for a new case until it is unarchived. Never deleted. Archiving again changes nothing. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/landlords/lnd_.../archive \
-H"Authorization: Bearer eak_test_..."
POST/v1/landlords/{id}/unarchive
Unarchive a landlord, so it can be chosen for a new case again. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl example for POST /v1/landlords/{id}/unarchive
curl-X POST https://api.evictionsapi.com/v1/landlords/lnd_.../unarchive \
-H"Authorization: Bearer eak_test_..."
POST/v1/landlords/{id}/documents
Upload the landlord's management agreement: a PDF, JPEG or PNG of at most 10 MB, decided by the file's contents (415 `unsupported_media_type` otherwise; 413 when larger). It replaces the current agreement; the earlier one is kept but no longer listed. 409 `landlord_file_limit` once the landlord has 20 files, replaced ones included. A test key gets 403 `forbidden`: landlords are real owners shared with the organization's live cases, so a test key neither sees nor changes them
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Download one of the landlord's files. 404 `landlord_not_found` for a landlord that is not the organization's, and for any landlord with a test key; 404 `not_found` for a file that is not the landlord's
Authentication: API key, as Authorization: Bearer eak_test_...
Parameters
Name
In
Type
Required
Description
id
path
string
Yes
The landlord id.
docId
path
string
Yes
The document id.
Responses
Status
Meaning
Body
200
The file's bytes, with the stored `Content-Type` (`application/pdf`, `image/jpeg` or `image/png`), as an attachment.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The default card for the automatic charges of full-service cases, in the key's mode, or null when there is none. Kept for older clients: `GET /v1/payment-methods` lists every card
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Open the payment provider's page for saving a card. The card number is typed there and never reaches the API. The customer comes back to `returnPath` on the website with `setup_session` in the query; send that to `confirm`. With a test key there is no card page and no real card: the returned URL only carries the setup's id in its `session` parameter; finish the setup with `POST /v1/payment-method/test-setup`, then `confirm` it. In live mode, 409 `live_unavailable` until live full-service cases are switched on (the full service is offered only in test mode for now). 503 `payments_unavailable` when online payment is off
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
returnPath
string
Yes
Up to 200 characters. Pattern ^\/app(\/[A-Za-z0-9_-]+)*$.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Add the card of a finished setup to the organization's cards in this mode, as the default card (kept for older clients: `POST /v1/payment-methods/confirm` chooses). Every automatic charge still due is then retried on it shortly after, in the background; a case on hold for a declined card continues once its costs are paid. Safe to repeat. 409 `setup_incomplete` while the card is not saved yet; in live mode, 409 `live_unavailable` until live full-service cases are switched on
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Test mode only (409 `sandbox_only` otherwise): finish a test setup with one of the two test cards, `success` (Visa ending 4242) or `decline` (ending 0002, which declines every charge). `sessionId` is the `session` parameter of the URL that `POST /v1/payment-method/setup` returned for the test key
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
sessionId
string
Yes
1 to 255 characters.
card
string
Yes
One of: "success", "decline".
Responses
Status
Meaning
Body
200
Where to send the customer next: the setup's return URL.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../notes \
-H"Authorization: Bearer eak_test_..." \
-H"Content-Type: application/json" \
-d'{
"body": "The tenant paid half of the balance yesterday. Does that change the next step?"
}'
POST/v1/cases/{id}/advance
Test keys only: move a test case on by one step. Runs the step the case is waiting for now (the test reviewer's review, a service or filing update, or the end of the notice period on the case's own test clock), or records the next court outcome as the test reviewer. A live case (nothing about a real case is ever advanced automatically), or a case outside the fictional test state, gets 409 `sandbox_only`; a draft, a case on hold or a finished case gets 409 `nothing_to_advance`, as does a step whose last try failed, until its automatic retry (`error.details.retryAt`). While the step is already being taken, the case is returned as it is. At most 60 a minute per organization (429 `rate_limited`)
Authentication: API key, as Authorization: Bearer eak_test_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/cases/case_.../advance \
-H"Authorization: Bearer eak_test_..."
POST/v1/webhook-endpoints
Register a webhook endpoint
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
url
string
Yes
1 to 2048 characters.
Responses
Status
Meaning
Body
201
The endpoint. The signing secret appears in this response only. An `Idempotency-Key` header is ignored: every request creates an endpoint, and no response is stored or replayed.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Create an API key in the credential's mode, optionally with a name. With `replaceSameName`, the active keys of the mode with that exact name are revoked first, so an app that connects again keeps one key. A live key can be created only by an owner of the organization, signed in with a session and `X-Evictions-Mode: live` (403 `forbidden` otherwise, also for a live API key); at most 10 active keys per mode, counted after any replaced keys (409 `key_limit`, and then nothing is revoked)
Authentication: API key, as Authorization: Bearer eak_test_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
name
string
No
1 to 300 characters.
replaceSameName
boolean
No
—
Responses
Status
Meaning
Body
201
The new key. The secret appears in this response only. An `Idempotency-Key` header is ignored: every request creates a key, and no response is stored or replayed.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Change the organization's profile: its name, kind and contact details (`organization.manage`, an owner by default) and the billing contact (`billing.manage`); a request with both needs both. Only the fields given change; null clears one. An API key gets 403
Authentication: Session token, as Authorization: Bearer ess_...
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Change a member's role (`owner`, `member`, `viewer`), or give them a `custom` list of permissions. Needs `people.manage`; only an owner makes, changes or removes an owner, and nobody gives a permission they do not hold. The last owner cannot be demoted. The person is emailed unless they changed their own role
Authentication: Session token, as Authorization: Bearer ess_...
Parameters
Name
In
Type
Required
Description
userId
path
string
Yes
The person's user id: a member's id in GET /v1/organization.
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
Responses
Status
Meaning
Body
200
The member after the change. Asking for the role they already have changes nothing.
`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and the change concerns an owner (making one, changing one, removing one); or is not an owner and gives a permission they do not hold themselves (nobody grants what they do not hold).
Remove a person from the organization. Needs `people.manage`; an owner is removed by an owner only, and never the last one. Their sessions acting for the organization are signed out, their other organizations stay, and they are emailed. Their cases, messages and signatures stay with the organization
Authentication: Session token, as Authorization: Bearer ess_...
Parameters
Name
In
Type
Required
Description
userId
path
string
Yes
The person's user id: a member's id in GET /v1/organization.
`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and the change concerns an owner (making one, changing one, removing one); or is not an owner and gives a permission they do not hold themselves (nobody grants what they do not hold).
The organization's activity log: invitations, role changes, removals and profile changes, newest first. A signed-in person who manages people; an API key or anyone else gets 403
Authentication: Session token, as Authorization: Bearer ess_...
Parameters
Name
In
Type
Required
Description
before
query
string
No
The nextBefore of the previous page. Omit it for the newest rows.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and invites an owner (only an owner does); or is not an owner and does not hold every permission of the role (nobody grants what they do not hold: a person with only `people.manage` invites viewers).
`invitation_rate_limited`: the organization sent 20 invitations in the last 24 hours, or the person sent 20 across all their organizations, resent and replaced ones included. Nothing was sent. Please try again later.
`forbidden`: an API key (sessions only). `permission_denied`: the person cannot manage the organization's people; or is not an owner and invites an owner (only an owner does); or is not an owner and does not hold every permission of the role (nobody grants what they do not hold: a person with only `people.manage` invites viewers).
`invitation_rate_limited`: the organization sent 20 invitations in the last 24 hours, or the person sent 20 across all their organizations, resent and replaced ones included. Nothing was sent. Please try again later.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Sign in with Google: the website trades the code Google gave it. Signs in to the account linked to that Google account, else links the account with the same email (with or without a password), else creates one (201) with no password. With `invitationToken` it also accepts that invitation: the Google account's email must be the invited address, a new account gets no organization of its own, and the session acts for the inviting organization. No credential; the website calls this from its servers
Authentication: none
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
code
string
Yes
1 to 2048 characters.
codeVerifier
string
Yes
Pattern ^[A-Za-z0-9._~-]{43,128}$.
redirectUri
string
Yes
1 to 2048 characters.
invitationToken
string
No
1 to 200 characters.
Responses
Status
Meaning
Body
200
A new session, with the user and organization (201 when the account was just created). An `Idempotency-Key` header is ignored.
`google_account_not_allowed`: the account may not sign in with Google (a law-firm user, a platform address, or a user already linked to another Google account), or `account_disabled`: the account has been disabled. With `invitationToken`: `account_kind`, an attorney's or the operator's account cannot join an organization.
With `invitationToken`: `invitation_email_mismatch`, the Google account's email is not the invited address; `already_member`; `member_limit`, the organization already has 50 people. Nothing was created or linked.
Too many sign-up and sign-in attempts from this address: at most 10 every 10 minutes, shared with sign-up and sign-in. `Retry-After` gives the seconds to wait.
Accept an invitation. Signed out, with a name and a password: makes the account for the invited address, confirmed, and answers 201 with a session for the organization. Signed in as the invited address, with no body: joins the organization and moves the session there (200). An address that already has an account must sign in to accept; its password is never set here
Authentication: Session token, as Authorization: Bearer ess_...
Parameters
Name
In
Type
Required
Description
token
path
string
Yes
—
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
name
string
Yes
1 to 120 characters.
password
string
Yes
10 to 200 characters.
Responses
Status
Meaning
Body
201
A new session for a new account (`token`, shown here only), with the account view; 200 with the account view alone for a signed-in person. An `Idempotency-Key` header is ignored.
`invitation_email_mismatch`: the session is for another address. `email_taken`: signed out, and the invited address already has an account; sign in to accept. `already_member`: the person is a member already. `member_limit`: the organization already has 50 people. Nothing was created and the invitation is still pending.
curl example for POST /v1/invitations/{token}/accept
curl-X POST https://api.evictionsapi.com/v1/invitations/token_.../accept \
-H"Authorization: Bearer ess_..." \
-H"Content-Type: application/json" \
-d'{ "name": "Sam Rivera", "password": "a long passphrase, not this one" }'
POST/v1/auth/logout
Revoke the session in use
Authentication: Session token, as Authorization: Bearer ess_...
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl-X POST https://api.evictionsapi.com/v1/auth/logout \
-H"Authorization: Bearer ess_..."
POST/v1/auth/password-reset/request
Ask for a password reset link by email. No credential. The answer is the same whether or not the address has an account
Authentication: none
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
email
string
Yes
1 to 254 characters.
Responses
Status
Meaning
Body
202
The request was accepted. If the address belongs to an account that signs in to the site, a single-use link valid for one hour was emailed to it. One account is sent at most 3 such emails an hour: a request beyond that gets this same answer and sends nothing. An `Idempotency-Key` header is ignored.
Too many password reset requests from this address: at most 10 every 10 minutes, counting both reset endpoints. `Retry-After` gives the seconds to wait.
Set a new password with the token from a reset link. No credential. The token works once; every session of the user is revoked
Authentication: none
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
token
string
Yes
1 to 200 characters.
password
string
Yes
10 to 200 characters.
Responses
Status
Meaning
Body
200
The password was changed and every session of the user was revoked. Sign in again with the new password. An `Idempotency-Key` header is ignored.
{ ok: boolean }
400
`invalid_reset_token`: the token is unknown, already used or expired. `invalid_request`: the password is not 10 to 200 characters (`details.issues` names `password`).
Too many password reset requests from this address: at most 10 every 10 minutes, counting both reset endpoints. `Retry-After` gives the seconds to wait.
`busy`: too many password checks are waiting. Nothing was changed and the token is still unused. `Retry-After: 5` gives the seconds to wait; try again.
curl example for POST /v1/auth/password-reset/confirm
curl-X POST https://api.evictionsapi.com/v1/auth/password-reset/confirm \
-H"Content-Type: application/json" \
-d'{
"token": "epr_...",
"password": "a new long passphrase, not this one"
}'
POST/v1/auth/email-confirm/request
Send a new "Confirm your email" link to the signed-in user's own address. The answer is always 202
Authentication: Session token, as Authorization: Bearer ess_...
Responses
Status
Meaning
Body
202
The request was accepted. If the address is not confirmed yet, a single-use link valid for three days was emailed to it. One account is sent at most 3 such emails an hour, the one at sign-up included: a request beyond that gets this same answer and sends nothing. An `Idempotency-Key` header is ignored.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Too many email confirmation requests from this address: at most 10 every 10 minutes, counting both confirmation endpoints. `Retry-After` gives the seconds to wait.
Too many email confirmation requests from this address: at most 10 every 10 minutes, counting both confirmation endpoints. `Retry-After` gives the seconds to wait.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
`rate_limited`: the person started 5 organizations in the last 24 hours, the one made at sign-up included. Nothing was created. Please try again later.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
Change the person's password, with the current one. Every other session of the person is signed out (this one stays), and their pending email change and password reset links stop working
Authentication: Session token, as Authorization: Bearer ess_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
currentPassword
string
Yes
1 to 200 characters.
newPassword
string
Yes
10 to 200 characters.
Responses
Status
Meaning
Body
204
The password changed.
—
400
`invalid_request`: the new password is not 10 to 200 characters (`details.issues` names `newPassword`).
`account_kind`: the operator's and attorneys' accounts cannot change this here. `wrong_password`: the current password is not correct (5 wrong ones in 15 minutes lock the account, sign-in included). An API key or attorney token: `forbidden`.
`rate_limited`: 5 wrong current passwords for this account in 15 minutes; for an email change also more than 10 requests from one address in 10 minutes (counting `POST /v1/me/email/confirm`) or 3 links for the account in an hour. `Retry-After` gives the seconds to wait.
curl-X POST https://api.evictionsapi.com/v1/me/password \
-H"Authorization: Bearer ess_..." \
-H"Content-Type: application/json" \
-d'{
"currentPassword": "your current password",
"newPassword": "a new long password"
}'
POST/v1/me/email
Ask to change the person's email, with the current password. A link goes to the new address and the address changes only when it is opened; the old address is told
Authentication: Session token, as Authorization: Bearer ess_...
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
email
string
Yes
Up to 254 characters.
currentPassword
string
Yes
1 to 200 characters.
Responses
Status
Meaning
Body
202
The link was sent to the new address. It works once, for 24 hours, and a newer request replaces it.
{ ok: boolean }
400
`invalid_request`: not an email address, or an evictionsapi.com address (`details.issues` names `email`).
`account_kind`: the operator's and attorneys' accounts cannot change this here. `wrong_password`: the current password is not correct (5 wrong ones in 15 minutes lock the account, sign-in included). An API key or attorney token: `forbidden`.
`rate_limited`: 5 wrong current passwords for this account in 15 minutes; for an email change also more than 10 requests from one address in 10 minutes (counting `POST /v1/me/email/confirm`) or 3 links for the account in an hour. `Retry-After` gives the seconds to wait.
curl-X POST https://api.evictionsapi.com/v1/me/email \
-H"Authorization: Bearer ess_..." \
-H"Content-Type: application/json" \
-d'{
"email": "pat@new-domain.example",
"currentPassword": "your current password"
}'
POST/v1/me/email/confirm
Change the email with the token from the link sent to the new address. No credential. The token works once
Authentication: none
Request body
JSON. Fields not listed are rejected.
Name
Type
Required
Description
token
string
Yes
1 to 200 characters.
Responses
Status
Meaning
Body
200
The account view, with the new address, confirmed. Sessions are kept; password reset links sent to the old address stop working. An `Idempotency-Key` header is ignored.
The credential is not allowed to do this (`forbidden`). For a signed-in session: `permission_denied`, the person's role in the organization lacks the permission this needs (ask an owner); `no_organization`, the person belongs to no organization yet (start one with `POST /v1/me/organizations` or accept an invitation).
The request conflicts with the current state: for a case, it is not in a state that allows this, or its details were erased (`erased`); for an API key, a limit or the key in use.
curl example for POST /v1/me/sessions/revoke-others
curl-X POST https://api.evictionsapi.com/v1/me/sessions/revoke-others \
-H"Authorization: Bearer ess_..."
Response objects
The objects the customer endpoints return. Response shapes are described by hand in the OpenAPI document and are deliberately loose.
PmsConnection
The organization's stored connection to a property-management system. Its credentials are kept encrypted and never returned.
Name
Type
Required
Description
system
string
Yes
One of: "buildium", "doorloop".
label
string
Yes
The name the organization gave it; the system's name by default.
createdAt
string
Yes
Format: date-time.
lastUsedAt
string | null
Yes
Format: date-time.
lastError
string | null
Yes
How the last search or pull failed (`unauthorized`, `rate_limited`, `unavailable`); null when it worked.
LeaseMatch
A lease a search found, as the property-management system holds it. Empty strings where it has nothing to show.
Name
Type
Required
Description
id
string
Yes
The system's lease id, for `pull`.
name
string
No
The system's own name for the lease (DoorLoop).
tenants
array of string
Yes
—
unit
string
Yes
—
address
string
Yes
—
start
string
No
Format: date.
end
string
No
Format: date.
balanceCents
integer
No
What the system says the tenant owes.
PmsPull
One lease read from the property-management system as suggested answers for a new case (each `{ value, source }`, the source being the system), the lease PDF when the system holds one, and the system's balance to check the ledger rows against. Nothing of it is stored: the person checks every answer.
Name
Type
Required
Description
suggestions
object
Yes
—
leaseFile
object
No
—
leaseFile.filename
string
If leaseFile is sent
—
leaseFile.contentBase64
string
If leaseFile is sent
—
leaseFile.contentType
string
If leaseFile is sent
Always "application/pdf".
balanceCents
integer
No
—
skippedRows
integer
No
How many ledger rows were left out because their transaction type is not one we map. Absent when none.
IntakeFile
A file waiting in the organization's intake inbox for a case: a PDF, JPEG or PNG the customer already has, or the plain text of a forwarded email. It waits 30 days, then is deleted unless it was moved onto a case.
Name
Type
Required
Description
id
string
Yes
—
source
string
Yes
How it arrived: forwarded by email, or sent through the API (an AI agent or an integration). One of: "email", "agent".
filename
string
Yes
—
contentType
string
Yes
Decided from the file's first bytes, never from its name. `text/plain` only for the text of a forwarded email, stored by us. One of: "application/pdf", "image/jpeg", "image/png", "text/plain".
purposeGuess
string
Yes
What the file is probably for: as sent, or guessed from its name. Confirmed when it is moved onto a case. One of: "lease", "ledger", "correspondence", "other".
note
string | null
Yes
The email's subject or the sender's note; null when none.
receivedAt
string
Yes
Format: date-time.
expiresAt
string
Yes
When the file is deleted if it has not been moved onto a case. Format: date-time.
Case
Name
Type
Required
Description
id
string
Yes
The case's key in the API, for example `case_21a1f8ed-79f4-4248-a682-10184ca8a5c1`.
reference
string
Yes
The case's short reference, for example `EV-1001`: what our emails and the app show. `GET /v1/cases/{id}` also accepts it in place of the id.
mode
string
Yes
One of: "test", "live".
state
string
Yes
Position in the case lifecycle, for example `notice_review` or `filing_submitted`.
heldFrom
string | null
No
—
openedBy
object
No
Who opened the case: the person (`id`, and their current display name, `null` when they have none), `{ "kind": "api_key" }` when it was opened with an API key, or `null` when that is not known (a case from before this was recorded).
landlord
object | null
No
The owner your organization acts for on this case (one of `GET /v1/landlords`), with its current name; null when none was chosen, and always null on a test case. Set it with `landlordId` on `POST /v1/cases` or `PATCH /v1/cases/{id}` (live cases only).
landlord.id
string
If landlord is sent
—
landlord.name
string
If landlord is sent
—
ground
string
Yes
—
entryPoint
string
Yes
One of: "notice", "filing".
courtCaseNumber
string | null
No
—
court
string | null
No
The court the case goes to, in words, where the rules for its place say which, with the county: for example "Magistrate court of Henry County". `null` where no rule pack covers the place, and for an erased case.
One of: "customer", "attorney", "platform", "court", "none".
nextAction.description
string
Yes
—
handling
string
No
Who does the legal work. `attorney_direct`: a licensed attorney engaged for the case reviews it, serves the notice and files in court, and the platform records each step; it is what a live case is where the full-service path is not open for its property. `automated`: the built-in test pipeline of a test case. `agent_filed`, the full-service path, as we describe it to the owner: We act as your authorized agent. No attorney reviews the case. We are not a law firm and do not give legal advice. A live case is created with it wherever that path is open for the property; a test case when `POST /v1/cases` asks for `service: "full"`. It needs the owner's signed authorization (`/v1/cases/{id}/authorization`). One of: "automated", "attorney_direct", "agent_filed".
attorney
object | null
No
The attorney engaged for an attorney-direct case, once recorded. Null until then, and always null for a test case.
attorney.name
string | null
If attorney is sent
—
attorney.firm
string
If attorney is sent
—
attorney.state
string
If attorney is sent
The property's state.
attorney.barNumber
string | null
If attorney is sent
The attorney's bar number in that state.
erased
boolean
No
Whether the details of the case were erased, which we do case by case on request. An erased case keeps its id, state, dates, deadline names and charges. In `data` the names and the address read `[erased]` (the state and county are kept) and every other fact is gone; `courtCaseNumber` is null; each document keeps its id and `contentHash`, its `filename` reads `[erased]` and downloading it answers 410 `erased`; messages read `[erased]`. Any request that would change the case answers 409 `erased`.
erasedAt
string | null
No
When the details were erased. Null for a case that was not erased. Format: date-time.
sources
object
No
Where each answer came from, by field path (`property.line1`, `lease.monthlyRentCents`, `parties.0`, `ledger`): the kind of source, and for a file read the id of the case document it was read from. An answer with no entry was typed. Empty when no answer came from a source. Never holds a value. Send `sources` with `POST /v1/cases` or `PATCH /v1/cases/{id}` to set it (a patch replaces the whole map); a patch that changes an answer without sending `sources` removes that answer's entry. In a patch, a path sent as `null` removes its entry. The kind `document_read` is recorded only by our own reading of the case's documents: an entry of that kind stays while its answer is unchanged (send the path as `null` to remove it), and sending the kind for an answer that has no such entry answers 422. The kinds `saved_landlord` (the address and telephone of a landlord you saved under the plaintiff's name) and `previous_case` (those of your earlier case with the same plaintiff) are recorded by us the same way.
documentFill
object
No
A draft only, on `GET /v1/cases/{id}` (not in a list). `filled`: the field paths of the answers read from the case's own uploaded documents to fill what the draft lacked (the entries of `sources` with the kind `document_read`); check each, and change any with `PATCH /v1/cases/{id}`. An answer you sent is never replaced, and nothing is filled that no document states. `questions`: what the submission checks still miss, as field paths, and `parties.plaintiff`, `parties.defendant` or `ledger.kind` (the kind of each ledger charge). Names only, never a value.
documentFill.filled
array of string
If documentFill is sent
—
documentFill.questions
array of string
If documentFill is sent
—
documentFill.reasons
object
No
For a question that was looked for and not filled, why, as a code: `not_stated`, `no_document_read`, `low_confidence`, `invalid_value`, `document_names_other_tenants`, `document_names_no_tenant`, `landlord_is_not_plaintiff`, `address_or_phone_missing`, `ledger_not_whole`, `ledger_rows_not_matched`, `ledger_kinds_incomplete`, `saved_details_ambiguous`, `cleared_by_person` or `not_fillable`. `POST /v1/cases/{id}/validate` says each in a sentence (`missingReasons`).
documentFill.reading
boolean
No
Whether documents added to a draft are read by themselves here.
gates
object
No
A draft only, on `GET /v1/cases/{id}` (not in a list): the submission checks as they stand now (`results` and `passed`), each failing one with its reason in words, as `POST /v1/cases/{id}/validate` gives them.
agent
boolean
No
Present, and true, only for an agent-filed case (`handling: "agent_filed"`): we act as your authorized agent, no attorney reviews the case, and we are not a law firm and do not give legal advice. Every field below appears only with it. Always true.
authorization
object
No
Whether your authorization for us to act as your agent is signed, and whether the facts changed after it was signed (then nothing more is done until you sign again).
authorization.signed
boolean
If authorization is sent
—
authorization.stale
boolean
If authorization is sent
—
complaintSignature
object
No
Whether the court requires the owner to sign the complaint, and whether the current complaint is signed. While it is required and unsigned, the case waits in `filing_approved`. `sworn` (true when present): the filing is an affidavit your named person swears under oath by electronic verification in the app. `signer`: the member the case names to sign it, by user id and the name the filing prints; only that person can sign.
complaintSignature.required
boolean
If complaintSignature is sent
—
complaintSignature.signed
boolean
If complaintSignature is sent
—
complaintSignature.sworn
boolean
No
Always true.
complaintSignature.signer
object
No
—
complaintSignature.signer.userId
string
If complaintSignature.signer is sent
—
complaintSignature.signer.name
string
If complaintSignature.signer is sent
—
paymentMethodId
string | null
No
The organization's saved card (`GET /v1/payment-methods`) this case's costs are charged to, or null for the default card. Choose it with `PATCH /v1/cases/{id}`. A chosen card that is removed or declined is not charged: the default card is used instead.
Each outward step of the case, oldest first (as `GET /v1/cases/{id}/tasks`).
checking
object
No
Present while we check what the next step sends before it is sent (we check every notice, filing and summons for now): `notice` (the notice to the tenant), `filing` (the court filing) or `summons`. Nothing is sent, and nothing is charged for that step, until it is checked.
checking.stage
string
If checking is sent
One of: "notice", "filing", "summons".
checking.since
string
If checking is sent
Format: date-time.
sentBack
object
No
Present while the case is on hold because we checked a step before sending it and sent the case back to you: nothing was sent. `note` says why; reply by email, or withdraw the case.
sentBack.stage
string
If sentBack is sent
One of: "notice", "filing", "summons".
sentBack.note
string
If sentBack is sent
—
sentBack.at
string
If sentBack is sent
Format: date-time.
claim
object
No
What the complaint asks the court for besides possession: unpaid rent, where the court lets us claim it as your agent, up to the court's limit where it has one.
claim.claimRent
boolean
If claim is sent
—
claim.amountClaimedCents
integer
If claim is sent
US cents. Zero when no money is claimed.
claim.items
object
No
The claim by kind of charge, in US cents, where it includes charges besides rent (a place whose `documentFacts.claimKinds` allows them); the four add up to `amountClaimedCents`.
claim.items.rentCents
integer
No
—
claim.items.lateFeesCents
integer
No
—
claim.items.utilitiesCents
integer
No
—
claim.items.otherCents
integer
No
—
hearing
object
No
The hearing, once the court has set one (or moved it): where the owner attends in person (`clientAttends`), you must attend it yourself; no one from the platform appears in your place.
hearing.date
string
If hearing is sent
Format: date.
hearing.time
string | null
If hearing is sent
The court's local time, HH:MM, when known.
hearing.place
string | null
If hearing is sent
Where the court sits for the hearing, when known.
hearing.court
string | null
If hearing is sent
—
hearing.clientAttends
boolean
If hearing is sent
—
courtRecord
object
No
What the court's e-filing portal (eFileGA, for example) shows of the case, as we record it from the portal: every envelope sent to the court, newest first, and the notices the court or the portal sent, newest first. Both are empty until something was filed. The case's `state` is moved separately; an envelope accepted with a court case number sets `courtCaseNumber`.
courtRecord.submissions
array of object
If courtRecord is sent
—
courtRecord.submissions[].id
string
If courtRecord is sent
—
courtRecord.submissions[].portal
string
If courtRecord is sent
The court's e-filing portal, for example `eFileGA`.
courtRecord.submissions[].envelopeNumber
string | null
No
—
courtRecord.submissions[].status
string
If courtRecord is sent
One of: "submitted", "under_review", "accepted", "rejected", "cancelled".
courtRecord.submissions[].statusLabel
string
If courtRecord is sent
The status in plain words.
courtRecord.submissions[].statusAt
string
If courtRecord is sent
When the court gave the status (the review date), or when it was recorded. Format: date-time.
courtRecord.submissions[].statusHistory
array of object
If courtRecord is sent
—
courtRecord.submissions[].statusHistory[].status
string
If courtRecord is sent
—
courtRecord.submissions[].statusHistory[].at
string
If courtRecord is sent
Format: date-time.
courtRecord.submissions[].submittedAt
string | null
No
Format: date-time.
courtRecord.submissions[].acceptedAt
string | null
No
Format: date-time.
courtRecord.submissions[].filings
array of object
If courtRecord is sent
—
courtRecord.submissions[].filings[].code
string | null
No
—
courtRecord.submissions[].filings[].description
string
If courtRecord is sent
—
courtRecord.submissions[].filings[].documentId
string | null
No
The document of the case that was filed.
courtRecord.submissions[].reviewerComments
string | null
No
The court clerk's comments or the reason for a rejection, word for word.
courtRecord.submissions[].courtCaseNumber
string | null
No
—
courtRecord.submissions[].fees
array of object
If courtRecord is sent
—
courtRecord.submissions[].fees[].label
string
If courtRecord is sent
—
courtRecord.submissions[].fees[].amountCents
integer
If courtRecord is sent
US cents.
courtRecord.submissions[].totalCents
integer | null
No
The envelope's grand total, in US cents.
courtRecord.submissions[].transactionReference
string | null
No
—
courtRecord.submissions[].stampedDocumentIds
array of string
If courtRecord is sent
The court's file-stamped copies, documents of the case (download each from `GET /v1/cases/{id}/documents/{docId}`).
courtRecord.submissions[].recordedAt
string
No
Format: date-time.
courtRecord.submissions[].updatedAt
string
No
Format: date-time.
courtRecord.notices
array of object
If courtRecord is sent
—
courtRecord.notices[].id
string
If courtRecord is sent
—
courtRecord.notices[].receivedAt
string
If courtRecord is sent
Format: date-time.
courtRecord.notices[].from
string
If courtRecord is sent
—
courtRecord.notices[].subject
string
If courtRecord is sent
—
courtRecord.notices[].body
string
If courtRecord is sent
The notice's text, word for word.
courtRecord.notices[].documentIds
array of string
If courtRecord is sent
Documents of the case that came with the notice.
courtRecord.notices[].recordedAt
string
No
Format: date-time.
createdAt
string
No
Format: date-time.
updatedAt
string
No
Format: date-time.
Document
Name
Type
Required
Description
id
string
Yes
—
kind
string
Yes
One of: "evidence", "notice", "filing", "proof", "other".
specId
string | null
No
—
purpose
string
No
What an uploaded file (`kind: "evidence"`) is for, as given with the upload. Null for documents the platform or the attorney adds, and for files uploaded before purposes were kept. One of: "authority", "prior_notice", "prior_notice_proof", "other", "lease", "ledger", "correspondence", null.
filename
string
Yes
—
contentType
string
No
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). One of: "application/pdf", "image/jpeg", "image/png", "text/plain".
contentHash
string
Yes
SHA-256 of the document bytes. An attorney approval names these.
createdAt
string
No
Format: date-time.
GateResults
Name
Type
Required
Description
passed
boolean
Yes
—
results
array of object
Yes
—
results[].gate
string
Yes
—
results[].status
string
Yes
—
results[].reason
string
No
—
missing
array of string
No
What the checks still miss, by name: field paths (`lease.monthlyRentCents`), and `parties.plaintiff`, `parties.defendant` or `ledger.kind` (the kind of each ledger charge). Never a value.
missingReasons
object
No
A draft only: for an item of `missing` that was looked for in your documents or saved details and not filled, why (`code`, as in the case's `documentFill.reasons`) and what to do, in one sentence (`message`). No value of the case is in it.
filledFromDocuments
array of string
No
The field paths of the answers read from the case's own uploaded documents (`sources` kind `document_read`). Check each before submitting.
Task
One outward step of a full-service case (`handling: "agent_filed"`): delivering the notice, filing, ordering the summons, attending the hearing, a signature from the owner, or mail from the court.
Name
Type
Required
Description
kind
string
Yes
One of: "notice_delivery", "filing", "summons_order", "hearing_appearance", "client_signature", "court_mail".
status
string
Yes
One of: "pending", "in_progress", "done", "failed", "cancelled".
dueAt
string | null
Yes
When the step must be done by, when there is a deadline. Format: date-time.
completedAt
string | null
Yes
Format: date-time.
CaseGaps
Name
Type
Required
Description
id
string
Yes
—
unavailable
boolean
No
Present when the checks could not be run on this draft as it stands: its gaps are not known, and it cannot be submitted until that is put right. Always true.
property
object
Yes
—
property.line1
string
Yes
—
property.unit
string
No
—
property.city
string
Yes
—
property.state
string
Yes
—
gaps
array of object
Yes
—
gaps[].code
string
Yes
The failing check (`ledger_reconciles.rent_owed`, `authority.document`), or `missing` for a detail still asked for.
gaps[].field
string
No
For `missing`: the detail, by its case-data path (or `parties.plaintiff`, `parties.defendant`, `ledger.kind`).
gaps[].reason
string
No
For `missing`: why it was not filled from your documents or saved details, as a code (see the case's `documentFill.reasons`).
gaps[].message
string
Yes
—
gaps[].action
object | null
Yes
—
gaps[].action.type
string
Yes
One of: "open_field", "upload", "apply".
gaps[].action.label
string
Yes
—
gaps[].action.field
string
No
—
gaps[].action.purpose
string
No
One of: "ledger", "authority", "prior_notice", "prior_notice_proof".
gaps[].action.code
string
No
One of: "amount_owed", "rent_owed".
gaps[].action.shownCents
integer
No
—
gaps[].secondary
object
No
—
gaps[].secondary.type
string
If gaps[].secondary is sent
Always "open_field".
gaps[].secondary.label
string
If gaps[].secondary is sent
—
gaps[].secondary.field
string
No
—
ManagedFacts
Name
Type
Required
Description
action
string
Yes
The proposed act the answer is about.
declared
boolean
Yes
Whether the customer declared these facts, and not only a suggestion.
declaredAt
string | null
Yes
When the customer declared them last. Format: date-time.
problem
string | null
Yes
Why the stored facts do not read as a complete declaration.
missing
array of object
Yes
The facts this act is missing, each with the question to ask. An empty list is not permission to perform the act.
missing[].key
string
Yes
—
missing[].question
string
Yes
—
sources
object
Yes
Where each declared fact came from: the source of the last write that set it, `customer` or `suggestion`. A fact that is absent was never declared by anyone.
note
string
Yes
—
Authorization
The authorization the owner signs for an agent-filed case: the text to sign now, the signature in force for it, and whether the case facts changed after it was signed. A change to the facts makes the signature stale until the owner signs again.
Name
Type
Required
Description
textVersion
string
Yes
The version of the text, recorded with every signature.
text
string
Yes
The text the owner signs: plain text, numbered paragraphs.
signed
object | null
Yes
—
signed.at
string
Yes
Format: date-time.
signed.signerName
string
Yes
—
signed.recorded
object | null
Yes
Set when the owner gave the authorization to our staff orally (by telephone, text message, in person or email) and our staff recorded it on the owner's instruction: how and on what day. Null for an authorization signed here.
signed.recorded.channel
string
Yes
One of: "phone", "message", "in_person", "email".
signed.recorded.on
string
Yes
Format: date.
stale
boolean
Yes
True when the facts changed after the signature. The case does not proceed until it is signed again.
Signature
A signature the owner just gave. The IP address it was given from is kept only as a hash, and is not shown.
Name
Type
Required
Description
id
string
Yes
—
kind
string
Yes
One of: "authorization", "complaint".
textVersion
string
Yes
—
signerName
string
Yes
—
signerTitle
string | null
Yes
—
signedAt
string
Yes
Format: date-time.
ComplaintToSign
The complaint documents the owner signs where the county requires the owner to sign the complaint itself, and whether exactly this set is signed.
Name
Type
Required
Description
documents
array of object
Yes
—
documents[].id
string
Yes
—
documents[].filename
string
Yes
—
documents[].contentHash
string
Yes
—
signed
boolean
Yes
—
sworn
object
No
Present where the court filing is an affidavit your named person swears under oath by electronic verification in the app (Georgia: O.C.G.A. § 15-10-53(d)(4)). `affiantName` is the name the affidavit prints, which the signer types; `date` is the day it is dated if sworn now (null once sworn); `documents` are the documents exactly as they will be filed if sworn now, signed and dated (download each from `GET /v1/cases/{id}/signatures/complaint/documents/{specId}`; empty once sworn). Send their `contentHash` values as `documentHashes` when signing.
sworn.affiantName
string
If sworn is sent
—
sworn.date
string | null
If sworn is sent
Format: date.
sworn.documents
array of object
If sworn is sent
—
sworn.documents[].specId
string
If sworn is sent
—
sworn.documents[].filename
string
If sworn is sent
—
sworn.documents[].contentHash
string
If sworn is sent
—
Event
Name
Type
Required
Description
id
string
Yes
—
action
string
Yes
—
actorType
string
Yes
—
fromState
string | null
Yes
—
toState
string | null
Yes
—
detail
any
No
—
createdAt
string
Yes
Format: date-time.
Charge
An amount owed to the platform for a case: the platform fee, or court or service costs passed on at cost. The attorney's legal fee is never a charge here: it is separate and paid to the attorney.
Name
Type
Required
Description
id
string
Yes
—
kind
string
Yes
One of: "platform_fee", "court_costs", "service_costs", "other".
description
string
Yes
—
amountCents
integer
Yes
US cents.
status
string
Yes
One of: "due", "paid", "void", "refunded".
collection
string
Yes
How the charge is paid. `checkout`: on the payment page (`POST /v1/cases/{id}/charges/{chargeId}/checkout`). `automatic`: a cost of a full-service case, taken from a saved card (`/v1/payment-methods`); it is never paid by checkout. One of: "checkout", "automatic".
paidAt
string | null
Yes
Format: date-time.
receiptUrl
string | null
Yes
The payment provider's public receipt page for a paid charge, kept shortly after the payment is recorded. Null until then, when it could not be read, and for charges paid before receipt links were kept (their receipt was sent by email). Format: uri.
createdAt
string
Yes
Format: date-time.
Card
One of the organization's saved cards for the automatic charges of full-service cases, in the key's mode. The card number is never stored: only its brand, last four and expiry, and the cardholder's name as the payment service has it. A case is charged to the card it names (`paymentMethodId`), else to the default card. `failed`: the card was declined; it is not charged again, and cannot be made the default.
Name
Type
Required
Description
id
string
Yes
—
brand
string | null
Yes
—
lastFour
string | null
Yes
—
status
string
Yes
One of: "usable", "failed".
label
string | null
Yes
What the organization calls the card, such as "Operating account card"; null when unnamed.
isDefault
boolean
Yes
The card charged when a case names none. One card per mode at most.
addedBy
object | null
Yes
The person who added it (for a card kept from a checkout: the person who paid); null for a card added with an API key, or before this was kept.
addedBy.id
string
Yes
—
addedBy.name
string | null
Yes
—
createdAt
string
Yes
Format: date-time.
cardholderName
string | null
Yes
The cardholder's name as the payment service has it; null when it was not given.
expMonth
integer | null
Yes
The card's expiry month, 1 to 12.
expYear
integer | null
Yes
The card's expiry year.
landlord
object | null
Yes
The saved landlord (owner) the organization says the card is for (`PATCH /v1/payment-methods/{id}` with `landlordId`); null when it is linked to none. A card kept from the checkout of a case that names a landlord is linked to that landlord.
landlord.id
string
Yes
—
landlord.name
string
Yes
—
firstCaseId
string | null
Yes
The case whose checkout the card was kept from; null for a card saved on the card page.
CustomerCharge
A charge on one of the organization's cases, as the billing page lists it: the case's id, the property's state and the case's landlord, and the charge as `GET /v1/cases/{id}/charges` shows it.
Name
Type
Required
Description
id
string
Yes
—
caseId
string
Yes
—
propertyState
string
Yes
Two-letter code of the property's state. Empty for a case whose details were erased.
landlord
object | null
Yes
The case's landlord (one of `GET /v1/landlords`, archived ones too) with its current name; null when the case has none.
landlord.id
string
Yes
—
landlord.name
string
Yes
—
kind
string
Yes
One of: "platform_fee", "court_costs", "service_costs", "other".
description
string
Yes
—
amountCents
integer
Yes
US cents.
status
string
Yes
One of: "due", "paid", "void", "refunded".
collection
string
Yes
As on `Charge`. One of: "checkout", "automatic".
paidAt
string | null
Yes
Format: date-time.
receiptUrl
string | null
Yes
As on `Charge`. Format: uri.
createdAt
string
Yes
Format: date-time.
ChargeTotals
The billing page's totals over all the organization's charges in the mode, whatever the filter, in US cents. Years are UTC calendar years. "Refunded this year" counts charges by the day they were refunded.
Name
Type
Required
Description
dueCount
integer
Yes
—
dueCents
integer
Yes
—
paidLast30Cents
integer
Yes
—
paidThisYearCents
integer
Yes
—
refundedThisYearCents
integer
Yes
—
Landlord
An owner the organization acts for, as a property manager: a profile reused across cases, never an account. It belongs to the organization, whatever the mode, and only live cases take one: a live key and a signed-in person see it, a test key never does. An archived landlord keeps its cases and is hidden from `GET /v1/landlords` unless `includeArchived=true`. At most 1,000 per organization, archived ones included.
Name
Type
Required
Description
id
string
Yes
—
name
string
Yes
—
isEntity
boolean
Yes
A company, trust or other entity rather than a person.
plaintiffType
string
Yes
The legal type of the plaintiff, as the full service asks it; null when not given. One of: "individual", "corporation", "llc", "partnership", "trust", "estate", "other", null.
ownerOfRecord
string
Yes
The owner of record of the properties; the name unless given.
contact
object
Yes
—
contact.address
string
Yes
—
contact.phone
string
Yes
—
contact.email
string | null
Yes
Format: email.
notes
string | null
Yes
The organization's own notes; never on a court document.
archived
boolean
Yes
—
caseCount
integer
Yes
How many of the organization's cases in the key's mode name this landlord.
createdAt
string
Yes
Format: date-time.
updatedAt
string
Yes
Format: date-time.
LandlordDocument
A landlord's management agreement, without its contents. A PDF, JPEG or PNG, decided from the file's first bytes.
Name
Type
Required
Description
id
string
Yes
—
filename
string
Yes
—
contentType
string
Yes
One of: "application/pdf", "image/jpeg", "image/png".
uploadedAt
string
Yes
Format: date-time.
PaymentMethod
The default card for the automatic charges of full-service cases, in the key's mode, as the older `/v1/payment-method` routes show it: its brand and last four only. `failed`: the card was declined, and the cases waiting on a payment stay on hold until a card that works is saved.
Name
Type
Required
Description
brand
string | null
Yes
—
lastFour
string | null
Yes
—
status
string
Yes
One of: "usable", "failed".
Note
A message on a case, between the customer and the platform.