Loan desk

Home-loan cases of leads and deals: eligibility (FOIR, EMI, RBI LTV slabs), the document checklist, hand-off to a lender with a document-pack link, sanction and disbursal tranches, lenders, DSAs and the commission ledger.

GET/v1/loan-cases

The loan desk queue

Open cases by default, most recently changed first; filter by stage, lender, lead, deal or “mine”.

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

Parameters

statusquery: "open" | "all" | "logged" | "submitted" | "sanctioned" | "part_disbursed" | …
lender_idquery: Id
Opaque record id.
lead_idquery: Id
Opaque record id.
deal_idquery: Id
Opaque record id.
ownerquery: "me"
qquery: string
cursorquery: string
limitquery: integer

Response · 200

datarequired: array of LoanCase
metarequired: PageMeta

Request

curl -X GET 'https://api.propzolo.com/v1/loan-cases' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "status": "logged",
      "loan_type": "home_purchase",
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "name": "string"
      },
      "deal": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "ref": "string",
        "title": "string"
      },
      "owner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lender": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "kind": "string"
      },
      "agent": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "property_value": 850000000,
      "requested_amount": 850000000,
      "tenure_months": 0,
      "rate_bps": 0,
      "sanctioned_amount": 850000000,
      "sanctioned_rate_bps": 0,
      "sanctioned_on": "2026-10-06",
      "sanction_valid_until": "2026-10-06",
      "bank_reference": "string",
      "disbursed_total": 850000000,
      "documents": {
        "total": 0,
        "done": 0
      },
      "commission": {
        "rate_bps": 0,
        "cap": 850000000,
        "payer": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "accrued": 850000000,
        "received": 850000000
      },
      "rejection_reason": "string",
      "notes": "string",
      "status_changed_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z",
      "capabilities": {
        "edit": true,
        "commissions": true
      }
    }
  ],
  "meta": {
    "next_cursor": "string",
    "has_more": true
  }
}

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.
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/loan-cases

Open a loan case

For a lead you can see (and optionally its deal). The checklist is seeded from the applicants’ employment and the loan type; without applicants the lead’s contact is the primary applicant.

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

Request body

lead_idrequired: Id
Opaque record id.
deal_id: Id or null
Opaque record id.
loan_typerequired: "home_purchase" | "construction" | "plot" | "plot_construction" | "balance_transfer" | "top_up" | …
owner_id: Id or null
Opaque record id.
lender_id: Id or null
Opaque record id.
agent_id: Id or null
Opaque record id.
property_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
requested_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
tenure_months: integer or null
rate_bps: integer or null
notes: string or null
applicants: array of object
applicants[].namerequired: string
applicants[].relation: "self" | "spouse" | "parent" | "child" | "sibling" | "other"
applicants[].employmentrequired: "salaried" | "self_employed" | "professional" | "other"
applicants[].employer: string or null
applicants[].monthly_incomerequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].monthly_obligationsrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].age: integer or null
applicants[].contact_id: Id or null
Opaque record id.

Response · 201

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lead_id":"cmusrceel0000q7kaafxqi1om","deal_id":"cmusrceel0000q7kaafxqi1om","loan_type":"home_purchase","owner_id":"cmusrceel0000q7kaafxqi1om","lender_id":"cmusrceel0000q7kaafxqi1om","agent_id":"cmusrceel0000q7kaafxqi1om","property_value":0,"requested_amount":0,"tenure_months":12,"rate_bps":0,"notes":"string","applicants":[{"name":"string","relation":"self","employment":"salaried","employer":"string","monthly_income":0,"monthly_obligations":0,"age":18,"contact_id":"cmusrceel0000q7kaafxqi1om"}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "string"
      }
    ]
  },
  "meta": {}
}

Errors

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

GET/v1/loan-cases/{id}

A loan case

Applicants, checklist, hand-offs, disbursals and (with commission figures in clear) the commissions.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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.
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/loan-cases/{id}

Edit a loan case

Amounts, terms, handler, notes; lender and DSA until the sanction.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

loan_type: "home_purchase" | "construction" | "plot" | "plot_construction" | "balance_transfer" | "top_up" | …
owner_id: Id or null
Opaque record id.
lender_id: Id or null
Opaque record id.
agent_id: Id or null
Opaque record id.
property_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
requested_amount: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
tenure_months: integer or null
rate_bps: integer or null
notes: string or null
bank_reference: string or null

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/loan-cases/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"loan_type":"home_purchase","owner_id":"cmusrceel0000q7kaafxqi1om","lender_id":"cmusrceel0000q7kaafxqi1om","agent_id":"cmusrceel0000q7kaafxqi1om","property_value":0,"requested_amount":0,"tenure_months":12,"rate_bps":0,"notes":"string","bank_reference":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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.

