evictionsapi-com Jurisdictions API

openapi: 3.2.0
info:
  title: Evictionsapi Com Jurisdictions API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Jurisdictions across 3 of this provider''s published API definitions: api.evictionsapi.com.json, evictionsapi-com-api-evictions-openapi.json, evictionsapi-com-openapi.json. Each path carries the servers of the definition it was published in.'
servers:
- url: https://api.evictionsapi.com
tags:
- name: Jurisdictions
paths:
  /v1/jurisdictions/resolve:
    get:
      summary: Whether a jurisdiction is served, and its notice rules
      security:
      - ApiKey: []
      - SessionToken: []
      parameters:
      - name: state
        in: query
        required: true
        schema:
          type: string
          pattern: ^[A-Za-z]{2}$
      - name: county
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 100
      - name: city
        in: query
        required: false
        schema:
          type: string
          minLength: 1
          maxLength: 100
      responses:
        '200':
          description: 'Served status, `handling`, jurisdiction ids and the grounds. With a live key every US state and DC is served with `handling: "attorney_direct"`, `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), and `defaults`, the pack''s own default where a fact has one). They apply only to a case created with `service: "full"`: 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.'
          content:
            application/json:
              schema:
                type: object
                additionalProperties: true
        '400':
          description: The request is invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '401':
          description: The credential is missing or invalid.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '403':
          description: '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).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '404':
          description: Not found.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '409':
          description: '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.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '422':
          description: The case did not pass a check.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Jurisdictions
      operationId: getV1JurisdictionsResolve
      x-operation-id-source: derived
    servers:
    - url: https://api.evictionsapi.com
components:
  schemas:
    Error:
      type: object
      required:
      - error
      properties:
        error:
          type: object
          required:
          - code
          - message
          - details
          properties:
            code:
              type: string
            message:
              type: string
            details: {}
  securitySchemes:
    ApiKey:
      type: http
      scheme: bearer
      description: An organization API key (`eak_test_...` or `eak_live_...`).
    SessionToken:
      type: http
      scheme: bearer
      description: 'A session token (`ess_...`) from `POST /v1/auth/signup` or `/v1/auth/login`, valid for 30 days. On the case, webhook, API key and organization routes it acts for the organization the session is in (`POST /v1/me/organization` switches it) in the mode named by the `X-Evictions-Mode` header: `test` (the default) or `live`.'
    AttorneyToken:
      type: http
      scheme: bearer
      description: A user token (`eut_...`) of a verified attorney.
externalDocs:
  url: https://evictionsapi.com/docs
x-refined-from:
- api.evictionsapi.com.json
- evictionsapi-com-api-evictions-openapi.json
- evictionsapi-com-openapi.json