Raw schema
{
"type": "object",
"properties": {
"ground": {
"type": "string",
"enum": [
"nonpayment",
"lease_violation",
"holdover"
],
"description": "Why the case is brought: nonpayment of rent, a lease violation, or holdover (the tenant stayed after the lease ended). Cannot be changed later."
},
"entryPoint": {
"type": "string",
"enum": [
"notice",
"filing"
],
"description": "Where the case starts: `notice` (a notice to the tenant comes first), or `filing` when a notice was already served (then give `priorNotice`). Cannot be changed later."
},
"property": {
"type": "object",
"properties": {
"line1": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Street address of the rental property."
},
"unit": {
"description": "Unit or apartment number, if any.",
"type": "string",
"minLength": 1,
"maxLength": 50
},
"city": {
"type": "string",
"minLength": 1,
"maxLength": 100,
"description": "City."
},
"county": {
"description": "County, when known.",
"type": "string",
"minLength": 1,
"maxLength": 100
},
"state": {
"type": "string",
"pattern": "^[A-Za-z]{2}$",
"description": "Two-letter state code, for example TX; DC for the District of Columbia. Test keys use the fictional state ZZ."
},
"zip": {
"type": "string",
"pattern": "^\\d{5}(-\\d{4})?$",
"description": "ZIP code: 5 digits, or ZIP+4 (12345-6789)."
},
"ownerOfRecord": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "The owner of the property as on the deed: a person or a company."
}
},
"required": [
"line1",
"city",
"state",
"zip",
"ownerOfRecord"
],
"description": "The rental property and its owner of record."
},
"parties": {
"maxItems": 20,
"type": "array",
"items": {
"type": "object",
"properties": {
"role": {
"type": "string",
"enum": [
"plaintiff",
"defendant"
],
"description": "`plaintiff` for the owner or manager bringing the case, `defendant` for each tenant."
},
"name": {
"type": "string",
"minLength": 1,
"maxLength": 200,
"description": "Full legal name of the person or company."
},
"isEntity": {
"description": "True when the party is a company rather than a person.",
"type": "boolean"
}
},
"required": [
"role",
"name"
]
},
"description": "The plaintiff (the owner or manager) and each defendant (tenant)."
},
"lease": {
"description": "The lease, when there is one.",
"type": "object",
"properties": {
"startDate": {
"type": "string",
"description": "The day the lease began, as YYYY-MM-DD."
},
"endDate": {
"type": "string",
"description": "The day the lease ends or ended, as YYYY-MM-DD."
},
"monthlyRentCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The monthly rent, in US cents (150000 is $1,500.00)."
}
}
},
"ledger": {
"description": "Rent charges and payments, for a nonpayment case.",
"maxItems": 1000,
"type": "array",
"items": {
"type": "object",
"properties": {
"date": {
"type": "string",
"description": "The day of the charge or payment, as YYYY-MM-DD."
},
"type": {
"type": "string",
"enum": [
"charge",
"payment"
],
"description": "`charge` for rent or a fee owed, `payment` for money received."
},
"amountCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The amount, in US cents (150000 is $1,500.00)."
},
"memo": {
"description": "What it was for, such as \"October rent\".",
"type": "string",
"minLength": 1,
"maxLength": 500
}
},
"required": [
"date",
"type",
"amountCents"
]
}
},
"amountOwedCents": {
"type": "integer",
"minimum": 0,
"maximum": 9007199254740991,
"description": "The total the tenant owes now, in US cents (150000 is $1,500.00)."
},
"violation": {
"description": "For a lease violation case.",
"type": "object",
"properties": {
"description": {
"type": "string",
"minLength": 1,
"maxLength": 5000,
"description": "What the tenant did that breaks the lease, in the person’s words."
},
"date": {
"type": "string",
"description": "The day it happened, as YYYY-MM-DD."
}
},
"required": [
"description",
"date"
]
},
"attestations": {
"type": "object",
"properties": {
"authority": {
"description": "The person owns the property or is authorized to act for the owner in this eviction.",
"type": "boolean"
},
"notRetaliatory": {
"description": "The eviction is not in response to the tenant making a complaint, reporting a problem to an authority, or using a legal right.",
"type": "boolean"
},
"notDiscriminatory": {
"description": "The eviction is not based on who the tenant is, such as their race, religion, sex, national origin, disability or family status.",
"type": "boolean"
},
"servicemember": {
"description": "Whether the tenant is on active military duty; `unknown` is an accepted answer.",
"type": "string",
"enum": [
"no",
"yes",
"unknown"
]
},
"caresCovered": {
"description": "Whether the property is covered by the federal CARES Act.",
"type": "boolean"
},
"subsidized": {
"description": "Whether the tenant lives in subsidized housing or receives rental assistance, such as a housing voucher.",
"type": "boolean"
}
},
"description": "The person’s own statements about the case. Ask the person for each one; never fill them in yourself."
},
"priorNotice": {
"description": "The notice already served, for a case that starts at filing.",
"type": "object",
"properties": {
"servedDate": {
"type": "string",
"description": "The day the notice was served, as YYYY-MM-DD."
},
"method": {
"type": "string",
"enum": [
"personal",
"substitute",
"posting",
"certified_mail",
"first_class_mail"
],
"description": "How it was served: handed to the tenant, left with another adult, posted on the door, or sent by certified or first-class mail."
},
"periodDays": {
"type": "integer",
"minimum": 1,
"maximum": 365,
"description": "How many days the notice gave the tenant."
}
},
"required": [
"servedDate",
"method",
"periodDays"
]
},
"freeText": {
"description": "Anything else the attorney should know.",
"type": "string",
"maxLength": 5000
},
"idempotencyKey": {
"description": "Sent as the Idempotency-Key header (printable ASCII, no spaces): a repeat of the same request with the same key returns the first answer instead of a second case. Always pass one, and reuse it if you repeat the call.",
"type": "string",
"minLength": 1,
"maxLength": 255,
"pattern": "^[\\x21-\\x7E]+$"
}
},
"required": [
"ground",
"entryPoint",
"property",
"parties",
"attestations"
],
"$schema": "http://json-schema.org/draft-07/schema#"
}