PUT/v1/loan-cases/{id}/applicants

Set the applicants

The first is the primary applicant; up to three co-applicants. New employment types extend the checklist.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

applicantsrequired: array of object
applicants[].namerequired: string
applicants[].relation: "self" | "spouse" | "parent" | "child" | "sibling" | "other"
applicants[].employmentrequired: "salaried" | "self_employed" | "professional" | "other"
applicants[].employer: string or null
applicants[].monthly_incomerequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].monthly_obligationsrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].age: integer or null
applicants[].contact_id: Id or null
Opaque record id.

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/loan-cases/{id}/applicants' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"applicants":[{"name":"string","relation":"self","employment":"salaried","employer":"string","monthly_income":0,"monthly_obligations":0,"age":18,"contact_id":"cmusrceel0000q7kaafxqi1om"}]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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/loan-cases/{id}/consents

Ask for (or record) the applicant’s consent to share papers with lenders

otp: the applicant gets the notice and a one-time code to read back; written: records a signed consent form (say where it is kept). A hand-off needs a given consent naming the lender.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

lender_idsrequired: array of Id
Opaque record id.
purpose: string or null
methodrequired: "otp" | "written"
evidence: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.lender_idsrequired: array of Id
Opaque record id.
data.lender_namesrequired: array of string
data.purposerequired: string
data.notice_versionrequired: string
data.methodrequired: "otp" | "written"
data.statusrequired: "pending" | "given" | "withdrawn"
data.evidencerequired: string or null
data.given_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.withdrawn_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.blocked_reasonrequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/consents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lender_ids":["cmusrceel0000q7kaafxqi1om"],"purpose":"string","method":"otp","evidence":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lender_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "lender_names": [
      "string"
    ],
    "purpose": "string",
    "notice_version": "string",
    "method": "otp",
    "status": "pending",
    "evidence": "string",
    "given_at": "2026-10-06T05:30:00.000Z",
    "withdrawn_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "blocked_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/loan-cases/{id}/consents/{consentId}/confirm

Enter the code the applicant read back

A wrong code is an answer with the attempts left (5 lock it).

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

Parameters

idpathrequired: Id
Opaque record id.
consentIdpathrequired: Id
Opaque record id.

Request body

coderequired: string

Response · 200

datarequired: object
data.statusrequired: "given" | "invalid" | "locked"
data.attempts_leftrequired: integer
data.consentrequired: LoanConsent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/consents/{consentId}/confirm' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"code":"string"}'

Response example

{
  "data": {
    "status": "given",
    "attempts_left": 0,
    "consent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "lender_ids": [
        "cmusrceel0000q7kaafxqi1om"
      ],
      "lender_names": [
        "string"
      ],
      "purpose": "string",
      "notice_version": "string",
      "method": "otp",
      "status": "pending",
      "evidence": "string",
      "given_at": "2026-10-06T05:30:00.000Z",
      "withdrawn_at": "2026-10-06T05:30:00.000Z",
      "created_at": "2026-10-06T05:30:00.000Z"
    }
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
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/loan-cases/{id}/consents/{consentId}/withdraw

Record that the applicant withdrew consent

Lender links handed off under this consent stop working at once.

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

Parameters

idpathrequired: Id
Opaque record id.
consentIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: LoanConsent
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/consents/{consentId}/withdraw' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "lender_ids": [
      "cmusrceel0000q7kaafxqi1om"
    ],
    "lender_names": [
      "string"
    ],
    "purpose": "string",
    "notice_version": "string",
    "method": "otp",
    "status": "pending",
    "evidence": "string",
    "given_at": "2026-10-06T05:30:00.000Z",
    "withdrawn_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
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/loan-cases/{id}/disbursals

Record a disbursal

A tranche on a sanctioned case (never above the sanction). Moves the stage and accrues the commission (rate × amount up to the cap) as a receivable.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
disbursed_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
reference: string or null
note: string or null
final: boolean

Response · 201

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/disbursals' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"disbursed_on":"2026-10-06","reference":"string","note":"string","final":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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/loan-cases/{id}/disbursals/{disbursalId}/reverse

