evictionsapi-com Extract API

openapi: 3.2.0
info:
  title: Evictionsapi Com Extract API
  version: 0.0.0
  contact:
    email: hello@evictionsapi.com
  description: 'Operations tagged Extract 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: Extract
paths:
  /v1/extract:
    post:
      summary: Read a lease (PDF, JPEG or PNG, at most 4 MB and, for a PDF, 40 pages, as…
      security:
      - ApiKey: []
      - SessionToken: []
      requestBody:
        required: true
        content:
          application/json:
            schema:
              oneOf:
              - type: object
                properties:
                  kind:
                    type: string
                    const: lease
                  file:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                      contentType:
                        type: string
                        minLength: 1
                        maxLength: 100
                      contentBase64:
                        type: string
                        minLength: 1
                    required:
                    - name
                    - contentType
                    - contentBase64
                    additionalProperties: false
                required:
                - kind
                - file
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    const: correspondence
                  files:
                    minItems: 1
                    maxItems: 10
                    type: array
                    items:
                      type: object
                      properties:
                        name:
                          type: string
                          minLength: 1
                          maxLength: 255
                        contentType:
                          type: string
                          minLength: 1
                          maxLength: 100
                        contentBase64:
                          type: string
                          minLength: 1
                      required:
                      - name
                      - contentType
                      - contentBase64
                      additionalProperties: false
                required:
                - kind
                - files
                additionalProperties: false
              - type: object
                properties:
                  kind:
                    type: string
                    const: ledger
                  file:
                    type: object
                    properties:
                      name:
                        type: string
                        minLength: 1
                        maxLength: 255
                      contentType:
                        type: string
                        minLength: 1
                        maxLength: 100
                      contentBase64:
                        type: string
                        minLength: 1
                    required:
                    - name
                    - contentType
                    - contentBase64
                    additionalProperties: false
                required:
                - kind
                - file
                additionalProperties: false
      responses:
        '200':
          description: '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).'
          content:
            application/json:
              schema:
                oneOf:
                - type: object
                  required:
                  - suggestions
                  - confidence
                  properties:
                    suggestions:
                      type: object
                      additionalProperties: false
                      properties:
                        line1:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        unit:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        city:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        state:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        zip:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        ownerOfRecord:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        leaseStart:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        leaseEnd:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        monthlyRent:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        noticePeriod:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: lease_file
                        parties:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: array
                              items:
                                type: object
                                required:
                                - role
                                - name
                                - isEntity
                                properties:
                                  role:
                                    enum:
                                    - plaintiff
                                    - defendant
                                  name:
                                    type: string
                                  isEntity:
                                    type: boolean
                            source:
                              const: lease_file
                        violationDescription:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                            source:
                              const: messages
                        violationDate:
                          type: object
                          required:
                          - value
                          - source
                          properties:
                            value:
                              type: string
                              format: date
                            source:
                              const: messages
                    confidence:
                      type: object
                      additionalProperties:
                        enum:
                        - high
                        - medium
                - type: object
                  required:
                  - rows
                  - openingBalanceCents
                  - endingBalanceCents
                  additionalProperties: false
                  description: 'For `kind: "ledger"`.'
                  properties:
                    rows:
                      type: array
                      maxItems: 500
                      items:
                        type: object
                        required:
                        - date
                        - type
                        - amountCents
                        - memo
                        additionalProperties: false
                        properties:
                          date:
                            type: string
                            format: date
                          type:
                            enum:
                            - charge
                            - payment
                          amountCents:
                            type: integer
                            minimum: 1
                            description: Whole cents, always positive; `type` says which way it moves the balance.
                          memo:
                            type: string
                            maxLength: 200
                    openingBalanceCents:
                      type:
                      - integer
                      - 'null'
                      description: A balance brought forward from before the first row, in whole cents (negative for a credit); null when the ledger shows none. It is not among `rows`.
                    endingBalanceCents:
                      type:
                      - integer
                      - 'null'
                      description: The balance the ledger states at its end, in whole cents (negative for a credit); null when it states none. `openingBalanceCents` plus the rows should come to it.
        '400':
          description: '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).'
          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'
        '413':
          description: '`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).'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '415':
          description: '`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.'
          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'
        '429':
          description: '`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.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
        '503':
          description: '`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.'
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Error'
      tags:
      - Extract
      operationId: postV1Extract
      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