Channel partners

GET/v1/cp-disputes

The dispute queue: open first, oldest first

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

Parameters

statusquery: "open" | "decided" | "withdrawn"

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].statusrequired: "open" | "decided" | "withdrawn"
data[].reasonrequired: "other_partner" | "direct_enquiry"
data[].clientrequired: object
data[].client.namerequired: string or null
data[].client.phonerequired: string
data[].projectrequired: object or null
data[].project.idrequired: Id
Opaque record id.
data[].project.namerequired: string
data[].leadrequired: object or null
data[].lead.idrequired: Id
Opaque record id.
data[].lead.numberrequired: integer
data[].registration_idrequired: Id
Opaque record id.
data[].claimantrequired: object
data[].claimant.partnerrequired: object or null
data[].claimant.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].claimant.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].holderrequired: object
data[].holder.partnerrequired: object or null
data[].holder.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].holder.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].holder.kindrequired: "partner" | "direct"
data[].suggestionrequired: object
data[].suggestion.winnerrequired: "claimant" | "holder"
data[].suggestion.strengthrequired: "strong" | "weak"
data[].suggestion.textrequired: string
data[].evidencerequired: array of object
data[].evidence[].byrequired: "partner" | "member"
data[].evidence[].namerequired: string or null
data[].evidence[].noterequired: string
data[].evidence[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].decisionrequired: "award_claimant" | "keep_holder" or null
data[].decision_noterequired: string or null
data[].decided_byrequired: object or null
data[].decided_by.idrequired: Id
Opaque record id.
data[].decided_by.namerequired: string
data[].decided_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.
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "open",
      "reason": "other_partner",
      "client": {
        "name": "string",
        "phone": "string"
      },
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "registration_id": "cmusrceel0000q7kaafxqi1om",
      "claimant": {
        "partner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "firm_name": "string"
        },
        "registered_at": "2026-10-06T05:30:00.000Z",
        "verified_visit_at": "2026-10-06T05:30:00.000Z"
      },
      "holder": {
        "partner": {
          "id": "cmusrceel0000q7kaafxqi1om",
          "firm_name": "string"
        },
        "registered_at": "2026-10-06T05:30:00.000Z",
        "verified_visit_at": "2026-10-06T05:30:00.000Z",
        "kind": "partner"
      },
      "suggestion": {
        "winner": "claimant",
        "strength": "strong",
        "text": "string"
      },
      "evidence": [
        {
          "by": "partner",
          "name": "string",
          "note": "string",
          "at": "2026-10-06T05:30:00.000Z"
        }
      ],
      "decision": "award_claimant",
      "decision_note": "string",
      "decided_by": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "decided_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.
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/cp-disputes/{id}