Reverse a disbursal entered wrongly

Adds a reversal entry (the negative amount, with the reason) for a tranche, once; its commission is written off and the stage follows the remaining total. Needs a recent second-factor check.

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

Parameters

idpathrequired: Id
Opaque record id.
disbursalIdpathrequired: Id
Opaque record id.

Request body

reasonrequired: string

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/disbursals/{disbursalId}/reverse' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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/loan-cases/{id}/documents

Add a checklist line

A document the lender asked for beyond the default checklist.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "pan" | "aadhaar" | "photo" | "address_proof" | "bank_statements" | "salary_slips" | …
label: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "pan" | "aadhaar" | "photo" | "address_proof" | "bank_statements" | "salary_slips" | …
data.labelrequired: string or null
data.statusrequired: "pending" | "received" | "verified" | "waived"
data.file_namerequired: string or null
data.content_typerequired: string or null
data.sizerequired: integer or null
data.uploaded_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.verified_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.noterequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/documents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"pan","label":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "label": "string",
    "status": "pending",
    "file_name": "string",
    "content_type": "string",
    "size": 0,
    "uploaded_at": "2026-10-06T05:30:00.000Z",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "note": "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.

PATCH/v1/loan-cases/{id}/documents/{documentId}

Verify, waive or reset a checklist line

Verified and received need a file.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Request body

statusrequired: "pending" | "received" | "verified" | "waived"
note: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "pan" | "aadhaar" | "photo" | "address_proof" | "bank_statements" | "salary_slips" | …
data.labelrequired: string or null
data.statusrequired: "pending" | "received" | "verified" | "waived"
data.file_namerequired: string or null
data.content_typerequired: string or null
data.sizerequired: integer or null
data.uploaded_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.verified_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.noterequired: string or null
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/loan-cases/{id}/documents/{documentId}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"pending","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "label": "string",
    "status": "pending",
    "file_name": "string",
    "content_type": "string",
    "size": 0,
    "uploaded_at": "2026-10-06T05:30:00.000Z",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "note": "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.

DELETE/v1/loan-cases/{id}/documents/{documentId}

Remove a checklist line

The stored file is kept for the audit trail.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Response · 200

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

Request

curl -X DELETE 'https://api.propzolo.com/v1/loan-cases/{id}/documents/{documentId}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

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

Errors

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

GET/v1/loan-cases/{id}/documents/{documentId}/download

Open a document

A 60-second signed link (audited); a quarantined file is never handed out.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/loan-cases/{id}/documents/{documentId}/download' \
  -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/loan-cases/{id}/documents/{documentId}/file

Attach the uploaded file

Replaces an earlier file and marks the line received; documents are scanned for malware.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Request body

keyrequired: string
filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "pan" | "aadhaar" | "photo" | "address_proof" | "bank_statements" | "salary_slips" | …
data.labelrequired: string or null
data.statusrequired: "pending" | "received" | "verified" | "waived"
data.file_namerequired: string or null
data.content_typerequired: string or null
data.sizerequired: integer or null
data.uploaded_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.verified_at: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.noterequired: string or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/documents/{documentId}/file' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"key":"string","filename":"string","content_type":"string","size":1}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "label": "string",
    "status": "pending",
    "file_name": "string",
    "content_type": "string",
    "size": 0,
    "uploaded_at": "2026-10-06T05:30:00.000Z",
    "verified_at": "2026-10-06T05:30:00.000Z",
    "note": "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/loan-cases/{id}/documents/{documentId}/upload

Upload a document

A presigned PUT into private storage (type and exact size signed); attach it afterwards.

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

Parameters

idpathrequired: Id
Opaque record id.
documentIdpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: object
data.keyrequired: string
data.urlrequired: string
data.methodrequired: "PUT"
data.headersrequired: map of string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.max_bytesrequired: integer
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/documents/{documentId}/upload' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"filename":"string","content_type":"string","size":1}'

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/loan-cases/{id}/eligibility

Check the case’s eligibility

On the applicants, the case’s amounts and terms and the lender’s FOIR / LTV ceiling; kept on the case.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LoanEligibility
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/eligibility' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "total_income": 850000000,
    "total_obligations": 850000000,
    "foir_bps": 0,
    "max_emi": 850000000,
    "rate_bps": 0,
    "tenure_months": 0,
    "tenure_capped": true,
    "loan_by_income": 850000000,
    "loan_by_ltv": 850000000,
    "ltv_bps": 0,
    "eligible": 850000000,
    "emi": 850000000,
    "limited_by": "income",
    "own_contribution": 850000000
  },
  "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/loan-cases/{id}/handoffs

