V1OrderIn

{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://artifacts.apis.io/heritagedeed-com/json-schema/heritagedeed-com-v1-order-in-schema.json",
  "title": "V1OrderIn",
  "description": "One order. `state` and `county` are required for a title search and optional for an environmental report.",
  "x-generated": "2026-11-11",
  "x-method": "derived",
  "x-generator": "derive-json-schema.py",
  "x-source": "openapi/_original/heritagedeed-com-api-openapi.json#/components/schemas/V1OrderIn",
  "properties": {
    "report_type": {
      "type": "string",
      "title": "Report Type",
      "description": "A report type id from GET /v1/report-types.",
      "default": "current_owner"
    },
    "address": {
      "type": "string",
      "maxLength": 500,
      "title": "Address",
      "description": "Full street address with house number."
    },
    "state": {
      "type": "string",
      "maxLength": 20,
      "title": "State",
      "description": "Two-letter state code (title search).",
      "default": ""
    },
    "county": {
      "type": "string",
      "maxLength": 100,
      "title": "County",
      "description": "County name without 'County' (title search).",
      "default": ""
    },
    "parcel_id": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 20
        },
        {
          "type": "null"
        }
      ],
      "title": "Parcel Id",
      "description": "Optional parcel id (NYC BBL) if you have it."
    },
    "client_reference": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 200
        },
        {
          "type": "null"
        }
      ],
      "title": "Client Reference",
      "description": "Your own id, echoed back everywhere."
    },
    "webhook_url": {
      "anyOf": [
        {
          "type": "string",
          "maxLength": 500
        },
        {
          "type": "null"
        }
      ],
      "title": "Webhook Url",
      "description": "https URL to POST a signed event to when the order completes or fails. Defaults to the key's default_webhook_url."
    }
  },
  "additionalProperties": false,
  "type": "object",
  "required": [
    "address"
  ]
}