Rental agreement settings

Agreement templates and the clause library, the stamp-duty table and company rules, e-sign status and e-stamp credits; inspection templates and the inspection & deposit settings.

GET/v1/settings/agreement-clauses

The clause library

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.view.

Response · 200

datarequired: AgreementClauseLibrary
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/agreement-clauses' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "clauses": [
      {
        "key": "string",
        "category": "string",
        "title": "string",
        "body": "string",
        "states": [
          "string"
        ],
        "kinds": [
          "string"
        ],
        "needs": [
          "string"
        ],
        "version": 0,
        "origin": "system",
        "id": "string",
        "status": "active",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "archived": [
      {
        "key": "string",
        "category": "string",
        "title": "string",
        "body": "string",
        "states": [
          "string"
        ],
        "kinds": [
          "string"
        ],
        "needs": [
          "string"
        ],
        "version": 0,
        "origin": "system",
        "id": "string",
        "status": "active",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "categories": [
      {
        "key": "string",
        "label": "string"
      }
    ],
    "fields": [
      {
        "key": "string",
        "label": "string",
        "group": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/agreement-clauses

Add a clause of the company

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body

category: "rent_deposit" | "maintenance" | "utilities" | "escalation" | "lock_in" | "notice" | …
title: string
body: string
states: array of IndianStateCode
Empty: every state.
kinds: array of AgreementDocumentKind
Empty: every kind.
status: "active" | "archived"
expected_version: integer or null

Response · 201

datarequired: AgreementClause
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/agreement-clauses' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"category":"rent_deposit","title":"string","body":"string","states":["AN"],"kinds":["leave_licence"],"status":"active","expected_version":0}'

Response example

{
  "data": {
    "key": "string",
    "category": "string",
    "title": "string",
    "body": "string",
    "states": [
      "string"
    ],
    "kinds": [
      "string"
    ],
    "needs": [
      "string"
    ],
    "version": 0,
    "origin": "system",
    "id": "string",
    "status": "active",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/agreement-clauses/{key}

Save a clause (PropZolo’s are copied on the first save)

Archiving the copy of a PropZolo clause hides it from new drafts; every save is a new version.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Parameters

keypathrequired: string

Request body

category: "rent_deposit" | "maintenance" | "utilities" | "escalation" | "lock_in" | "notice" | …
title: string
body: string
states: array of IndianStateCode
Empty: every state.
kinds: array of AgreementDocumentKind
Empty: every kind.
status: "active" | "archived"
expected_version: integer or null

Response · 200

datarequired: AgreementClause
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/agreement-clauses/{key}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"category":"rent_deposit","title":"string","body":"string","states":["AN"],"kinds":["leave_licence"],"status":"active","expected_version":0}'

Response example

{
  "data": {
    "key": "string",
    "category": "string",
    "title": "string",
    "body": "string",
    "states": [
      "string"
    ],
    "kinds": [
      "string"
    ],
    "needs": [
      "string"
    ],
    "version": 0,
    "origin": "system",
    "id": "string",
    "status": "active",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/agreement-templates

Agreement templates

PropZolo’s templates (read-only) and the company’s own copies.

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.view.

Response · 200

datarequired: AgreementTemplateList
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/agreement-templates' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "templates": [
      {
        "key": "string",
        "origin": "system",
        "system_key": "string",
        "kind": "leave_licence",
        "states": [
          "string"
        ],
        "title": "string",
        "description": "string",
        "execution": "notarised",
        "version": 0,
        "status": "active",
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "fields": [
      {
        "key": "string",
        "label": "string",
        "group": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/agreement-templates

Copy a template to edit it

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Request body

fromrequired: string
key: string or null
title: string or null

Response · 201

datarequired: AgreementTemplate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/agreement-templates' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"from":"string","key":"string","title":"string"}'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "system_key": "string",
    "kind": "leave_licence",
    "states": [
      "string"
    ],
    "title": "string",
    "description": "string",
    "execution": "notarised",
    "version": 0,
    "status": "active",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "blocks": [
      {
        "kind": "heading",
        "text": "string"
      }
    ],
    "slots": [
      {
        "key": "string",
        "required": true,
        "included": true
      }
    ],
    "versions": [
      {
        "version": 0,
        "title": "string",
        "change_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "problems": [
      "string"
    ],
    "editable": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/agreement-templates/{key}

An agreement template with its versions

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.view.

Parameters

keypathrequired: string

Response · 200

datarequired: AgreementTemplate
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/agreement-templates/{key}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "system_key": "string",
    "kind": "leave_licence",
    "states": [
      "string"
    ],
    "title": "string",
    "description": "string",
    "execution": "notarised",
    "version": 0,
    "status": "active",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "blocks": [
      {
        "kind": "heading",
        "text": "string"
      }
    ],
    "slots": [
      {
        "key": "string",
        "required": true,
        "included": true
      }
    ],
    "versions": [
      {
        "version": 0,
        "title": "string",
        "change_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "problems": [
      "string"
    ],
    "editable": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PATCH/v1/settings/agreement-templates/{key}

Save a new version of a company template

Access: Signed-in members only (web or Android session) — not for API keys. Permission templates.edit.

Parameters

keypathrequired: string

Request body

title: string
description: string or null
states: array of IndianStateCode
ISO 3166-2:IN (TS = Telangana).
execution: AgreementExecution
blocks: array of AgreementTemplateBlockInput
slots: array of object
slots[].keyrequired: string
slots[].requiredrequired: boolean
slots[].includedrequired: boolean
status: "active" | "archived"
change_note: string or null
expected_version: integer or null

Response · 200

datarequired: AgreementTemplate
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/agreement-templates/{key}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","description":"string","states":["AN"],"execution":"notarised","blocks":[{"kind":"heading","text":"string"}],"slots":[{"key":"string","required":true,"included":true}],"status":"active","change_note":"string","expected_version":1}'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "system_key": "string",
    "kind": "leave_licence",
    "states": [
      "string"
    ],
    "title": "string",
    "description": "string",
    "execution": "notarised",
    "version": 0,
    "status": "active",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "blocks": [
      {
        "kind": "heading",
        "text": "string"
      }
    ],
    "slots": [
      {
        "key": "string",
        "required": true,
        "included": true
      }
    ],
    "versions": [
      {
        "version": 0,
        "title": "string",
        "change_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "created_by": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        }
      }
    ],
    "problems": [
      "string"
    ],
    "editable": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/e-sign

e-sign status and e-stamp credits

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.integrations or settings.view.

Response · 200

datarequired: ESignSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/e-sign' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "configured": true,
    "provider": "string",
    "credits": [
      {
        "state": "string",
        "denomination": 850000000,
        "available": 0
      }
    ],
    "entries": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "state": "string",
        "denomination": 850000000,
        "quantity": 0,
        "kind": "string",
        "note": "string",
        "balance_after": 0,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/inspection-templates

Inspection templates

PropZolo’s (as shipped or edited) and the company’s own.

Access: API key or member session. Permission settings.pipelines or settings.view.

Response · 200

datarequired: array of InspectionTemplate
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/inspection-templates' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "key": "string",
      "origin": "system",
      "property_kind": "1rk",
      "title": "string",
      "version": 0,
      "status": "active",
      "body": {
        "rooms": [
          {
            "key": "string",
            "type": "entrance",
            "label": "string",
            "items": [
              null
            ]
          }
        ],
        "meters": [
          {
            "key": "string",
            "type": "electricity",
            "label": "string",
            "unit": "kWh"
          }
        ],
        "inventory": [
          {
            "key": "string",
            "label": "string",
            "category": "furniture",
            "room_type": null,
            "quantity": 0,
            "per": "home",
            "furnishing": "any",
            "replacement_value": null
          }
        ],
        "keys": [
          {
            "key": "string",
            "label": "string",
            "count": 0,
            "per": "home"
          }
        ]
      },
      "rooms": 0,
      "items": 0,
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/inspection-templates

Add an inspection template

Access: API key or member session. Permission settings.pipelines.

Request body

titlerequired: string
property_kindrequired: "1rk" | "1bhk" | "2bhk" | "3bhk" | "4bhk" | "villa" | …
bodyrequired: InspectionTemplateBodyInput

Response · 201

datarequired: InspectionTemplate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/inspection-templates' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","property_kind":"1rk","body":{"rooms":[{"key":"string","type":"entrance","label":"string","items":[{"key":"string","label":"string","photo":false}]}],"meters":[{"key":"string","type":"electricity","label":"string","unit":"kWh"}],"inventory":[{"key":"string","label":"string","category":"furniture","room_type":null,"quantity":0,"per":"home","furnishing":"any","replacement_value":null}],"keys":[{"key":"string","label":"string","count":0,"per":"home"}]}}'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "property_kind": "1rk",
    "title": "string",
    "version": 0,
    "status": "active",
    "body": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh"
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": null,
          "quantity": 0,
          "per": "home",
          "furnishing": "any",
          "replacement_value": null
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "per": "home"
        }
      ]
    },
    "rooms": 0,
    "items": 0,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/inspection-templates/{key}

Save an inspection template

PropZolo’s template: saves the company’s edited copy. Inspections keep their own snapshot.

Access: API key or member session. Permission settings.pipelines.

Parameters

keypathrequired: string

Request body

titlerequired: string
property_kindrequired: "1rk" | "1bhk" | "2bhk" | "3bhk" | "4bhk" | "villa" | …
bodyrequired: InspectionTemplateBodyInput

Response · 200

datarequired: InspectionTemplate
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/inspection-templates/{key}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","property_kind":"1rk","body":{"rooms":[{"key":"string","type":"entrance","label":"string","items":[{"key":"string","label":"string","photo":false}]}],"meters":[{"key":"string","type":"electricity","label":"string","unit":"kWh"}],"inventory":[{"key":"string","label":"string","category":"furniture","room_type":null,"quantity":0,"per":"home","furnishing":"any","replacement_value":null}],"keys":[{"key":"string","label":"string","count":0,"per":"home"}]}}'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "property_kind": "1rk",
    "title": "string",
    "version": 0,
    "status": "active",
    "body": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh"
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": null,
          "quantity": 0,
          "per": "home",
          "furnishing": "any",
          "replacement_value": null
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "per": "home"
        }
      ]
    },
    "rooms": 0,
    "items": 0,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/inspection-templates/{key}/archive

Archive / restore a template, or reset an edited PropZolo template

Access: API key or member session. Permission settings.pipelines.

Parameters

keypathrequired: string

Request body

restore: boolean

Response · 200

datarequired: InspectionTemplate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/inspection-templates/{key}/archive' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"restore":false}'

Response example

{
  "data": {
    "key": "string",
    "origin": "system",
    "property_kind": "1rk",
    "title": "string",
    "version": 0,
    "status": "active",
    "body": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh"
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": null,
          "quantity": 0,
          "per": "home",
          "furnishing": "any",
          "replacement_value": null
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "per": "home"
        }
      ]
    },
    "rooms": 0,
    "items": 0,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/police-verification-rules

Police verification rules

PropZolo’s city and state rules (sources, dates, [U] flags) and the company’s own rules.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines or settings.view.

Response · 200

datarequired: PoliceRulesTable
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/police-verification-rules' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "system": [
      {
        "id": "string",
        "origin": "system",
        "label": "string",
        "authority": "string",
        "online": {
          "name": "string",
          "url": "string",
          "steps": "string"
        },
        "offline": "string",
        "documents": [
          "string"
        ],
        "legal_basis": "string",
        "fee": "string",
        "source": {
          "title": "string",
          "url": "string",
          "retrieved_on": "string"
        },
        "verified": true,
        "note": "string",
        "city": "string",
        "state": "string",
        "fields": [
          "string"
        ],
        "deadline": {
          "basis": "string",
          "days": 0
        },
        "effective_from": "2026-10-06",
        "effective_to": "2026-10-06"
      }
    ],
    "company": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "city": "string",
        "state": "string",
        "effective_from": "2026-10-06",
        "rule": {
          "label": "string",
          "authority": "string",
          "online": {
            "name": "string",
            "url": "https://example.com",
            "steps": "string"
          },
          "offline": "string",
          "fields": [
            "owner_name"
          ],
          "documents": [
            "string"
          ],
          "deadline": {
            "basis": "before_move_in",
            "days": 0
          },
          "legal_basis": "string",
          "fee": "string"
        },
        "source": "string",
        "note": "string",
        "valid": true,
        "updated_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "cities": [
      {
        "key": "string",
        "label": "string",
        "state": "string"
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/police-verification-rules

Add or change a company police verification rule

Audited with before/after. Step-up for Owner/Admin sessions.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Request body

id: Id or null
Opaque record id.
cityrequired: string
staterequired: string
effective_fromrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rulerequired: object
rule.labelrequired: string
rule.authorityrequired: string
rule.onlinerequired: object or null
rule.online.namerequired: string
rule.online.urlrequired: string (uri)
rule.online.stepsrequired: string
rule.offlinerequired: string
rule.fieldsrequired: array of "owner_name" | "owner_phone" | "owner_email" | "owner_address" | "premises_address" | "premises_police_station" | …
rule.documentsrequired: array of string
rule.deadlinerequired: object
rule.deadline.basisrequired: "before_move_in" | "after_move_in"
rule.deadline.daysrequired: integer
rule.legal_basisrequired: string
rule.feerequired: string or null
source: string or null
note: string or null

Response · 200

datarequired: PoliceRuleOverride
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/police-verification-rules' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"id":"cmusrceel0000q7kaafxqi1om","city":"string","state":"string","effective_from":"2026-10-06","rule":{"label":"string","authority":"string","online":{"name":"string","url":"https://example.com","steps":"string"},"offline":"string","fields":["owner_name"],"documents":["string"],"deadline":{"basis":"before_move_in","days":0},"legal_basis":"string","fee":"string"},"source":"string","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "city": "string",
    "state": "string",
    "effective_from": "2026-10-06",
    "rule": {
      "label": "string",
      "authority": "string",
      "online": {
        "name": "string",
        "url": "https://example.com",
        "steps": "string"
      },
      "offline": "string",
      "fields": [
        "owner_name"
      ],
      "documents": [
        "string"
      ],
      "deadline": {
        "basis": "before_move_in",
        "days": 0
      },
      "legal_basis": "string",
      "fee": "string"
    },
    "source": "string",
    "note": "string",
    "valid": true,
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/settings/police-verification-rules/{id}

Remove a company police verification rule

PropZolo’s rule applies again. Audited; step-up for Owner/Admin sessions.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/settings/police-verification-rules/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/rental-compliance

KYC and police verification settings

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines or settings.view.

Response · 200

datarequired: RentalComplianceSettingsView
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/rental-compliance' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "kyc": {
      "aadhaar": true,
      "pan": true,
      "offline_aadhaar": true,
      "photo": true,
      "request_days": 1
    },
    "police": {
      "track_new": true,
      "reminders": true
    },
    "configured": true,
    "partner": "string",
    "retention_days": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/rental-compliance

Change the KYC and police verification settings

Audited with before/after.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Request body

kycrequired: object
kyc.aadhaarrequired: boolean
kyc.panrequired: boolean
kyc.offline_aadhaarrequired: boolean
kyc.photorequired: boolean
kyc.request_daysrequired: integer
policerequired: object
police.track_newrequired: boolean
police.remindersrequired: boolean

Response · 200

datarequired: RentalComplianceSettingsView
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/rental-compliance' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kyc":{"aadhaar":true,"pan":true,"offline_aadhaar":true,"photo":true,"request_days":1},"police":{"track_new":true,"reminders":true}}'

Response example

{
  "data": {
    "kyc": {
      "aadhaar": true,
      "pan": true,
      "offline_aadhaar": true,
      "photo": true,
      "request_days": 1
    },
    "police": {
      "track_new": true,
      "reminders": true
    },
    "configured": true,
    "partner": "string",
    "retention_days": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/rental-inspections

Inspection and deposit settings

Access: API key or member session. Permission settings.pipelines or settings.view.

Response · 200

datarequired: RentalInspectionSettings
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/rental-inspections' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "capture": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 5
    },
    "signing": {
      "link_days": 1
    },
    "reminders": {
      "move_in_days": 0,
      "move_out_days": 0
    },
    "rates": {
      "electricity": 0,
      "water": 0,
      "gas": 0,
      "cleaning_per_room": 0,
      "key_replacement": 0,
      "damage_minor": 0,
      "damage_major": 0
    },
    "deposit": {
      "refund_days": 1,
      "escrow": true,
      "brokerage": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

PUT/v1/settings/rental-inspections

Change the inspection and deposit settings

Audited.

Access: API key or member session. Permission settings.pipelines.

Request body

capturerequired: object
capture.photos_per_roomrequired: integer
capture.meter_photorequired: boolean
capture.video_max_mbrequired: integer
signingrequired: object
signing.link_daysrequired: integer
remindersrequired: object
reminders.move_in_daysrequired: integer
reminders.move_out_daysrequired: integer
ratesrequired: object
Paise (per unit for meters); null: the agent decides each amount.
rates.electricityrequired: integer or null
rates.waterrequired: integer or null
rates.gasrequired: integer or null
rates.cleaning_per_roomrequired: integer or null
rates.key_replacementrequired: integer or null
rates.damage_minorrequired: integer or null
rates.damage_majorrequired: integer or null
depositrequired: object
deposit.refund_daysrequired: integer
deposit.escrowrequired: boolean
deposit.brokeragerequired: boolean

Response · 200

datarequired: RentalInspectionSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/rental-inspections' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"capture":{"photos_per_room":0,"meter_photo":true,"video_max_mb":5},"signing":{"link_days":1},"reminders":{"move_in_days":0,"move_out_days":0},"rates":{"electricity":0,"water":0,"gas":0,"cleaning_per_room":0,"key_replacement":0,"damage_minor":0,"damage_major":0},"deposit":{"refund_days":1,"escrow":true,"brokerage":true}}'

Response example

{
  "data": {
    "capture": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 5
    },
    "signing": {
      "link_days": 1
    },
    "reminders": {
      "move_in_days": 0,
      "move_out_days": 0
    },
    "rates": {
      "electricity": 0,
      "water": 0,
      "gas": 0,
      "cleaning_per_room": 0,
      "key_replacement": 0,
      "damage_minor": 0,
      "damage_major": 0
    },
    "deposit": {
      "refund_days": 1,
      "escrow": true,
      "brokerage": true
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

GET/v1/settings/stamp-duty

The stamp-duty table

PropZolo’s rules (with sources, effective dates and [U] flags) and the company’s own.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines or settings.view.

Response · 200

datarequired: StampDutyTable
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/settings/stamp-duty' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "system": [
      {
        "id": "string",
        "state": "string",
        "kinds": [
          "string"
        ],
        "label": "string",
        "effective_from": "2026-10-06",
        "effective_to": "2026-10-06",
        "verified": true,
        "source": {
          "title": "string",
          "url": "string",
          "retrieved_on": "2026-10-06"
        },
        "note": "string",
        "rule": {}
      }
    ],
    "overrides": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "state": "string",
        "kind": "string",
        "effective_from": "2026-10-06",
        "rule": {},
        "source": "string",
        "note": "string",
        "updated_at": "2026-10-06T05:30:00.000Z",
        "invalid": true
      }
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/stamp-duty

Add or change a company stamp-duty rule

Audited with before/after. Step-up for Owner/Admin sessions.

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Request body

id: Id or null
Opaque record id.
staterequired: IndianStateCode
ISO 3166-2:IN (TS = Telangana).
kindrequired: "leave_licence" | "rent_11m" | "lease_deed" | "any"
effective_fromrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
rulerequired: map of any
Rate bands (basis points or a fixed duty), deposit treatment, minimum, maximum, rounding, registration fee — paise as numbers.
source: string or null
note: string or null

Response · 200

datarequired: StampDutyOverride
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/stamp-duty' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"id":"cmusrceel0000q7kaafxqi1om","state":"AN","kind":"leave_licence","effective_from":"2026-10-06","rule":{},"source":"string","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "state": "string",
    "kind": "string",
    "effective_from": "2026-10-06",
    "rule": {},
    "source": "string",
    "note": "string",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "invalid": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/settings/stamp-duty/estimate

Try the stamp-duty calculator

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines or settings.view.

Request body

staterequired: IndianStateCode
ISO 3166-2:IN (TS = Telangana).
kindrequired: AgreementDocumentKind
onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
startrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
endrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
monthly_rentrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
escalation_pct: string or null
deposit: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
non_refundable: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
area: "urban" | "rural"
registered: boolean

Response · 200

datarequired: StampDutyEstimate
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/settings/stamp-duty/estimate' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"state":"AN","kind":"leave_licence","on":"2026-10-06","start":"2026-10-06","end":"2026-10-06","monthly_rent":0,"escalation_pct":"string","deposit":0,"non_refundable":0,"area":"urban","registered":false}'

Response example

{
  "data": {
    "status": "estimated",
    "rule": {
      "id": "string",
      "label": "string",
      "effective_from": "2026-10-06",
      "source": {
        "title": "string",
        "url": "string",
        "retrieved_on": "2026-10-06"
      },
      "verified": true,
      "note": "string",
      "origin": "system"
    },
    "term": {
      "months": 0,
      "days": 0
    },
    "total_rent": 850000000,
    "average_annual_rent": 850000000,
    "base_lines": [
      {
        "label": "string",
        "amount": 850000000
      }
    ],
    "base": 850000000,
    "duty": 850000000,
    "registration_required": true,
    "registration_fee": 850000000,
    "extra": {
      "label": "string",
      "amount": 850000000
    },
    "total": 850000000,
    "e_stamp": true,
    "warnings": [
      "string"
    ]
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
409 A unique value already exists, a concurrent change won, or the Idempotency-Key is still in use or was sent with a different request.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

DELETE/v1/settings/stamp-duty/{id}

Remove a company stamp-duty rule

Access: Signed-in members only (web or Android session) — not for API keys. Permission settings.pipelines.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.deletedrequired: true
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/settings/stamp-duty/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "deleted": true
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
422 Invalid input; `error.fields` maps field paths to messages.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.