Rental inspections

Move-in / move-out inspections: room-by-room checklists, ratings, EXIF/GPS-free photo and video previews, meter readings, inventory and keys, captured offline-tolerant on the phone; signatures of both parties (typed name, drawing, one-time code) that lock the inspection; corrections; move-out compared side by side with move-in.

GET/v1/rental-agreements/{id}/comparison

Move-out compared with move-in

Side by side with both inspections’ photos, meter deltas, missing inventory and keys, proposals.

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalComparison
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}/comparison' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "move_in": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "status": "string",
      "conducted_on": "2026-10-06"
    },
    "move_out": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "status": "string",
      "conducted_on": "2026-10-06"
    },
    "ready": true,
    "final": true,
    "comparison": {
      "rooms": [
        {
          "key": "string",
          "label": "string",
          "clean": {
            "before": true,
            "after": true
          },
          "needs_cleaning": true,
          "note": {
            "before": "string",
            "after": "string"
          },
          "media": {
            "before": [
              null
            ],
            "after": [
              null
            ]
          },
          "items": [
            {
              "key": null,
              "label": null,
              "before": null,
              "after": null,
              "change": null,
              "media": null
            }
          ],
          "flagged": true,
          "only_in": "move_in"
        }
      ],
      "meters": [
        {
          "key": "string",
          "label": "string",
          "type": "electricity",
          "unit": "kWh",
          "before": "string",
          "after": "string",
          "last_bill": "string",
          "consumed": "string",
          "unbilled": "string",
          "problem": "missing_reading",
          "na": {
            "before": true,
            "after": true
          },
          "media": {
            "before": [
              null
            ],
            "after": [
              null
            ]
          }
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "before": {
            "count": 0,
            "rating": "excellent"
          },
          "after": {
            "count": 0,
            "rating": "excellent"
          },
          "missing": 0,
          "change": "string",
          "replacement_value": 850000000,
          "media": {
            "before": [
              null
            ],
            "after": [
              null
            ]
          }
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "before": 0,
          "after": 0,
          "missing": 0
        }
      ],
      "summary": {
        "items_changed": 0,
        "damaged": 0,
        "missing_items": 0,
        "missing_keys": 0,
        "rooms_to_clean": 0,
        "unbilled_meters": 0
      }
    },
    "media": {},
    "proposals": [
      {
        "ref": "string",
        "source": "damage",
        "label": "string",
        "detail": "string",
        "basis": "string",
        "amount": 850000000,
        "exists": true
      }
    ],
    "rates_set": 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/rental-agreements/{id}/comparison/report

Download the comparison report

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: DownloadUrl
A short-lived signed download URL.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}/comparison/report' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "url": "string",
    "expires_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.
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/rental-agreements/{id}/comparison/report

Render the comparison report again

Queued; the PDF is added to the deal’s files with the deductions as they stand.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 202

datarequired: QueuedResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/comparison/report' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "queued": 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/rental-agreements/{id}/inspections

The inspections of a rental agreement

Tenancy dates, the move-in and move-out inspections with their corrections, and the templates.

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalInspectionsPanel
metarequired: object

Request

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

Response example