A dispute with both sides’ evidence and the suggested outcome

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "open" | "decided" | "withdrawn"
data.reasonrequired: "other_partner" | "direct_enquiry"
data.clientrequired: object
data.client.namerequired: string or null
data.client.phonerequired: string
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.leadrequired: object or null
data.lead.idrequired: Id
Opaque record id.
data.lead.numberrequired: integer
data.registration_idrequired: Id
Opaque record id.
data.claimantrequired: object
data.claimant.partnerrequired: object or null
data.claimant.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.claimant.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holderrequired: object
data.holder.partnerrequired: object or null
data.holder.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.kindrequired: "partner" | "direct"
data.suggestionrequired: object
data.suggestion.winnerrequired: "claimant" | "holder"
data.suggestion.strengthrequired: "strong" | "weak"
data.suggestion.textrequired: string
data.evidencerequired: array of object
data.evidence[].byrequired: "partner" | "member"
data.evidence[].namerequired: string or null
data.evidence[].noterequired: string
data.evidence[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.decisionrequired: "award_claimant" | "keep_holder" or null
data.decision_noterequired: string or null
data.decided_byrequired: object or null
data.decided_by.idrequired: Id
Opaque record id.
data.decided_by.namerequired: string
data.decided_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.
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "open",
    "reason": "other_partner",
    "client": {
      "name": "string",
      "phone": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "registration_id": "cmusrceel0000q7kaafxqi1om",
    "claimant": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z"
    },
    "holder": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z",
      "kind": "partner"
    },
    "suggestion": {
      "winner": "claimant",
      "strength": "strong",
      "text": "string"
    },
    "evidence": [
      {
        "by": "partner",
        "name": "string",
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "decision": "award_claimant",
    "decision_note": "string",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_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/cp-disputes/{id}/decision

Decide a dispute (final; the reason is kept in the audit trail)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "award_claimant" | "keep_holder"
noterequired: string

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "open" | "decided" | "withdrawn"
data.reasonrequired: "other_partner" | "direct_enquiry"
data.clientrequired: object
data.client.namerequired: string or null
data.client.phonerequired: string
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.leadrequired: object or null
data.lead.idrequired: Id
Opaque record id.
data.lead.numberrequired: integer
data.registration_idrequired: Id
Opaque record id.
data.claimantrequired: object
data.claimant.partnerrequired: object or null
data.claimant.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.claimant.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holderrequired: object
data.holder.partnerrequired: object or null
data.holder.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.kindrequired: "partner" | "direct"
data.suggestionrequired: object
data.suggestion.winnerrequired: "claimant" | "holder"
data.suggestion.strengthrequired: "strong" | "weak"
data.suggestion.textrequired: string
data.evidencerequired: array of object
data.evidence[].byrequired: "partner" | "member"
data.evidence[].namerequired: string or null
data.evidence[].noterequired: string
data.evidence[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.decisionrequired: "award_claimant" | "keep_holder" or null
data.decision_noterequired: string or null
data.decided_byrequired: object or null
data.decided_by.idrequired: Id
Opaque record id.
data.decided_by.namerequired: string
data.decided_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.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp-disputes/{id}/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"award_claimant","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "open",
    "reason": "other_partner",
    "client": {
      "name": "string",
      "phone": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "registration_id": "cmusrceel0000q7kaafxqi1om",
    "claimant": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z"
    },
    "holder": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z",
      "kind": "partner"
    },
    "suggestion": {
      "winner": "claimant",
      "strength": "strong",
      "text": "string"
    },
    "evidence": [
      {
        "by": "partner",
        "name": "string",
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "decision": "award_claimant",
    "decision_note": "string",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_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/cp-disputes/{id}/evidence

Add a note to a dispute’s evidence (a member)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

noterequired: string

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "open" | "decided" | "withdrawn"
data.reasonrequired: "other_partner" | "direct_enquiry"
data.clientrequired: object
data.client.namerequired: string or null
data.client.phonerequired: string
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.leadrequired: object or null
data.lead.idrequired: Id
Opaque record id.
data.lead.numberrequired: integer
data.registration_idrequired: Id
Opaque record id.
data.claimantrequired: object
data.claimant.partnerrequired: object or null
data.claimant.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.claimant.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holderrequired: object
data.holder.partnerrequired: object or null
data.holder.registered_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.holder.kindrequired: "partner" | "direct"
data.suggestionrequired: object
data.suggestion.winnerrequired: "claimant" | "holder"
data.suggestion.strengthrequired: "strong" | "weak"
data.suggestion.textrequired: string
data.evidencerequired: array of object
data.evidence[].byrequired: "partner" | "member"
data.evidence[].namerequired: string or null
data.evidence[].noterequired: string
data.evidence[].atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.decisionrequired: "award_claimant" | "keep_holder" or null
data.decision_noterequired: string or null
data.decided_byrequired: object or null
data.decided_by.idrequired: Id
Opaque record id.
data.decided_by.namerequired: string
data.decided_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.
metarequired: object

Request

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

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "open",
    "reason": "other_partner",
    "client": {
      "name": "string",
      "phone": "string"
    },
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "registration_id": "cmusrceel0000q7kaafxqi1om",
    "claimant": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z"
    },
    "holder": {
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "registered_at": "2026-10-06T05:30:00.000Z",
      "verified_visit_at": "2026-10-06T05:30:00.000Z",
      "kind": "partner"
    },
    "suggestion": {
      "winner": "claimant",
      "strength": "strong",
      "text": "string"
    },
    "evidence": [
      {
        "by": "partner",
        "name": "string",
        "note": "string",
        "at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "decision": "award_claimant",
    "decision_note": "string",
    "decided_by": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "decided_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.

GET/v1/cp-registrations

Client registrations by partners (portal and walk-in), newest first

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

Parameters

statequery: "pending" | "active" | "expiring" | "expired" | "disputed" | "rejected"
partner_idquery: Id
Opaque record id.
qquery: string

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].partnerrequired: object
data[].partner.idrequired: Id
Opaque record id.
data[].partner.firm_namerequired: string
data[].client_namerequired: string or null
data[].phonerequired: string
Follows the contact.phone field rule.
data[].projectrequired: object or null
data[].project.idrequired: Id
Opaque record id.
data[].project.namerequired: string
data[].sourcerequired: "walk_in" | "portal"
data[].statusrequired: string
data[].staterequired: "pending" | "active" | "expiring" | "expired" | "disputed" | "rejected"
data[].noterequired: string
data[].lock_daysrequired: integer or null
data[].expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].days_leftrequired: integer or null
data[].leadrequired: object or null
data[].lead.idrequired: Id
Opaque record id.
data[].lead.numberrequired: integer
data[].dispute_idrequired: Id or null
Opaque record id.
data[].verified_visit_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.
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "partner": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "firm_name": "string"
      },
      "client_name": "string",
      "phone": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "source": "walk_in",
      "status": "string",
      "state": "pending",
      "note": "string",
      "lock_days": 0,
      "expires_at": "2026-10-06T05:30:00.000Z",
      "days_left": 0,
      "lead": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "number": 0
      },
      "dispute_id": "cmusrceel0000q7kaafxqi1om",
      "verified_visit_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.
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/cp-registrations/{id}/decision

Accept or reject a pending registration (not one in dispute — decide the dispute)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

acceptrequired: boolean
note: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.partnerrequired: object
data.partner.idrequired: Id
Opaque record id.
data.partner.firm_namerequired: string
data.client_namerequired: string or null
data.phonerequired: string
Follows the contact.phone field rule.
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.sourcerequired: "walk_in" | "portal"
data.statusrequired: string
data.staterequired: "pending" | "active" | "expiring" | "expired" | "disputed" | "rejected"
data.noterequired: string
data.lock_daysrequired: integer or null
data.expires_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.days_leftrequired: integer or null
data.leadrequired: object or null
data.lead.idrequired: Id
Opaque record id.
data.lead.numberrequired: integer
data.dispute_idrequired: Id or null
Opaque record id.
data.verified_visit_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.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp-registrations/{id}/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"accept":true,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string"
    },
    "client_name": "string",
    "phone": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "source": "walk_in",
    "status": "string",
    "state": "pending",
    "note": "string",
    "lock_days": 0,
    "expires_at": "2026-10-06T05:30:00.000Z",
    "days_left": 0,
    "lead": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "number": 0
    },
    "dispute_id": "cmusrceel0000q7kaafxqi1om",
    "verified_visit_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/partner-agreements/{id}/cancel

