Extract Rental Application

Extract applicant details, employment history, income, and references from a rental application form into structured JSON for tenant screening.

Who this is for

Property managers and landlords use this recipe to digitize a tenant application. Upload a rental application PDF and receive structured JSON with applicant info, employment history, and references — ready for your tenant screening workflow.

Request
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": "rental-application.pdf",
        "url": "https://example.com/applications/rental-application.pdf"
      }
    ],
    "schema": {
      "fields": [
        {
          "name": "applicant_name",
          "type": "TEXT",
          "description": "Full name of the applicant"
        },
        {
          "name": "current_address",
          "type": "ADDRESS",
          "description": "Applicant current address"
        },
        {
          "name": "employer",
          "type": "TEXT",
          "description": "Current employer name"
        },
        {
          "name": "monthly_income",
          "type": "CURRENCY_AMOUNT",
          "description": "Gross monthly income"
        },
        {
          "name": "move_in_date",
          "type": "DATE",
          "description": "Requested move-in date"
        },
        {
          "name": "previous_landlord",
          "type": "TEXT",
          "description": "Previous landlord name and contact"
        }
      ]
    }
  }'
Response
{
  "success": true,
  "data": {
    "applicant_name": {
      "value": "David Kim",
      "confidence": 0.99,
      "citations": ["Applicant: David Kim"]
    },
    "current_address": {
      "value": {
        "street": "742 Evergreen Terrace",
        "city": "Portland",
        "region": "OR",
        "postal_code": "97201",
        "country": "US"
      },
      "confidence": 0.95,
      "citations": [
        "742 Evergreen Terrace, Portland, OR 97201"
      ]
    },
    "employer": {
      "value": "Cascade Health Systems",
      "confidence": 0.97,
      "citations": [
        "Employer: Cascade Health Systems"
      ]
    },
    "monthly_income": {
      "value": {
        "amount": "6,200.00",
        "currency": "USD"
      },
      "confidence": 0.96,
      "citations": [
        "Gross Monthly Income: $6,200"
      ]
    },
    "move_in_date": {
      "value": "2026-05-01",
      "confidence": 0.98,
      "citations": [
        "Desired Move-In: May 1, 2026"
      ]
    },
    "previous_landlord": {
      "value": "Janet Morales, (503) 555-0147",
      "confidence": 0.94,
      "citations": [
        "Previous Landlord: Janet Morales (503) 555-0147"
      ]
    }
  }
}
Request
import { IterationLayer } from "iterationlayer";
const client = new IterationLayer({ apiKey: "YOUR_API_KEY" });

const result = await client.extract({
  files: [
    {
      type: "url",
      name: "rental-application.pdf",
      url: "https://example.com/applications/rental-application.pdf",
    },
  ],
  schema: {
    fields: [
      {
        name: "applicant_name",
        type: "TEXT",
        description: "Full name of the applicant",
      },
      {
        name: "current_address",
        type: "ADDRESS",
        description: "Applicant current address",
      },
      {
        name: "employer",
        type: "TEXT",
        description: "Current employer name",
      },
      {
        name: "monthly_income",
        type: "CURRENCY_AMOUNT",
        description: "Gross monthly income",
      },
      {
        name: "move_in_date",
        type: "DATE",
        description: "Requested move-in date",
      },
      {
        name: "previous_landlord",
        type: "TEXT",
        description: "Previous landlord name and contact",
      },
    ],
  },
});

console.log(result);
Response
{
  "success": true,
  "data": {
    "applicant_name": {
      "value": "David Kim",
      "confidence": 0.99,
      "citations": ["Applicant: David Kim"]
    },
    "current_address": {
      "value": {
        "street": "742 Evergreen Terrace",
        "city": "Portland",
        "region": "OR",
        "postal_code": "97201",
        "country": "US"
      },
      "confidence": 0.95,
      "citations": [
        "742 Evergreen Terrace, Portland, OR 97201"
      ]
    },
    "employer": {
      "value": "Cascade Health Systems",
      "confidence": 0.97,
      "citations": [
        "Employer: Cascade Health Systems"
      ]
    },
    "monthly_income": {
      "value": {
        "amount": "6,200.00",
        "currency": "USD"
      },
      "confidence": 0.96,
      "citations": [
        "Gross Monthly Income: $6,200"
      ]
    },
    "move_in_date": {
      "value": "2026-05-01",
      "confidence": 0.98,
      "citations": [
        "Desired Move-In: May 1, 2026"
      ]
    },
    "previous_landlord": {
      "value": "Janet Morales, (503) 555-0147",
      "confidence": 0.94,
      "citations": [
        "Previous Landlord: Janet Morales (503) 555-0147"
      ]
    }
  }
}
Request
from iterationlayer import IterationLayer
client = IterationLayer(api_key="YOUR_API_KEY")