{
  "data": {
    "today": "2026-10-06",
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "string",
      "start_date": "2026-10-06",
      "end_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "tenancy": {
      "moved_in_on": "2026-10-06",
      "notice_given_on": "2026-10-06",
      "notice_by": "tenant",
      "move_out_on": "2026-10-06",
      "moved_out_on": "2026-10-06",
      "expected_move_in": "2026-10-06"
    },
    "inspections": {
      "move_in": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "kind": "move_in",
          "revision": 0,
          "correction": true,
          "status": "draft",
          "status_label": "string",
          "scheduled_on": "2026-10-06",
          "conducted_on": "2026-10-06",
          "progress": {
            "rated": 0,
            "items": 0,
            "meters_done": 0,
            "meters": 0,
            "counted": 0,
            "countable": 0,
            "photos": 0
          },
          "signatures": [
            {
              "party": null,
              "status": null,
              "signed_at": null
            }
          ],
          "locked_at": "2026-10-06T05:30:00.000Z",
          "report": {
            "status": "string",
            "document_id": "cmusrceel0000q7kaafxqi1om"
          },
          "created_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "move_out": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "kind": "move_in",
          "revision": 0,
          "correction": true,
          "status": "draft",
          "status_label": "string",
          "scheduled_on": "2026-10-06",
          "conducted_on": "2026-10-06",
          "progress": {
            "rated": 0,
            "items": 0,
            "meters_done": 0,
            "meters": 0,
            "counted": 0,
            "countable": 0,
            "photos": 0
          },
          "signatures": [
            {
              "party": null,
              "status": null,
              "signed_at": null
            }
          ],
          "locked_at": "2026-10-06T05:30:00.000Z",
          "report": {
            "status": "string",
            "document_id": "cmusrceel0000q7kaafxqi1om"
          },
          "created_at": "2026-10-06T05:30:00.000Z"
        }
      ]
    },
    "comparison": {
      "ready": true,
      "final": true
    },
    "templates": [
      {
        "key": "string",
        "title": "string",
        "property_kind": "string"
      }
    ],
    "suggested_template": "string",
    "capabilities": {
      "edit": 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.

POST/v1/rental-agreements/{id}/inspections

Start an inspection

A move-in from a template shaped by the listing, a move-out from the signed move-in. 409 while one of the kind is open, or when it is signed (record a correction instead).

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "move_in" | "move_out"
template_key: string or null
scheduled_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 201

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-agreements/{id}/inspections' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"move_in","template_key":"string","scheduled_on":"2026-10-06"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

PUT/v1/rental-agreements/{id}/tenancy

Record the move-in, the notice and the move-out

A notice stops the renewal reminders; the move-out ends the let (the agreement is terminated) and starts the deposit settlement with the refund due date.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

moved_in_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notice_given_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
notice_by: "tenant" | "landlord" | "mutual" or null
move_out_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
moved_out_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.

Response · 200

datarequired: TenancyDates
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/rental-agreements/{id}/tenancy' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"moved_in_on":"2026-10-06","notice_given_on":"2026-10-06","notice_by":"tenant","move_out_on":"2026-10-06","moved_out_on":"2026-10-06"}'

Response example

{
  "data": {
    "moved_in_on": "2026-10-06",
    "notice_given_on": "2026-10-06",
    "notice_by": "tenant",
    "move_out_on": "2026-10-06",
    "moved_out_on": "2026-10-06"
  },
  "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.

DELETE/v1/rental-inspection-media/{id}

Remove a photo / video

Drafts only; the file stays in the trail.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X DELETE 'https://api.propzolo.com/v1/rental-inspection-media/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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/rental-inspections/{id}

An inspection

Checklist, answers, photo / video previews (EXIF/GPS-free), what is missing, signatures.

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalInspection
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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/rental-inspections/{id}/answers

Save answers (offline queue)

Applies the operations in order; stale or misplaced ones are skipped and reported. Drafts only.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

opsrequired: array of InspectionOp
One change from the capture screen, stamped with the phone’s time (`at`): answers merge per answer, the newer time wins; structure changes add with phone-made keys or remove what was added and has no answer or file.

Response · 200

datarequired: SaveInspectionAnswersResult
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/rental-inspections/{id}/answers' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"ops":[{"op":"item","room":"string","item":"string","rating":"excellent","note":"string","at":"2026-10-06T05:30:00.000Z"}]}'

Response example

{
  "data": {
    "inspection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreement_id": "cmusrceel0000q7kaafxqi1om",
      "kind": "move_in",
      "revision": 0,
      "correction_of": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "revision": 0
      },
      "status": "draft",
      "status_label": "string",
      "template": {
        "key": "string",
        "version": 0
      },
      "scheduled_on": "2026-10-06",
      "conducted_on": "2026-10-06",
      "checklist": {
        "rooms": [
          {
            "key": "string",
            "type": "entrance",
            "label": "string",
            "custom": true,
            "items": [
              null
            ]
          }
        ],
        "meters": [
          {
            "key": "string",
            "type": "electricity",
            "label": "string",
            "unit": "kWh",
            "custom": true
          }
        ],
        "inventory": [
          {
            "key": "string",
            "label": "string",
            "category": "furniture",
            "room_type": "entrance",
            "quantity": 0,
            "replacement_value": 850000000,
            "custom": true
          }
        ],
        "keys": [
          {
            "key": "string",
            "label": "string",
            "count": 0,
            "custom": true
          }
        ]
      },
      "answers": {
        "items": {},
        "rooms": {},
        "meters": {},
        "inventory": {},
        "keys": {},
        "general": {
          "note": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      },
      "draft_version": 0,
      "signing_round": 0,
      "media": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "target": "string",
          "target_label": "string",
          "kind": "photo",
          "status": "processing",
          "content_type": "string",
          "size_bytes": 0,
          "width": 0,
          "height": 0,
          "duration_ms": 0,
          "caption": "string",
          "captured_at": "2026-10-06T05:30:00.000Z",
          "time_source": "string",
          "time_flags": [
            "string"
          ],
          "had_location": true,
          "exif_taken_at": "2026-10-06T05:30:00.000Z",
          "failure": "string",
          "preview_url": "string",
          "thumb_url": "string",
          "urls_expire_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "gaps": [
        {
          "code": "string",
          "target": "string",
          "text": "string"
        }
      ],
      "progress": {
        "rated": 0,
        "items": 0,
        "meters_done": 0,
        "meters": 0,
        "counted": 0,
        "countable": 0,
        "photos": 0
      },
      "content_hash": "string",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "locked_at": "2026-10-06T05:30:00.000Z",
      "superseded_at": "2026-10-06T05:30:00.000Z",
      "correction_reason": "string",
      "reopen_reason": "string",
      "cancel_reason": "string",
      "signatures": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "party": "landlord",
          "round": 0,
          "name": "string",
          "status": "pending",
          "status_label": "string",
          "method": "link",
          "phone": "string",
          "reachable": true,
          "link": {
            "status": "string",
            "expires_at": "2026-10-06T05:30:00.000Z",
            "invited_at": "2026-10-06T05:30:00.000Z",
            "opened_at": "2026-10-06T05:30:00.000Z",
            "blocked_reason": "string"
          },
          "otp": {
            "phase": "string",
            "channel": "string",
            "resend_in_sec": 0,
            "attempts_left": 0,
            "via": "string"
          },
          "typed_name": "string",
          "signed_at": "2026-10-06T05:30:00.000Z",
          "otp_channel": "string",
          "drawn": true
        }
      ],
      "report": {
        "status": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om"
      },
      "comparison": {
        "status": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "agreement": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string"
        },
        "landlord": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "tenant": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "start_date": "2026-10-06",
        "deal_id": "cmusrceel0000q7kaafxqi1om"
      },
      "baseline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "revision": 0,
        "conducted_on": "2026-10-06"
      },
      "rules": {
        "photos_per_room": 0,
        "meter_photo": true,
        "video_max_mb": 0
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "can": {
        "capture": true,
        "complete": true,
        "reopen": true,
        "cancel": true,
        "revise": true,
        "sign": true,
        "report": true
      }
    },
    "applied": 0,
    "skipped": [
      {
        "index": 0,
        "reason": "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.
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/rental-inspections/{id}/cancel

Cancel a draft

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reason: string or null

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/complete

Ready for signatures

Freezes the content with its SHA-256 (422 with what is missing). A new signing round starts.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/complete' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/media

Add an uploaded photo / video

Registered with its capture times; checked and stripped of EXIF/GPS in the background.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

targetrequired: string
keyrequired: string
content_typerequired: string
sizerequired: integer
caption: string or null
captured_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
sent_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
file_modified_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
capture_run: string or null
capture_mono_ms: number or null
send_run: string or null
send_mono_ms: number or null

Response · 201

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/media' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"target":"string","key":"string","content_type":"string","size":1,"caption":"string","captured_at":"2026-10-06T05:30:00.000Z","sent_at":"2026-10-06T05:30:00.000Z","file_modified_at":"2026-10-06T05:30:00.000Z","capture_run":"string","capture_mono_ms":0,"send_run":"string","send_mono_ms":0}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/media/uploads

Start a photo / video upload

A presigned PUT into private storage (photos up to 15 MB; videos up to the company’s limit).

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

targetrequired: string
content_typerequired: string
sizerequired: integer
filename: string or null

Response · 200

datarequired: PresignedUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/media/uploads' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"target":"string","content_type":"string","size":1,"filename":"string"}'

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z",
    "max_bytes": 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.
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/rental-inspections/{id}/reopen

Reopen for changes

Back to the draft; the round’s signatures are withdrawn (kept as such, with their evidence).

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/reopen' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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/rental-inspections/{id}/report

Download the signed inspection report

A 60-second signed URL of the PDF (both signatures, photo thumbnails, meters).

Access: API key or member session. Permission rentals.view.

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: DownloadUrl
A short-lived signed download URL.
metarequired: object

Request

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

Response example

{
  "data": {
    "url": "string",
    "expires_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.
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/rental-inspections/{id}/revise

Correct a signed inspection

A new revision (same answers and files) to fix and sign again; the signed one is superseded then.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 201

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/revise' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/signatures/{party}/otp

Send a party their signing code (at the handover)

The code goes to the party’s own phone / email (minted at delivery); they read it out to the agent.

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

Parameters

idpathrequired: Id
Opaque record id.
partypathrequired: "landlord" | "tenant"

Response · 200

datarequired: InspectionOtpRequest
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/signatures/{party}/otp' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "status": "sent",
    "channel": "string",
    "reason": "string",
    "resend_in_sec": 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.
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.

POST/v1/rental-inspections/{id}/signatures/{party}/revoke

Stop a party’s signing link

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.
partypathrequired: "landlord" | "tenant"

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/signatures/{party}/revoke' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/signatures/{party}/send

Send a party their signing link

Minted when the message is delivered; a new link replaces the old one. At most every 2 minutes.

Access: API key or member session. Permission rentals.edit.

Parameters

idpathrequired: Id
Opaque record id.
partypathrequired: "landlord" | "tenant"

Response · 200

datarequired: RentalInspection
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/signatures/{party}/send' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "agreement_id": "cmusrceel0000q7kaafxqi1om",
    "kind": "move_in",
    "revision": 0,
    "correction_of": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0
    },
    "status": "draft",
    "status_label": "string",
    "template": {
      "key": "string",
      "version": 0
    },
    "scheduled_on": "2026-10-06",
    "conducted_on": "2026-10-06",
    "checklist": {
      "rooms": [
        {
          "key": "string",
          "type": "entrance",
          "label": "string",
          "custom": true,
          "items": [
            {
              "key": null,
              "label": null,
              "photo": null,
              "custom": null
            }
          ]
        }
      ],
      "meters": [
        {
          "key": "string",
          "type": "electricity",
          "label": "string",
          "unit": "kWh",
          "custom": true
        }
      ],
      "inventory": [
        {
          "key": "string",
          "label": "string",
          "category": "furniture",
          "room_type": "entrance",
          "quantity": 0,
          "replacement_value": 850000000,
          "custom": true
        }
      ],
      "keys": [
        {
          "key": "string",
          "label": "string",
          "count": 0,
          "custom": true
        }
      ]
    },
    "answers": {
      "items": {},
      "rooms": {},
      "meters": {},
      "inventory": {},
      "keys": {},
      "general": {
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    },
    "draft_version": 0,
    "signing_round": 0,
    "media": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "target": "string",
        "target_label": "string",
        "kind": "photo",
        "status": "processing",
        "content_type": "string",
        "size_bytes": 0,
        "width": 0,
        "height": 0,
        "duration_ms": 0,
        "caption": "string",
        "captured_at": "2026-10-06T05:30:00.000Z",
        "time_source": "string",
        "time_flags": [
          "string"
        ],
        "had_location": true,
        "exif_taken_at": "2026-10-06T05:30:00.000Z",
        "failure": "string",
        "preview_url": "string",
        "thumb_url": "string",
        "urls_expire_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "gaps": [
      {
        "code": "string",
        "target": "string",
        "text": "string"
      }
    ],
    "progress": {
      "rated": 0,
      "items": 0,
      "meters_done": 0,
      "meters": 0,
      "counted": 0,
      "countable": 0,
      "photos": 0
    },
    "content_hash": "string",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "locked_at": "2026-10-06T05:30:00.000Z",
    "superseded_at": "2026-10-06T05:30:00.000Z",
    "correction_reason": "string",
    "reopen_reason": "string",
    "cancel_reason": "string",
    "signatures": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "party": "landlord",
        "round": 0,
        "name": "string",
        "status": "pending",
        "status_label": "string",
        "method": "link",
        "phone": "string",
        "reachable": true,
        "link": {
          "status": "string",
          "expires_at": "2026-10-06T05:30:00.000Z",
          "invited_at": "2026-10-06T05:30:00.000Z",
          "opened_at": "2026-10-06T05:30:00.000Z",
          "blocked_reason": "string"
        },
        "otp": {
          "phase": "string",
          "channel": "string",
          "resend_in_sec": 0,
          "attempts_left": 0,
          "via": "string"
        },
        "typed_name": "string",
        "signed_at": "2026-10-06T05:30:00.000Z",
        "otp_channel": "string",
        "drawn": true
      }
    ],
    "report": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om"
    },
    "comparison": {
      "status": "string",
      "document_id": "cmusrceel0000q7kaafxqi1om",
      "at": "2026-10-06T05:30:00.000Z"
    },
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "property": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "title": "string"
      },
      "landlord": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "tenant": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "start_date": "2026-10-06",
      "deal_id": "cmusrceel0000q7kaafxqi1om"
    },
    "baseline": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "revision": 0,
      "conducted_on": "2026-10-06"
    },
    "rules": {
      "photos_per_room": 0,
      "meter_photo": true,
      "video_max_mb": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "can": {
      "capture": true,
      "complete": true,
      "reopen": true,
      "cancel": true,
      "revise": true,
      "sign": true,
      "report": 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.

POST/v1/rental-inspections/{id}/signatures/{party}/sign

Sign for a party on this phone (at the handover)

Typed name, optional drawing and the party’s code. A wrong code is an answer (attempts left), not an error.

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

Parameters

idpathrequired: Id
Opaque record id.
partypathrequired: "landlord" | "tenant"

Request body

typed_namerequired: string
signature: string or null
A drawn signature as data:image/png;base64,… (optional).
coderequired: string

Response · 200

datarequired: SignInspectionResult
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/rental-inspections/{id}/signatures/{party}/sign' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"typed_name":"string","signature":"string","code":"string"}'

Response example

{
  "data": {
    "signed": true,
    "locked": true,
    "reason": "invalid",
    "attempts_left": 0,
    "inspection": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "agreement_id": "cmusrceel0000q7kaafxqi1om",
      "kind": "move_in",
      "revision": 0,
      "correction_of": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "revision": 0
      },
      "status": "draft",
      "status_label": "string",
      "template": {
        "key": "string",
        "version": 0
      },
      "scheduled_on": "2026-10-06",
      "conducted_on": "2026-10-06",
      "checklist": {
        "rooms": [
          {
            "key": "string",
            "type": "entrance",
            "label": "string",
            "custom": true,
            "items": [
              null
            ]
          }
        ],
        "meters": [
          {
            "key": "string",
            "type": "electricity",
            "label": "string",
            "unit": "kWh",
            "custom": true
          }
        ],
        "inventory": [
          {
            "key": "string",
            "label": "string",
            "category": "furniture",
            "room_type": "entrance",
            "quantity": 0,
            "replacement_value": 850000000,
            "custom": true
          }
        ],
        "keys": [
          {
            "key": "string",
            "label": "string",
            "count": 0,
            "custom": true
          }
        ]
      },
      "answers": {
        "items": {},
        "rooms": {},
        "meters": {},
        "inventory": {},
        "keys": {},
        "general": {
          "note": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      },
      "draft_version": 0,
      "signing_round": 0,
      "media": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "target": "string",
          "target_label": "string",
          "kind": "photo",
          "status": "processing",
          "content_type": "string",
          "size_bytes": 0,
          "width": 0,
          "height": 0,
          "duration_ms": 0,
          "caption": "string",
          "captured_at": "2026-10-06T05:30:00.000Z",
          "time_source": "string",
          "time_flags": [
            "string"
          ],
          "had_location": true,
          "exif_taken_at": "2026-10-06T05:30:00.000Z",
          "failure": "string",
          "preview_url": "string",
          "thumb_url": "string",
          "urls_expire_at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "gaps": [
        {
          "code": "string",
          "target": "string",
          "text": "string"
        }
      ],
      "progress": {
        "rated": 0,
        "items": 0,
        "meters_done": 0,
        "meters": 0,
        "counted": 0,
        "countable": 0,
        "photos": 0
      },
      "content_hash": "string",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "locked_at": "2026-10-06T05:30:00.000Z",
      "superseded_at": "2026-10-06T05:30:00.000Z",
      "correction_reason": "string",
      "reopen_reason": "string",
      "cancel_reason": "string",
      "signatures": [
        {
          "id": "cmusrceel0000q7kaafxqi1om",
          "party": "landlord",
          "round": 0,
          "name": "string",
          "status": "pending",
          "status_label": "string",
          "method": "link",
          "phone": "string",
          "reachable": true,
          "link": {
            "status": "string",
            "expires_at": "2026-10-06T05:30:00.000Z",
            "invited_at": "2026-10-06T05:30:00.000Z",
            "opened_at": "2026-10-06T05:30:00.000Z",
            "blocked_reason": "string"
          },
          "otp": {
            "phase": "string",
            "channel": "string",
            "resend_in_sec": 0,
            "attempts_left": 0,
            "via": "string"
          },
          "typed_name": "string",
          "signed_at": "2026-10-06T05:30:00.000Z",
          "otp_channel": "string",
          "drawn": true
        }
      ],
      "report": {
        "status": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om"
      },
      "comparison": {
        "status": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om",
        "at": "2026-10-06T05:30:00.000Z"
      },
      "agreement": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "property": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "title": "string"
        },
        "landlord": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "tenant": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "start_date": "2026-10-06",
        "deal_id": "cmusrceel0000q7kaafxqi1om"
      },
      "baseline": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "revision": 0,
        "conducted_on": "2026-10-06"
      },
      "rules": {
        "photos_per_room": 0,
        "meter_photo": true,
        "video_max_mb": 0
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "can": {
        "capture": true,
        "complete": true,
        "reopen": true,
        "cancel": true,
        "revise": true,
        "sign": true,
        "report": 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.