Cancel a signing request that is still open

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.signer_namerequired: string
data.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.last_errorrequired: string or null
data.created_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/partner-agreements/{id}/cancel' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "queued",
    "signer_name": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "signed_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "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.

GET/v1/partner-agreements/{id}/download

A short-lived link to the agreement (the signed copy once signed)

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

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/partner-agreements/{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/partner-collateral

The collateral library (published and archived)

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

Parameters

project_idquery: Id
Opaque record id.
statusquery: "published" | "archived"

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].projectrequired: object or null
data[].project.idrequired: Id
Opaque record id.
data[].project.namerequired: string
data[].kindrequired: "brochure" | "floor_plan" | "price_sheet" | "creative" | "video" | "other"
data[].titlerequired: string
data[].descriptionrequired: string or null
data[].file_namerequired: string or null
data[].content_typerequired: string or null
data[].size_bytesrequired: integer or null
data[].link_urlrequired: string or null
data[].cobrandrequired: boolean
data[].statusrequired: "published" | "archived"
data[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].cobrand_linerequired: string or null
Portal only: the partner’s share line.
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "kind": "brochure",
      "title": "string",
      "description": "string",
      "file_name": "string",
      "content_type": "string",
      "size_bytes": 0,
      "link_url": "string",
      "cobrand": true,
      "status": "published",
      "created_at": "2026-10-06T05:30:00.000Z",
      "cobrand_line": "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.
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/partner-collateral

Publish a collateral item (an uploaded file or an https link)

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

Request body

project_id: Id or null
Opaque record id.
kindrequired: "brochure" | "floor_plan" | "price_sheet" | "creative" | "video" | "other"
titlerequired: string
description: string or null
key: string or null
content_type: string or null
size: integer or null
file_name: string or null
link_url: string (uri) or null
cobrand: boolean

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.kindrequired: "brochure" | "floor_plan" | "price_sheet" | "creative" | "video" | "other"
data.titlerequired: string
data.descriptionrequired: string or null
data.file_namerequired: string or null
data.content_typerequired: string or null
data.size_bytesrequired: integer or null
data.link_urlrequired: string or null
data.cobrandrequired: boolean
data.statusrequired: "published" | "archived"
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.cobrand_linerequired: string or null
Portal only: the partner’s share line.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/partner-collateral' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"project_id":"cmusrceel0000q7kaafxqi1om","kind":"brochure","title":"string","description":"string","key":"string","content_type":"string","size":1,"file_name":"string","link_url":"https://example.com","cobrand":true}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "kind": "brochure",
    "title": "string",
    "description": "string",
    "file_name": "string",
    "content_type": "string",
    "size_bytes": 0,
    "link_url": "string",
    "cobrand": true,
    "status": "published",
    "created_at": "2026-10-06T05:30:00.000Z",
    "cobrand_line": "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.

POST/v1/partner-collateral/uploads

Upload a collateral file (PDF, image or video)

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

Request body

content_typerequired: string
sizerequired: integer
filename: string or null

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.
metarequired: object

Request

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

Response example