result = client.extract(
    files=[
        {
            "type": "url",
            "name": "rental-application.pdf",
            "url": "https://example.com/applications/rental-application.pdf",
        }
    ],
    schema={
        "fields": [
            {
                "name": "applicant_name",
                "type": "TEXT",
                "description": "Full name of the applicant",
            },
            {
                "name": "current_address",
                "type": "ADDRESS",
                "description": "Applicant current address",
            },
            {
                "name": "employer",
                "type": "TEXT",
                "description": "Current employer name",
            },
            {
                "name": "monthly_income",
                "type": "CURRENCY_AMOUNT",
                "description": "Gross monthly income",
            },
            {
                "name": "move_in_date",
                "type": "DATE",
                "description": "Requested move-in date",
            },
            {
                "name": "previous_landlord",
                "type": "TEXT",
                "description": "Previous landlord name and contact",
            },
        ]
    },
)

print(result)
Response
{
  "success": true,
  "data": {
    "applicant_name": {
      "value": "David Kim",
      "confidence": 0.99,
      "citations": ["Applicant: David Kim"]
    },
    "current_address": {
      "value": {
        "street": "742 Evergreen Terrace",
        "city": "Portland",
        "region": "OR",
        "postal_code": "97201",
        "country": "US"
      },
      "confidence": 0.95,
      "citations": [
        "742 Evergreen Terrace, Portland, OR 97201"
      ]
    },
    "employer": {
      "value": "Cascade Health Systems",
      "confidence": 0.97,
      "citations": [
        "Employer: Cascade Health Systems"
      ]
    },
    "monthly_income": {
      "value": {
        "amount": "6,200.00",
        "currency": "USD"
      },
      "confidence": 0.96,
      "citations": [
        "Gross Monthly Income: $6,200"
      ]
    },
    "move_in_date": {
      "value": "2026-05-01",
      "confidence": 0.98,
      "citations": [
        "Desired Move-In: May 1, 2026"
      ]
    },
    "previous_landlord": {
      "value": "Janet Morales, (503) 555-0147",
      "confidence": 0.94,
      "citations": [
        "Previous Landlord: Janet Morales (503) 555-0147"
      ]
    }
  }
}
Request
package main

import (
    "fmt"
    il "github.com/iterationlayer/sdk-go"
)

func main() {
    client := il.NewClient("YOUR_API_KEY")

    result, err := client.Extract(il.ExtractRequest{
        Files: []il.FileInput{
            il.NewFileFromURL(
                "rental-application.pdf",
                "https://example.com/applications/rental-application.pdf",
            ),
        },
        Schema: il.ExtractionSchema{
            "applicant_name": il.NewTextFieldConfig(
                "applicant_name",
                "Full name of the applicant",
            ),
            "current_address": il.NewAddressFieldConfig(
                "current_address",
                "Applicant current address",
            ),
            "employer": il.NewTextFieldConfig(
                "employer", "Current employer name",
            ),
            "monthly_income": il.NewCurrencyAmountFieldConfig(
                "monthly_income",
                "Gross monthly income",
            ),
            "move_in_date": il.NewDateFieldConfig(
                "move_in_date",
                "Requested move-in date",
            ),
            "previous_landlord": il.NewTextFieldConfig(
                "previous_landlord",
                "Previous landlord name and contact",
            ),
        },
    })
    if err != nil {
        panic(err)
    }

    fmt.Println(result)
}
Response
{
  "success": true,
  "data": {
    "applicant_name": {
      "value": "David Kim",
      "confidence": 0.99,
      "citations": ["Applicant: David Kim"]
    },
    "current_address": {
      "value": {
        "street": "742 Evergreen Terrace",
        "city": "Portland",
        "region": "OR",
        "postal_code": "97201",
        "country": "US"
      },
      "confidence": 0.95,
      "citations": [
        "742 Evergreen Terrace, Portland, OR 97201"
      ]
    },
    "employer": {
      "value": "Cascade Health Systems",
      "confidence": 0.97,
      "citations": [
        "Employer: Cascade Health Systems"
      ]
    },
    "monthly_income": {
      "value": {
        "amount": "6,200.00",
        "currency": "USD"
      },
      "confidence": 0.96,
      "citations": [
        "Gross Monthly Income: $6,200"
      ]
    },
    "move_in_date": {
      "value": "2026-05-01",
      "confidence": 0.98,
      "citations": [
        "Desired Move-In: May 1, 2026"
      ]
    },
    "previous_landlord": {
      "value": "Janet Morales, (503) 555-0147",
      "confidence": 0.94,
      "citations": [
        "Previous Landlord: Janet Morales (503) 555-0147"
      ]
    }
  }
}

Related Recipes

Start building in minutes

Free trial credits included. No credit card required.