Hand the case off to a lender

A sign-in-free document-pack link (received documents by default) sent to the lender’s contact by email or WhatsApp through the compliance-gated pipeline, or returned to share yourself. A logged case becomes submitted.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

lender_id: Id or null
Opaque record id.
channelrequired: "email" | "whatsapp" | "link"
document_ids: array of Id
Opaque record id.

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "sent" | "blocked" | "link"
data.reasonrequired: string or null
data.urlrequired: string or null
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/handoffs' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"lender_id":"cmusrceel0000q7kaafxqi1om","channel":"email","document_ids":["cmusrceel0000q7kaafxqi1om"]}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "sent",
    "reason": "string",
    "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.
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/loan-cases/{id}/handoffs/{handoffId}/revoke

Revoke a lender’s link

The document-pack link stops working at once.

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

Parameters

idpathrequired: Id
Opaque record id.
handoffIdpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "revoked"
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/handoffs/{handoffId}/revoke' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "revoked"
  },
  "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/loan-cases/{id}/sanction

Record the sanction

Amount, rate, date and validity. Freezes the commission terms: the slab rate for the sanctioned amount from the DSA’s, the lender’s or the default rule, the cap and who pays. Correctable until the first disbursal.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
rate_bps: integer or null
sanctioned_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
valid_until: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
bank_reference: string or null

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/sanction' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"rate_bps":0,"sanctioned_on":"2026-10-06","valid_until":"2026-10-06","bank_reference":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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/loan-cases/{id}/status

Move a loan case

Submitted (needs a lender), rejected (needs a reason), withdrawn (before any disbursal), back to logged, disbursed (the lender’s final tranche), closed. A sanction uses its own endpoint.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

statusrequired: "logged" | "submitted" | "disbursed" | "closed" | "rejected" | "withdrawn"
reason: string or null

Response · 200

datarequired: LoanCaseDetail
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-cases/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"logged","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "ref": "string",
    "status": "logged",
    "loan_type": "home_purchase",
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "name": "string"
    },
    "deal": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "ref": "string",
      "title": "string"
    },
    "owner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lender": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "kind": "string"
    },
    "agent": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "property_value": 850000000,
    "requested_amount": 850000000,
    "tenure_months": 0,
    "rate_bps": 0,
    "sanctioned_amount": 850000000,
    "sanctioned_rate_bps": 0,
    "sanctioned_on": "2026-10-06",
    "sanction_valid_until": "2026-10-06",
    "bank_reference": "string",
    "disbursed_total": 850000000,
    "documents": {
      "total": 0,
      "done": 0
    },
    "commission": {
      "rate_bps": 0,
      "cap": 850000000,
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "accrued": 850000000,
      "received": 850000000
    },
    "rejection_reason": "string",
    "notes": "string",
    "status_changed_at": "2026-10-06T05:30:00.000Z",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z",
    "capabilities": {
      "edit": true,
      "commissions": true
    },
    "applicants": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "contact_id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "relation": "string",
        "is_primary": true,
        "employment": "salaried",
        "employer": "string",
        "monthly_income": 850000000,
        "monthly_obligations": 850000000,
        "age": 0
      }
    ],
    "eligibility": {},
    "documents_list": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "pending",
        "file_name": "string",
        "content_type": "string",
        "size": 0,
        "uploaded_at": "2026-10-06T05:30:00.000Z",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "note": "string"
      }
    ],
    "handoffs": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "name": "string"
        },
        "channel": "email",
        "status": "sent",
        "blocked_reason": "string",
        "documents": 0,
        "document_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "expires_at": "2026-10-06T05:30:00.000Z",
        "revoked_at": "2026-10-06T05:30:00.000Z",
        "first_opened_at": "2026-10-06T05:30:00.000Z",
        "last_opened_at": "2026-10-06T05:30:00.000Z",
        "open_count": 0,
        "live": true,
        "consent_id": "cmusrceel0000q7kaafxqi1om",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "disbursals": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "amount": 850000000,
        "disbursed_on": "2026-10-06",
        "reference": "string",
        "note": "string",
        "reverses_id": "cmusrceel0000q7kaafxqi1om",
        "reversed": true,
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "consents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "lender_ids": [
          "cmusrceel0000q7kaafxqi1om"
        ],
        "lender_names": [
          "string"
        ],
        "purpose": "string",
        "notice_version": "string",
        "method": "otp",
        "status": "pending",
        "evidence": "string",
        "given_at": "2026-10-06T05:30:00.000Z",
        "withdrawn_at": "2026-10-06T05:30:00.000Z",
        "created_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "commissions": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "disbursal_id": "cmusrceel0000q7kaafxqi1om",
        "rate_bps": 0,
        "base_amount": 850000000,
        "amount": 850000000,
        "received_amount": 850000000,
        "status": "pending",
        "accrued_on": "2026-10-06",
        "received_on": "2026-10-06",
        "reference": "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.