{
  "data": {
    "key": "string",
    "url": "string",
    "method": "PUT",
    "headers": {},
    "expires_at": "2026-10-06T05:30:00.000Z"
  },
  "meta": {}
}

Errors

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

PATCH/v1/partner-collateral/{id}

Edit, archive or republish a collateral item

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

title: string
description: string or null
project_id: Id or null
Opaque record id.
kind: "brochure" | "floor_plan" | "price_sheet" | "creative" | "video" | "other"
cobrand: boolean
status: "published" | "archived"

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.kindrequired: "brochure" | "floor_plan" | "price_sheet" | "creative" | "video" | "other"
data.titlerequired: string
data.descriptionrequired: string or null
data.file_namerequired: string or null
data.content_typerequired: string or null
data.size_bytesrequired: integer or null
data.link_urlrequired: string or null
data.cobrandrequired: boolean
data.statusrequired: "published" | "archived"
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.cobrand_linerequired: string or null
Portal only: the partner’s share line.
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/partner-collateral/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"title":"string","description":"string","project_id":"cmusrceel0000q7kaafxqi1om","kind":"brochure","cobrand":true,"status":"published"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "kind": "brochure",
    "title": "string",
    "description": "string",
    "file_name": "string",
    "content_type": "string",
    "size_bytes": 0,
    "link_url": "string",
    "cobrand": true,
    "status": "published",
    "created_at": "2026-10-06T05:30:00.000Z",
    "cobrand_line": "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/partner-collateral/{id}/download

