extract-residential-lease-data

Extract Residential Lease Data

Property managers use this recipe to extract residential lease terms into structured records for tenant onboarding, rent collection, and compliance workflows.

APIs Used

Document Extraction (1 credit per page)

Prerequisites

You need an Iteration Layer API key. Get one at platform.iterationlayer.com during the 7-day trial.

For full integration guidance (SDKs, auth, MCP, error handling), see the Iteration Layer Integration Guide.

Implementation

curl -X POST https://api.iterationlayer.com/document-extraction/v1/extract \
  -H "Authorization: Bearer YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
  "files": [
    {
      "type": "url",
      "name": "residential-lease.pdf",
      "url": "https://example.com/documents/residential-lease-sample.pdf"
    }
  ],
  "schema": {
    "fields": [
      {
        "name": "landlord_name",
        "type": "TEXT",
        "description": "Landlord or property manager name"
      },
      {
        "name": "tenant_names",
        "type": "TEXT",
        "description": "Tenant names"
      },
      {
        "name": "property_address",
        "type": "ADDRESS",
        "description": "Rental property address"
      },
      {
        "name": "lease_start_date",
        "type": "DATE",
        "description": "Lease start date"
      },
      {
        "name": "lease_end_date",
        "type": "DATE",
        "description": "Lease end date"
      },
      {
        "name": "monthly_rent",
        "type": "CURRENCY_AMOUNT",
        "description": "Monthly rent"
      },
      {
        "name": "rent_due_day",
        "type": "DATE",
        "description": "Rent due date or day of month"
      },
      {
        "name": "security_deposit",
        "type": "CURRENCY_AMOUNT",
        "description": "Security deposit"
      },
      {
        "name": "utilities_responsibility",
        "type": "TEXT",
        "description": "Utility responsibility terms"
      },
      {
        "name": "occupants",
        "type": "TEXT",
        "description": "Authorized occupants"
      },
      {
        "name": "pet_terms",
        "type": "TEXT",
        "description": "Pet policy or pet deposit terms"
      },
      {
        "name": "late_fee_terms",
        "type": "TEXT",
        "description": "Late fee terms"
      }
    ]
  }
}'