GET
/v1/rental-agreements/{id}/agreement-documentThe agreement document panel
Templates that fit the state, the draft (fields, clauses with what changed, the rendered preview and what is missing), the stamp-duty estimate, e-stamp credits, the latest signing request and the registration.
Access: API key or member session. Permission rentals.view.
Parameters
idpathrequired- Id
Opaque record id.
Response · 200
datarequired- AgreementDocumentPanel
metarequired- object
curl -X GET 'https://api.propzolo.com/v1/rental-agreements/{id}/agreement-document' \
-H 'Authorization: Bearer pz_live_…'{
"data": {
"agreement": {
"id": "cmusrceel0000q7kaafxqi1om",
"status": "string",
"start_date": "2026-10-06",
"end_date": "2026-10-06",
"term_months": 0,
"rent_amount": 850000000,
"deposit_amount": 850000000,
"agreement_type": "string",
"landlord": {
"id": "cmusrceel0000q7kaafxqi1om",
"name": "string",
"phone": "string"
},
"tenant": {
"id": "cmusrceel0000q7kaafxqi1om",
"name": "string",
"phone": "string"
},
"property": {
"id": "cmusrceel0000q7kaafxqi1om",
"title": "string",
"state": "string"
},
"state": "string"
},
"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",
"fits": true
}
],
"suggested_template": "string",
"document": {
"id": "cmusrceel0000q7kaafxqi1om",
"version": 0,
"status": "draft",
"template": {
"key": "string",
"version": 0,
"title": "string",
"current_version": 0
},
"kind": "leave_licence",
"kind_label": "string",
"state": "string",
"execution": "notarised",
"area": "string",
"title": "string",
"fields": {
"place": "string",
"execution_date": "2026-10-06",
"landlord": {
"relation": "string",
"age": 0,
"address": "string"
},
"tenant": {
"relation": "string",
"age": 0,
"address": "string"
},
"property_address": "string",
"property_description": "string",
"city": "string",
"inclusions": [
"string"
],
"special_conditions": "string",
"non_refundable_amount": 850000000,
"witnesses": [
{
"name": "string",
"address": "string",
"phone": "string"
}
]
},
"clauses": [
{
"key": "string",
"title": "string",
"body": "string",
"origin": "library",
"version": 0
}
],
"slots": [
{
"key": "string",
"required": true,
"included": true
}
],
"changes": {
"added": [
{
"key": "string",
"title": "string"
}
],
"removed": [
{
"key": "string",
"title": "string"
}
],
"moved": [
{
"key": "string",
"title": "string",
"from": 0,
"to": 0
}
],
"edited": [
{
"key": "string",
"title": "string",
"diff": [
null
]
}
]
},
"library": [
{
"key": "string",
"title": "string",
"category": "string",
"origin": "string",
"version": 0,
"applies": true,
"body": "string"
}
],
"preview": {
"title": "string",
"blocks": [
{
"kind": null,
"segments": null
}
],
"missing": [
{
"key": "string",
"label": "string"
}
],
"unknown": [
"string"
]
},
"stamp": {
"status": "estimated",
"rule": {
"id": "string",
"label": "string",
"effective_from": "2026-10-06",
"source": {
"title": null,
"url": null,
"retrieved_on": null
},
"verified": true,
"note": "string",
"origin": "system"
},
"term": {
"months": 0,
"days": 0
},
"total_rent": 850000000,
"average_annual_rent": 850000000,
"base_lines": [
{
"label": null,
"amount": null
}
],
"base": 850000000,
"duty": 850000000,
"registration_required": true,
"registration_fee": 850000000,
"extra": {
"label": "string",
"amount": 850000000
},
"total": 850000000,
"e_stamp": true,
"warnings": [
"string"
]
},
"stamp_override": {
"duty": 850000000,
"registration_fee": 850000000,
"reason": "string"
},
"stamp_certificate_no": "string",
"registration_plan": "string",
"signed_at": "2026-10-06T05:30:00.000Z",
"has_signed_pdf": true,
"updated_at": "2026-10-06T05:30:00.000Z"
},
"envelope": {
"id": "cmusrceel0000q7kaafxqi1om",
"status": "preparing",
"provider": "string",
"signing_order": "string",
"document_version": 0,
"estamp": {
"state": "string",
"denomination": 850000000,
"status": "string",
"certificate_no": "string"
},
"expires_at": "2026-10-06T05:30:00.000Z",
"sent_at": "2026-10-06T05:30:00.000Z",
"completed_at": "2026-10-06T05:30:00.000Z",
"last_error": "string",
"cancel_reason": "string",
"has_signed_pdf": true,
"has_audit_trail": true,
"signers": [
{
"id": "cmusrceel0000q7kaafxqi1om",
"role": "string",
"name": "string",
"phone": "string",
"sign_type": "string",
"order": 0,
"status": "string",
"signed_at": "2026-10-06T05:30:00.000Z",
"aadhaar_masked": "string",
"certificate_name": "string",
"link_status": "string",
"invited_at": "2026-10-06T05:30:00.000Z",
"opened_at": "2026-10-06T05:30:00.000Z",
"blocked_reason": "string"
}
],
"events": [
{
"kind": "string",
"source": "string",
"created_at": "2026-10-06T05:30:00.000Z"
}
]
},
"registration": {
"id": "cmusrceel0000q7kaafxqi1om",
"plan": "string",
"plan_label": "string",
"status": "open",
"steps": [
{
"key": "string",
"title": "string",
"detail": "string",
"due_on": "2026-10-06",
"task_id": "string",
"task_status": "open"
}
],
"registration_no": "string",
"registered_on": "2026-10-06",
"office": "string",
"assignee": {
"id": "cmusrceel0000q7kaafxqi1om",
"name": "string"
}
},
"credits": [
{
"denomination": 850000000,
"available": 0
}
],
"esign_configured": true,
"capabilities": {
"edit": true,
"send": true,
"cancel": true,
"register": true
}
},
"meta": {}
}Errors
401No valid session or API key (missing, expired or revoked).403The caller lacks the permission, API-key scope or support grant this operation needs.404Not found — records of another company are reported the same way.422Invalid input; `error.fields` maps field paths to messages.429Too many requests; retry after the Retry-After header.500Unexpected error; quote `error.request_id` to support.