A short-lived link to a collateral file (partners: published items only)

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

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/partner-collateral/{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/partner-documents/{id}/download

A short-lived link to a partner’s document (members, or the partner itself)

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

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/partner-documents/{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.

POST/v1/partner-documents/{id}/review

Verify or reject a partner’s KYC document

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

verifiedrequired: boolean
note: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.labelrequired: string
data.statusrequired: "submitted" | "verified" | "rejected"
data.file_namerequired: string or null
data.content_typerequired: string
data.size_bytesrequired: integer
data.review_noterequired: string or null
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/partner-documents/{id}/review' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"verified":true,"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "label": "string",
    "status": "submitted",
    "file_name": "string",
    "content_type": "string",
    "size_bytes": 0,
    "review_note": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "reviewed_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/partner-kyc-shares/{id}/decision

Accept or reject a shared KYC document

Accepted counts as verified on the onboarding checklist. A rejection needs a note. Decided once; audited.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

decisionrequired: "accept" | "reject"
note: string or null

Response · 200

datarequired: PartnerKycShare
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/partner-kyc-shares/{id}/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"decision":"accept","note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "partner_id": "cmusrceel0000q7kaafxqi1om",
    "source_company_name": "string",
    "kind": "pan",
    "source_verified_at": "2026-10-06T05:30:00.000Z",
    "source_pan_masked": "string",
    "consent_version": "string",
    "status": "shared",
    "decided_at": "2026-10-06T05:30:00.000Z",
    "decision_note": "string",
    "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.

GET/v1/partners

Channel partners, with onboarding status and live registrations

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

Parameters

statusquery: "pending" | "approved" | "rejected" | "suspended"
qquery: string

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].firm_namerequired: string
data[].typerequired: string
data[].contact_namerequired: string or null
data[].phonerequired: string or null
data[].emailrequired: string or null
data[].statusrequired: "pending" | "approved" | "rejected" | "suspended"
data[].tierrequired: string or null
data[].rera_agent_numberrequired: string or null
data[].rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data[].rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data[].kycrequired: object
data[].kyc.panrequired: string or null
Masked PAN (XXXXXX234F); null when missing or hidden.
data[].kyc.gstinrequired: string or null
data[].kyc.bankrequired: string or null
IFSC and masked account (HDFC0001234 · ••••5678).
data[].managerrequired: object or null
data[].manager.idrequired: Id
Opaque record id.
data[].manager.namerequired: string
data[].portal_usersrequired: integer
data[].registrationsrequired: object
data[].registrations.activerequired: integer
data[].registrations.disputedrequired: integer
data[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "type": "string",
      "contact_name": "string",
      "phone": "string",
      "email": "string",
      "status": "pending",
      "tier": "string",
      "rera_agent_number": "string",
      "rera_expires_on": "2026-10-06",
      "rera_status": "missing",
      "kyc": {
        "pan": "string",
        "gstin": "string",
        "bank": "string"
      },
      "manager": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "portal_users": 0,
      "registrations": {
        "active": 0,
        "disputed": 0
      },
      "created_at": "2026-10-06T05:30:00.000Z",
      "approved_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/partners

Add a partner firm (pending until approved)

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

Request body

firm_namerequired: string
type: "cp_firm" | "broker" | "referrer" | "co_broker"
tier: string or null
tag_validity_days: integer or null
manager_id: Id or null
Opaque record id.
contact_name: string or null
phone: string or null
email: string (email) or null
rera_agent_number: string or null
rera_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
rera_state: string or null
pan: string or null
Stored encrypted; returned masked.
gstin: string or null
bank: object or null
bank.account_numberrequired: string
bank.ifscrequired: string
bank.holder_namerequired: string
bank.bank_name: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.firm_namerequired: string
data.typerequired: string
data.contact_namerequired: string or null
data.phonerequired: string or null
data.emailrequired: string or null
data.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.tierrequired: string or null
data.rera_agent_numberrequired: string or null
data.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.kycrequired: object
data.kyc.panrequired: string or null
Masked PAN (XXXXXX234F); null when missing or hidden.
data.kyc.gstinrequired: string or null
data.kyc.bankrequired: string or null
IFSC and masked account (HDFC0001234 · ••••5678).
data.managerrequired: object or null
data.manager.idrequired: Id
Opaque record id.
data.manager.namerequired: string
data.portal_usersrequired: integer
data.registrationsrequired: object
data.registrations.activerequired: integer
data.registrations.disputedrequired: integer
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.rera_staterequired: string or null
data.tag_validity_daysrequired: integer or null
data.status_reasonrequired: string or null
data.invited_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object
data.checklist.stepsrequired: array of object
data.checklist.missingrequired: array of string
data.checklist.can_approverequired: boolean
data.documentsrequired: array of object
data.documents[].idrequired: Id
Opaque record id.
data.documents[].kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.documents[].labelrequired: string
data.documents[].statusrequired: "submitted" | "verified" | "rejected"
data.documents[].file_namerequired: string or null
data.documents[].content_typerequired: string
data.documents[].size_bytesrequired: integer
data.documents[].review_noterequired: string or null
data.documents[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.documents[].reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreementrequired: object or null
data.agreement.idrequired: Id
Opaque record id.
data.agreement.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.agreement.signer_namerequired: string
data.agreement.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.last_errorrequired: string or null
data.agreement.created_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/partners' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"firm_name":"string","type":"cp_firm","tier":"string","tag_validity_days":7,"manager_id":"cmusrceel0000q7kaafxqi1om","contact_name":"string","phone":"string","email":"name@example.com","rera_agent_number":"string","rera_expires_on":"2026-10-06","rera_state":"string","pan":"string","gstin":"string","bank":{"account_number":"string","ifsc":"string","holder_name":"string","bank_name":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "firm_name": "string",
    "type": "string",
    "contact_name": "string",
    "phone": "string",
    "email": "string",
    "status": "pending",
    "tier": "string",
    "rera_agent_number": "string",
    "rera_expires_on": "2026-10-06",
    "rera_status": "missing",
    "kyc": {
      "pan": "string",
      "gstin": "string",
      "bank": "string"
    },
    "manager": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "portal_users": 0,
    "registrations": {
      "active": 0,
      "disputed": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "rera_state": "string",
    "tag_validity_days": 0,
    "status_reason": "string",
    "invited_at": "2026-10-06T05:30:00.000Z",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "checklist": {
      "steps": [
        {
          "key": "string",
          "label": "string",
          "done": true,
          "required": true
        }
      ],
      "missing": [
        "string"
      ],
      "can_approve": true
    },
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "submitted",
        "file_name": "string",
        "content_type": "string",
        "size_bytes": 0,
        "review_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "reviewed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "queued",
      "signer_name": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "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.
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/partners/{id}

A partner with its onboarding checklist, documents and agreement

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.firm_namerequired: string
data.typerequired: string
data.contact_namerequired: string or null
data.phonerequired: string or null
data.emailrequired: string or null
data.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.tierrequired: string or null
data.rera_agent_numberrequired: string or null
data.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.kycrequired: object
data.kyc.panrequired: string or null
Masked PAN (XXXXXX234F); null when missing or hidden.
data.kyc.gstinrequired: string or null
data.kyc.bankrequired: string or null
IFSC and masked account (HDFC0001234 · ••••5678).
data.managerrequired: object or null
data.manager.idrequired: Id
Opaque record id.
data.manager.namerequired: string
data.portal_usersrequired: integer
data.registrationsrequired: object
data.registrations.activerequired: integer
data.registrations.disputedrequired: integer
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.rera_staterequired: string or null
data.tag_validity_daysrequired: integer or null
data.status_reasonrequired: string or null
data.invited_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object
data.checklist.stepsrequired: array of object
data.checklist.missingrequired: array of string
data.checklist.can_approverequired: boolean
data.documentsrequired: array of object
data.documents[].idrequired: Id
Opaque record id.
data.documents[].kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.documents[].labelrequired: string
data.documents[].statusrequired: "submitted" | "verified" | "rejected"
data.documents[].file_namerequired: string or null
data.documents[].content_typerequired: string
data.documents[].size_bytesrequired: integer
data.documents[].review_noterequired: string or null
data.documents[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.documents[].reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreementrequired: object or null
data.agreement.idrequired: Id
Opaque record id.
data.agreement.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.agreement.signer_namerequired: string
data.agreement.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.last_errorrequired: string or null
data.agreement.created_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/partners/{id}' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "firm_name": "string",
    "type": "string",
    "contact_name": "string",
    "phone": "string",
    "email": "string",
    "status": "pending",
    "tier": "string",
    "rera_agent_number": "string",
    "rera_expires_on": "2026-10-06",
    "rera_status": "missing",
    "kyc": {
      "pan": "string",
      "gstin": "string",
      "bank": "string"
    },
    "manager": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "portal_users": 0,
    "registrations": {
      "active": 0,
      "disputed": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "rera_state": "string",
    "tag_validity_days": 0,
    "status_reason": "string",
    "invited_at": "2026-10-06T05:30:00.000Z",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "checklist": {
      "steps": [
        {
          "key": "string",
          "label": "string",
          "done": true,
          "required": true
        }
      ],
      "missing": [
        "string"
      ],
      "can_approve": true
    },
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "submitted",
        "file_name": "string",
        "content_type": "string",
        "size_bytes": 0,
        "review_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "reviewed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "queued",
      "signer_name": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "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.

PATCH/v1/partners/{id}

Update a partner’s profile and KYC details

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

firm_name: string
type: "cp_firm" | "broker" | "referrer" | "co_broker"
tier: string or null
tag_validity_days: integer or null
manager_id: Id or null
Opaque record id.
contact_name: string or null
phone: string or null
email: string (email) or null
rera_agent_number: string or null
rera_expires_on: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
rera_state: string or null
pan: string or null
Stored encrypted; returned masked.
gstin: string or null
bank: object or null
bank.account_numberrequired: string
bank.ifscrequired: string
bank.holder_namerequired: string
bank.bank_name: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.firm_namerequired: string
data.typerequired: string
data.contact_namerequired: string or null
data.phonerequired: string or null
data.emailrequired: string or null
data.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.tierrequired: string or null
data.rera_agent_numberrequired: string or null
data.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.kycrequired: object
data.kyc.panrequired: string or null
Masked PAN (XXXXXX234F); null when missing or hidden.
data.kyc.gstinrequired: string or null
data.kyc.bankrequired: string or null
IFSC and masked account (HDFC0001234 · ••••5678).
data.managerrequired: object or null
data.manager.idrequired: Id
Opaque record id.
data.manager.namerequired: string
data.portal_usersrequired: integer
data.registrationsrequired: object
data.registrations.activerequired: integer
data.registrations.disputedrequired: integer
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.rera_staterequired: string or null
data.tag_validity_daysrequired: integer or null
data.status_reasonrequired: string or null
data.invited_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object
data.checklist.stepsrequired: array of object
data.checklist.missingrequired: array of string
data.checklist.can_approverequired: boolean
data.documentsrequired: array of object
data.documents[].idrequired: Id
Opaque record id.
data.documents[].kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.documents[].labelrequired: string
data.documents[].statusrequired: "submitted" | "verified" | "rejected"
data.documents[].file_namerequired: string or null
data.documents[].content_typerequired: string
data.documents[].size_bytesrequired: integer
data.documents[].review_noterequired: string or null
data.documents[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.documents[].reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreementrequired: object or null
data.agreement.idrequired: Id
Opaque record id.
data.agreement.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.agreement.signer_namerequired: string
data.agreement.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.last_errorrequired: string or null
data.agreement.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/partners/{id}' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"firm_name":"string","type":"cp_firm","tier":"string","tag_validity_days":7,"manager_id":"cmusrceel0000q7kaafxqi1om","contact_name":"string","phone":"string","email":"name@example.com","rera_agent_number":"string","rera_expires_on":"2026-10-06","rera_state":"string","pan":"string","gstin":"string","bank":{"account_number":"string","ifsc":"string","holder_name":"string","bank_name":"string"}}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "firm_name": "string",
    "type": "string",
    "contact_name": "string",
    "phone": "string",
    "email": "string",
    "status": "pending",
    "tier": "string",
    "rera_agent_number": "string",
    "rera_expires_on": "2026-10-06",
    "rera_status": "missing",
    "kyc": {
      "pan": "string",
      "gstin": "string",
      "bank": "string"
    },
    "manager": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "portal_users": 0,
    "registrations": {
      "active": 0,
      "disputed": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "rera_state": "string",
    "tag_validity_days": 0,
    "status_reason": "string",
    "invited_at": "2026-10-06T05:30:00.000Z",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "checklist": {
      "steps": [
        {
          "key": "string",
          "label": "string",
          "done": true,
          "required": true
        }
      ],
      "missing": [
        "string"
      ],
      "can_approve": true
    },
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "submitted",
        "file_name": "string",
        "content_type": "string",
        "size_bytes": 0,
        "review_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "reviewed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "queued",
      "signer_name": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "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/partners/{id}/agreement

Send the channel-partner agreement for e-signature

Freezes the agreement as a PDF and queues it for the e-sign partner. One live request per partner; until the platform’s e-sign partner is switched on the request waits.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.signer_namerequired: string
data.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.last_errorrequired: string or null
data.created_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/partners/{id}/agreement' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "status": "queued",
    "signer_name": "string",
    "sent_at": "2026-10-06T05:30:00.000Z",
    "signed_at": "2026-10-06T05:30:00.000Z",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "last_error": "string",
    "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/partners/{id}/decision

Approve, reject, suspend or reinstate a partner

Approval needs every required onboarding step (Settings → Partners). Reject and suspend need a reason.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

actionrequired: "approve" | "reject" | "suspend" | "reinstate"
reason: string or null

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.firm_namerequired: string
data.typerequired: string
data.contact_namerequired: string or null
data.phonerequired: string or null
data.emailrequired: string or null
data.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.tierrequired: string or null
data.rera_agent_numberrequired: string or null
data.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.kycrequired: object
data.kyc.panrequired: string or null
Masked PAN (XXXXXX234F); null when missing or hidden.
data.kyc.gstinrequired: string or null
data.kyc.bankrequired: string or null
IFSC and masked account (HDFC0001234 · ••••5678).
data.managerrequired: object or null
data.manager.idrequired: Id
Opaque record id.
data.manager.namerequired: string
data.portal_usersrequired: integer
data.registrationsrequired: object
data.registrations.activerequired: integer
data.registrations.disputedrequired: integer
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.approved_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.rera_staterequired: string or null
data.tag_validity_daysrequired: integer or null
data.status_reasonrequired: string or null
data.invited_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object
data.checklist.stepsrequired: array of object
data.checklist.missingrequired: array of string
data.checklist.can_approverequired: boolean
data.documentsrequired: array of object
data.documents[].idrequired: Id
Opaque record id.
data.documents[].kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.documents[].labelrequired: string
data.documents[].statusrequired: "submitted" | "verified" | "rejected"
data.documents[].file_namerequired: string or null
data.documents[].content_typerequired: string
data.documents[].size_bytesrequired: integer
data.documents[].review_noterequired: string or null
data.documents[].created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.documents[].reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreementrequired: object or null
data.agreement.idrequired: Id
Opaque record id.
data.agreement.statusrequired: "queued" | "sent" | "signed" | "declined" | "expired" | "cancelled" | …
data.agreement.signer_namerequired: string
data.agreement.sent_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.signed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.agreement.last_errorrequired: string or null
data.agreement.created_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/partners/{id}/decision' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"action":"approve","reason":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "firm_name": "string",
    "type": "string",
    "contact_name": "string",
    "phone": "string",
    "email": "string",
    "status": "pending",
    "tier": "string",
    "rera_agent_number": "string",
    "rera_expires_on": "2026-10-06",
    "rera_status": "missing",
    "kyc": {
      "pan": "string",
      "gstin": "string",
      "bank": "string"
    },
    "manager": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "portal_users": 0,
    "registrations": {
      "active": 0,
      "disputed": 0
    },
    "created_at": "2026-10-06T05:30:00.000Z",
    "approved_at": "2026-10-06T05:30:00.000Z",
    "rera_state": "string",
    "tag_validity_days": 0,
    "status_reason": "string",
    "invited_at": "2026-10-06T05:30:00.000Z",
    "kyc_submitted_at": "2026-10-06T05:30:00.000Z",
    "checklist": {
      "steps": [
        {
          "key": "string",
          "label": "string",
          "done": true,
          "required": true
        }
      ],
      "missing": [
        "string"
      ],
      "can_approve": true
    },
    "documents": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "label": "string",
        "status": "submitted",
        "file_name": "string",
        "content_type": "string",
        "size_bytes": 0,
        "review_note": "string",
        "created_at": "2026-10-06T05:30:00.000Z",
        "reviewed_at": "2026-10-06T05:30:00.000Z"
      }
    ],
    "agreement": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "queued",
      "signer_name": "string",
      "sent_at": "2026-10-06T05:30:00.000Z",
      "signed_at": "2026-10-06T05:30:00.000Z",
      "expires_at": "2026-10-06T05:30:00.000Z",
      "last_error": "string",
      "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/partners/{id}/documents

Register an uploaded KYC document

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
keyrequired: string
content_typerequired: string
sizerequired: integer
file_name: string or null

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.kindrequired: "pan" | "gst" | "rera" | "cancelled_cheque" | "address_proof" | "agreement" | …
data.labelrequired: string
data.statusrequired: "submitted" | "verified" | "rejected"
data.file_namerequired: string or null
data.content_typerequired: string
data.size_bytesrequired: integer
data.review_noterequired: string or null
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.reviewed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/partners/{id}/documents' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"kind":"pan","key":"string","content_type":"string","size":1,"file_name":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "kind": "pan",
    "label": "string",
    "status": "submitted",
    "file_name": "string",
    "content_type": "string",
    "size_bytes": 0,
    "review_note": "string",
    "created_at": "2026-10-06T05:30:00.000Z",
    "reviewed_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/partners/{id}/documents/uploads

Upload a KYC document (PDF or photo) for a partner

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

content_typerequired: string
sizerequired: integer
filename: string or null

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.
metarequired: object

Request

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

Response example

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

Invite the partner to the portal (a link to share once)

Uses the partner’s phone (or email). Partner portal users take no paid seat.

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 201

datarequired: object
data.urlrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.sharerequired: object
data.share.messagerequired: string
data.share.whatsapp_urlrequired: string or null
data.share.email_urlrequired: string or null
metarequired: object

Request

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

Response example

{
  "data": {
    "url": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "share": {
      "message": "string",
      "whatsapp_url": "string",
      "email_url": "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.

GET/v1/partners/{id}/kyc-shares

KYC a partner shared from other builders

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: array of PartnerKycShare
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "partner_id": "cmusrceel0000q7kaafxqi1om",
      "source_company_name": "string",
      "kind": "pan",
      "source_verified_at": "2026-10-06T05:30:00.000Z",
      "source_pan_masked": "string",
      "consent_version": "string",
      "status": "shared",
      "decided_at": "2026-10-06T05:30:00.000Z",
      "decision_note": "string",
      "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.

GET/v1/settings/partners

Partner settings: lock windows, alerts, the price toggle and onboarding rules

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

Response · 200

datarequired: object
data.company_lock_daysrequired: integer
The company window (shared with the kiosk policy).
data.project_lock_daysrequired: map of integer
data.visit_extension_daysrequired: integer
data.expiry_alert_daysrequired: integer
data.rera_alert_daysrequired: integer
data.show_pricesrequired: boolean
data.require_agreementrequired: boolean
data.require_kycrequired: boolean
data.agreement_termsrequired: string or null
data.registrations_per_dayrequired: integer
Portal registrations one partner may submit a day.
data.registration_client_otprequired: boolean
A registration needs the one-time code sent to the client (the client consents).
metarequired: object

Request

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

Response example

{
  "data": {
    "company_lock_days": 0,
    "project_lock_days": {},
    "visit_extension_days": 0,
    "expiry_alert_days": 0,
    "rera_alert_days": 0,
    "show_prices": true,
    "require_agreement": true,
    "require_kyc": true,
    "agreement_terms": "string",
    "registrations_per_day": 0,
    "registration_client_otp": true
  },
  "meta": {}
}

Errors

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

PATCH/v1/settings/partners

Change the partner settings

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

Request body

company_lock_days: integer
project_lock_days: map of integer
visit_extension_days: integer
expiry_alert_days: integer
rera_alert_days: integer
show_prices: boolean
require_agreement: boolean
require_kyc: boolean
agreement_terms: string or null
registrations_per_day: integer
registration_client_otp: boolean

Response · 200

datarequired: object
data.company_lock_daysrequired: integer
The company window (shared with the kiosk policy).
data.project_lock_daysrequired: map of integer
data.visit_extension_daysrequired: integer
data.expiry_alert_daysrequired: integer
data.rera_alert_daysrequired: integer
data.show_pricesrequired: boolean
data.require_agreementrequired: boolean
data.require_kycrequired: boolean
data.agreement_termsrequired: string or null
data.registrations_per_dayrequired: integer
Portal registrations one partner may submit a day.
data.registration_client_otprequired: boolean
A registration needs the one-time code sent to the client (the client consents).
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/settings/partners' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"company_lock_days":0,"project_lock_days":{},"visit_extension_days":0,"expiry_alert_days":0,"rera_alert_days":0,"show_prices":true,"require_agreement":true,"require_kyc":true,"agreement_terms":"string","registrations_per_day":0,"registration_client_otp":true}'

Response example

{
  "data": {
    "company_lock_days": 0,
    "project_lock_days": {},
    "visit_extension_days": 0,
    "expiry_alert_days": 0,
    "rera_alert_days": 0,
    "show_prices": true,
    "require_agreement": true,
    "require_kyc": true,
    "agreement_terms": "string",
    "registrations_per_day": 0,
    "registration_client_otp": true
  },
  "meta": {}
}

Errors

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