recipes / property
recipe · 9 fields

rent / leave and licence agreement
extraction api.

A stamped agreement between the property owner (licensor / lessor) and the user (licensee / lessee). Often long; the parties, premises, rent and term are usually on the first pages.

use this recipeall recipesfrom ₹5 a document · 50 free credits
what it reads

the fields.

Rename any of them, drop the ones you don't need, or add the one your form asks for. Each comes back with the text it was read from.

fieldkeytypenotes
Agreement dateagreement_dateDate—
Owners of propertyownersTableOne row each: Owner name
User of property — nameuser_nameNameLicensee / lessee
Address line 1property_address_line_1Address—
Address line 2optionalproperty_address_line_2Address—
Area codeproperty_area_codePIN codePIN code
Monthly rentalmonthly_rentAmount (₹)—
Duration start datestart_dateDate—
Duration end dateend_dateDate—
the api

a rent / leave and licence agreement in,
json back.

Publish the recipe as a workflow and send it files. Each field returns its value, a clean normalised version, its status, the page and the source text.

curl https://api.patrapi.com/v1/workflows/wf_rent/extractions \
  -H "Authorization: Bearer $PATRAPI_KEY" \
  -F file=@rent-agreement.pdf
{ "status": "completed",
  "document_type": "rent_agreement",
  "fields": {
    "agreement_date": { "value": …, "status": "present", "page": 1 },
    "user_name": { "value": …, "status": "present", "page": 1 },
    "property_address_line_1": { "value": …, "status": "present", "page": 1 },
    "property_address_line_2": { "value": …, "status": "present", "page": 1 },
    "property_area_code": { "value": …, "status": "present", "page": 1 },
    … 4 more
  } }
more in property