GET/v1/loan-commission-rules

Loan commission rules

One per lender or DSA plus the company default.

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

Response · 200

datarequired: array of LoanCommissionRule
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "slabs": [
        {
          "up_to": 850000000,
          "rate_bps": 0
        }
      ],
      "cap": 850000000,
      "notes": "string",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

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

PUT/v1/loan-commission-rules

Save a commission rule

Slabs by the sanctioned amount (ascending, the last open-ended), rates 0–5 % in bps, an optional cap per case. Replaces the partner’s (or the default) rule; cases sanctioned earlier keep their frozen terms.

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

Request body

partner_idrequired: Id or null
Opaque record id.
slabsrequired: array of object
slabs[].up_torequired: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
slabs[].rate_bpsrequired: integer
cap: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
notes: string or null

Response · 200

datarequired: LoanCommissionRule
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/loan-commission-rules' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"partner_id":"cmusrceel0000q7kaafxqi1om","slabs":[{"up_to":0,"rate_bps":0}],"cap":0,"notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "slabs": [
      {
        "up_to": 850000000,
        "rate_bps": 0
      }
    ],
    "cap": 850000000,
    "notes": "string",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

DELETE/v1/loan-commission-rules/{id}

Remove a commission rule

The partner falls back to the default rule for future sanctions.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

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

Request

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

Response example

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

Errors

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

GET/v1/loan-commissions

The loan commission ledger

Receivables from lenders and DSAs per tranche with totals (accrued, received, pending, written off).

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

Parameters

statusquery: "pending" | "received" | "written_off" | "all"
payer_idquery: Id
Opaque record id.

Response · 200

datarequired: array of LoanCommission
metarequired: object
meta.totalsrequired: object
meta.totals.accruedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
meta.totals.receivedrequired: Paise
Money in paise (₹1 = 100), an exact integer.
meta.totals.pendingrequired: Paise
Money in paise (₹1 = 100), an exact integer.
meta.totals.writtenOffrequired: Paise
Money in paise (₹1 = 100), an exact integer.

Request

curl -X GET 'https://api.propzolo.com/v1/loan-commissions' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "case_id": "cmusrceel0000q7kaafxqi1om",
      "case_ref": "string",
      "payer": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "payer_id": "cmusrceel0000q7kaafxqi1om",
      "rate_bps": 0,
      "base_amount": 850000000,
      "amount": 850000000,
      "received_amount": 850000000,
      "outstanding": 850000000,
      "status": "pending",
      "accrued_on": "2026-10-06",
      "received_on": "2026-10-06",
      "reference": "string",
      "note": "string"
    }
  ],
  "meta": {
    "totals": {
      "accrued": 850000000,
      "received": 850000000,
      "pending": 850000000,
      "writtenOff": 850000000
    }
  }
}

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.
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/loan-commissions/{id}/receipts

Record commission received

Part payments add up; the full amount marks it received (audited).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

amountrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
received_onrequired: LocalDate
Calendar date YYYY-MM-DD in the company time zone.
reference: string or null
note: string or null

Response · 200

datarequired: LoanCommission
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-commissions/{id}/receipts' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"amount":0,"received_on":"2026-10-06","reference":"string","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "case_id": "cmusrceel0000q7kaafxqi1om",
    "case_ref": "string",
    "payer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "payer_id": "cmusrceel0000q7kaafxqi1om",
    "rate_bps": 0,
    "base_amount": 850000000,
    "amount": 850000000,
    "received_amount": 850000000,
    "outstanding": 850000000,
    "status": "pending",
    "accrued_on": "2026-10-06",
    "received_on": "2026-10-06",
    "reference": "string",
    "note": "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/loan-commissions/{id}/write-off

Write off a commission

The outstanding part will not be collected (a reason is required; audited).

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

noterequired: string

Response · 200

datarequired: LoanCommission
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-commissions/{id}/write-off' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "case_id": "cmusrceel0000q7kaafxqi1om",
    "case_ref": "string",
    "payer": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "payer_id": "cmusrceel0000q7kaafxqi1om",
    "rate_bps": 0,
    "base_amount": 850000000,
    "amount": 850000000,
    "received_amount": 850000000,
    "outstanding": 850000000,
    "status": "pending",
    "accrued_on": "2026-10-06",
    "received_on": "2026-10-06",
    "reference": "string",
    "note": "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/loan-exports

Export loan cases (CSV)

Within your loans.export scope, capped like lead exports. The worker writes a watermarked CSV (no phones, emails, PAN or documents; commission columns only with commission figures in clear) and notifies you. Needs a fresh second factor.

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

Request body

status: "open" | "all" | "logged" | "submitted" | "sanctioned" | "part_disbursed" | …
lender_id: Id or null
Opaque record id.

Response · 202

datarequired: LoanExport
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-exports' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"open","lender_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "file_name": "string",
    "rows": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "finished_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

GET/v1/loan-exports/{id}

A loan case export

Its status (queued, running, done, failed) and row count; the requester’s own (or the owner).

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: LoanExport
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "string",
    "file_name": "string",
    "rows": 0,
    "created_at": "2026-10-06T05:30:00.000Z",
    "finished_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.

GET/v1/loan-exports/{id}/download

Download a loan case export

A 5-minute link to the CSV for 24 hours after it was written (audited).

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/loan-exports/{id}/download' \
  -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.

GET/v1/loan-partners

Lenders and DSAs

Active ones by default; `status=archived|all` for the rest.

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

Parameters

kindquery: "bank" | "nbfc" | "hfc" | "dsa"
statusquery: "active" | "archived" | "all"

Response · 200

datarequired: array of LoanPartner
metarequired: object

Request

curl -X GET 'https://api.propzolo.com/v1/loan-partners' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "kind": "bank",
      "name": "string",
      "branch": "string",
      "contact_name": "string",
      "phone_e164": "string",
      "email": "string",
      "contact_id": "cmusrceel0000q7kaafxqi1om",
      "rate_bps": 0,
      "foir_bps": 0,
      "ltv_cap_bps": 0,
      "notes": "string",
      "status": "active",
      "created_at": "2026-10-06T05:30:00.000Z",
      "updated_at": "2026-10-06T05:30:00.000Z"
    }
  ],
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
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/loan-partners

Add a lender or DSA

With a phone or email the partner is messaged through a contact (that number’s, or a new one).

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

Request body

kindrequired: "bank" | "nbfc" | "hfc" | "dsa"
namerequired: string
branch: string or null
contact_name: string or null
phone: string or null
email: string or null
rate_bps: integer or null
foir_bps: integer or null
ltv_cap_bps: integer or null
notes: string or null

Response · 201

datarequired: LoanPartner
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-partners' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"bank","name":"string","branch":"string","contact_name":"string","phone":"string","email":"string","rate_bps":0,"foir_bps":1000,"ltv_cap_bps":1000,"notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "bank",
    "name": "string",
    "branch": "string",
    "contact_name": "string",
    "phone_e164": "string",
    "email": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "rate_bps": 0,
    "foir_bps": 0,
    "ltv_cap_bps": 0,
    "notes": "string",
    "status": "active",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

PUT/v1/loan-partners/{id}

Edit a lender or DSA

Name, branch, contact person, phone, email, indicative rate, FOIR and LTV ceiling.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "bank" | "nbfc" | "hfc" | "dsa"
namerequired: string
branch: string or null
contact_name: string or null
phone: string or null
email: string or null
rate_bps: integer or null
foir_bps: integer or null
ltv_cap_bps: integer or null
notes: string or null

Response · 200

datarequired: LoanPartner
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/loan-partners/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"bank","name":"string","branch":"string","contact_name":"string","phone":"string","email":"string","rate_bps":0,"foir_bps":1000,"ltv_cap_bps":1000,"notes":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "bank",
    "name": "string",
    "branch": "string",
    "contact_name": "string",
    "phone_e164": "string",
    "email": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "rate_bps": 0,
    "foir_bps": 0,
    "ltv_cap_bps": 0,
    "notes": "string",
    "status": "active",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

POST/v1/loan-partners/{id}/status

Archive or restore a lender or DSA

An archived partner cannot be chosen for new work; cases keep it.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

statusrequired: "active" | "archived"

Response · 200

datarequired: LoanPartner
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loan-partners/{id}/status' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"status":"active"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "bank",
    "name": "string",
    "branch": "string",
    "contact_name": "string",
    "phone_e164": "string",
    "email": "string",
    "contact_id": "cmusrceel0000q7kaafxqi1om",
    "rate_bps": 0,
    "foir_bps": 0,
    "ltv_cap_bps": 0,
    "notes": "string",
    "status": "active",
    "created_at": "2026-10-06T05:30:00.000Z",
    "updated_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

POST/v1/loans/eligibility

Eligibility calculator

Income and existing EMIs (FOIR), rate and tenure (EMI, capped at retirement) and the property value (RBI LTV slabs: 90 % to ₹30 L, 80 % to ₹75 L, 75 % above) → the likely loan, its EMI and what limits it. Nothing is stored.

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

Request body

applicantsrequired: array of object
applicants[].monthly_incomerequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].monthly_obligationsrequired: PaiseInput
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
applicants[].employmentrequired: "salaried" | "self_employed" | "professional" | "other"
applicants[].age: integer or null
rate_bps: integer or null
tenure_months: integer or null
foir_bps: integer or null
property_value: PaiseInput or null
Money in paise (₹1 = 100): an integer, or a digit string for huge amounts.
lender_id: Id or null
Opaque record id.

Response · 200

datarequired: LoanEligibility
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/loans/eligibility' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"applicants":[{"monthly_income":0,"monthly_obligations":0,"employment":"salaried","age":18}],"rate_bps":0,"tenure_months":12,"foir_bps":1000,"property_value":0,"lender_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "total_income": 850000000,
    "total_obligations": 850000000,
    "foir_bps": 0,
    "max_emi": 850000000,
    "rate_bps": 0,
    "tenure_months": 0,
    "tenure_capped": true,
    "loan_by_income": 850000000,
    "loan_by_ltv": 850000000,
    "ltv_bps": 0,
    "eligible": 850000000,
    "emi": 850000000,
    "limited_by": "income",
    "own_contribution": 850000000
  },
  "meta": {}
}

Errors

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

GET/v1/settings/loans

Loan desk settings

Eligibility defaults, the lender link’s life, the sanction warning and the commission overdue window.

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

Response · 200

datarequired: LoanSettings
metarequired: object

Request

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

Response example

{
  "data": {
    "foir_bps": 1000,
    "default_rate_bps": 100,
    "default_tenure_months": 12,
    "retirement_age": {
      "salaried": 45,
      "self_employed": 45,
      "professional": 45,
      "other": 45
    },
    "handoff_link_days": 1,
    "sanction_alert_days": 1,
    "commission_overdue_days": 7
  },
  "meta": {}
}

Errors

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

PUT/v1/settings/loans

Save the loan desk settings

Audited; the change is an outbox event.

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

Request body

foir_bpsrequired: integer
default_rate_bpsrequired: integer
default_tenure_monthsrequired: integer
retirement_agerequired: object
retirement_age.salariedrequired: integer
retirement_age.self_employedrequired: integer
retirement_age.professionalrequired: integer
retirement_age.otherrequired: integer
handoff_link_daysrequired: integer
sanction_alert_daysrequired: integer
commission_overdue_daysrequired: integer

Response · 200

datarequired: LoanSettings
metarequired: object

Request

curl -X PUT 'https://api.propzolo.com/v1/settings/loans' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"foir_bps":1000,"default_rate_bps":100,"default_tenure_months":12,"retirement_age":{"salaried":45,"self_employed":45,"professional":45,"other":45},"handoff_link_days":1,"sanction_alert_days":1,"commission_overdue_days":7}'

Response example

{
  "data": {
    "foir_bps": 1000,
    "default_rate_bps": 100,
    "default_tenure_months": 12,
    "retirement_age": {
      "salaried": 45,
      "self_employed": 45,
      "professional": 45,
      "other": 45
    },
    "handoff_link_days": 1,
    "sanction_alert_days": 1,
    "commission_overdue_days": 7
  },
  "meta": {}
}

Errors

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