Partner portal

GET/v1/cp/collateral

Published collateral with the partner’s co-brand line

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

Parameters

project_idquery: Id
Opaque record id.

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/cp/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.

GET/v1/cp/inventory

Projects with released inventory and their availability

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

Response · 200

datarequired: object
data.show_pricesrequired: boolean
data.projectsrequired: array of object
data.projects[].idrequired: Id
Opaque record id.
data.projects[].namerequired: string
data.projects[].cityrequired: string or null
data.projects[].rera_numberrequired: string or null
data.projects[].lock_daysrequired: integer
data.projects[].countsrequired: object
metarequired: object

Request

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

Response example

{
  "data": {
    "show_prices": true,
    "projects": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "city": "string",
        "rera_number": "string",
        "lock_days": 0,
        "counts": {
          "available": 0,
          "on_hold": 0,
          "unavailable": 0
        }
      }
    ]
  },
  "meta": {}
}

Errors

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

GET/v1/cp/inventory/{id}

The released units of a project, tower by tower (availability only)

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

Parameters

idpathrequired: Id
Opaque record id.

Response · 200

datarequired: object
data.projectrequired: object
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.project.rera_numberrequired: string or null
data.show_pricesrequired: boolean
data.countsrequired: object
data.counts.availablerequired: integer
data.counts.on_holdrequired: integer
data.counts.unavailablerequired: integer
data.towersrequired: array of object
data.towers[].idrequired: Id or null
Opaque record id.
data.towers[].namerequired: string
data.towers[].unitsrequired: array of object
metarequired: object

Request

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

Response example

{
  "data": {
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string",
      "rera_number": "string"
    },
    "show_prices": true,
    "counts": {
      "available": 0,
      "on_hold": 0,
      "unavailable": 0
    },
    "towers": [
      {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string",
        "units": [
          {
            "id": "cmusrceel0000q7kaafxqi1om",
            "unit_no": "string",
            "floor": 0,
            "bhk": 0,
            "property_type": "string",
            "carpet_area": 0,
            "super_area": 0,
            "area_unit": "sqft",
            "facing": "string",
            "availability": "available",
            "price": 0
          }
        ]
      }
    ]
  },
  "meta": {}
}

Errors

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

GET/v1/cp/kyc-reuse

KYC verified by other builders, and what was shared here

Only the firms the signed-in partner user belongs to; never another builder’s files.

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

Response · 200

datarequired: PartnerPortalKycReuse
metarequired: object

Request

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

Response example

{
  "data": {
    "consent_version": "string",
    "consent_text": "string",
    "candidates": [
      {
        "source_company_id": "cmusrceel0000q7kaafxqi1om",
        "source_company_name": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "pan_masked": "string",
        "pan_matches": true,
        "shared": true
      }
    ],
    "shares": [
      {
        "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cp/kyc-reuse

Share KYC verified by other builders (with consent)

`consent` must be true and `consent_version` the current one (409 when the text changed). Every document must be the caller’s own verified document at another builder.

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

Request body

document_idsrequired: array of Id
Opaque record id.
consentrequired: boolean
consent_versionrequired: string

Response · 200

datarequired: PartnerPortalKycReuse
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/kyc-reuse' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"document_ids":["cmusrceel0000q7kaafxqi1om"],"consent":true,"consent_version":"string"}'

Response example

{
  "data": {
    "consent_version": "string",
    "consent_text": "string",
    "candidates": [
      {
        "source_company_id": "cmusrceel0000q7kaafxqi1om",
        "source_company_name": "string",
        "document_id": "cmusrceel0000q7kaafxqi1om",
        "kind": "pan",
        "verified_at": "2026-10-06T05:30:00.000Z",
        "pan_masked": "string",
        "pan_matches": true,
        "shared": true
      }
    ],
    "shares": [
      {
        "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.
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/me

The partner’s own profile, onboarding checklist, agreement and counts

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

Response · 200

datarequired: object
data.linkedrequired: boolean
false: this member is not a partner (an owner previewing the portal).
data.companyrequired: object
data.company.namerequired: string
data.partnerrequired: object or null
data.partner.idrequired: Id
Opaque record id.
data.partner.firm_namerequired: string
data.partner.typerequired: string
data.partner.contact_namerequired: string or null
data.partner.phonerequired: string or null
data.partner.emailrequired: string or null
data.partner.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.partner.status_reasonrequired: string or null
data.partner.rera_agent_numberrequired: string or null
data.partner.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.partner.rera_staterequired: string or null
data.partner.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.partner.kycrequired: object
data.partner.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object or null
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.
data.agreement.can_signrequired: boolean
data.countsrequired: object
data.counts.activerequired: integer
data.counts.expiringrequired: integer
data.counts.disputedrequired: integer
data.counts.upcoming_visitsrequired: integer
data.lock_daysrequired: integer
data.visit_extension_daysrequired: integer
data.registration_client_otprequired: boolean
Registering a client needs the code sent to them.
metarequired: object

Request

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

Response example

{
  "data": {
    "linked": true,
    "company": {
      "name": "string"
    },
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "type": "string",
      "contact_name": "string",
      "phone": "string",
      "email": "string",
      "status": "pending",
      "status_reason": "string",
      "rera_agent_number": "string",
      "rera_expires_on": "2026-10-06",
      "rera_state": "string",
      "rera_status": "missing",
      "kyc": {
        "pan": "string",
        "gstin": "string",
        "bank": "string"
      },
      "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",
      "can_sign": true
    },
    "counts": {
      "active": 0,
      "expiring": 0,
      "disputed": 0,
      "upcoming_visits": 0
    },
    "lock_days": 0,
    "visit_extension_days": 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/cp/me

Fill in or correct the partner’s own KYC details

Changing PAN, GSTIN, bank or RERA details of an approved partner sends it back for review.

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

Request body

firm_name: string
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.linkedrequired: boolean
false: this member is not a partner (an owner previewing the portal).
data.companyrequired: object
data.company.namerequired: string
data.partnerrequired: object or null
data.partner.idrequired: Id
Opaque record id.
data.partner.firm_namerequired: string
data.partner.typerequired: string
data.partner.contact_namerequired: string or null
data.partner.phonerequired: string or null
data.partner.emailrequired: string or null
data.partner.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.partner.status_reasonrequired: string or null
data.partner.rera_agent_numberrequired: string or null
data.partner.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.partner.rera_staterequired: string or null
data.partner.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.partner.kycrequired: object
data.partner.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object or null
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.
data.agreement.can_signrequired: boolean
data.countsrequired: object
data.counts.activerequired: integer
data.counts.expiringrequired: integer
data.counts.disputedrequired: integer
data.counts.upcoming_visitsrequired: integer
data.lock_daysrequired: integer
data.visit_extension_daysrequired: integer
data.registration_client_otprequired: boolean
Registering a client needs the code sent to them.
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/cp/me' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"firm_name":"string","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": {
    "linked": true,
    "company": {
      "name": "string"
    },
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "type": "string",
      "contact_name": "string",
      "phone": "string",
      "email": "string",
      "status": "pending",
      "status_reason": "string",
      "rera_agent_number": "string",
      "rera_expires_on": "2026-10-06",
      "rera_state": "string",
      "rera_status": "missing",
      "kyc": {
        "pan": "string",
        "gstin": "string",
        "bank": "string"
      },
      "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",
      "can_sign": true
    },
    "counts": {
      "active": 0,
      "expiring": 0,
      "disputed": 0,
      "upcoming_visits": 0
    },
    "lock_days": 0,
    "visit_extension_days": 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.

POST/v1/cp/me/agreement/sign

Open the e-sign partner’s signing page for the partner’s agreement

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

Response · 200

datarequired: object
data.urlrequired: string
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/me/agreement/sign' \
  -H 'Authorization: Bearer pz_live_…'

Response example

{
  "data": {
    "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.
429 Too many requests; retry after the Retry-After header.
500 Unexpected error; quote `error.request_id` to support.

POST/v1/cp/me/documents

Register an uploaded KYC document (a member verifies it)

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

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/cp/me/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.
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/me/documents/uploads

Upload one of the partner’s own KYC documents

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

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/cp/me/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.
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

The partner’s registered clients with their lock status

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

Parameters

statequery: "pending" | "active" | "expiring" | "expired" | "disputed" | "rejected"
qquery: string

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].client_namerequired: string or null
data[].phonerequired: string
data[].emailrequired: string or null
data[].projectrequired: object or null
data[].project.idrequired: Id
Opaque record id.
data[].project.namerequired: 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[].disputerequired: object or null
data[].dispute.idrequired: Id
Opaque record id.
data[].dispute.statusrequired: "open" | "decided" | "withdrawn"
data[].visitsrequired: integer
data[].verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].can_schedule_visitrequired: boolean
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",
      "client_name": "string",
      "phone": "string",
      "email": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "state": "pending",
      "note": "string",
      "lock_days": 0,
      "expires_at": "2026-10-06T05:30:00.000Z",
      "days_left": 0,
      "dispute": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "status": "open"
      },
      "visits": 0,
      "verified_visit_at": "2026-10-06T05:30:00.000Z",
      "can_schedule_visit": true,
      "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

Register a client (lock window; a conflict goes to the builder as a dispute)

The number is normalised (NRI numbers keep their country code). Registering the same client again returns the live registration. Who else holds a conflicting client is never revealed.

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

Parameters

Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

namerequired: string
phonerequired: string
email: string (email) or null
project_id: Id or null
Opaque record id.
note: string or null
consentrequired: true
The partner confirms the client agreed to be introduced.
otp_code: string or null
The code sent to the client; required when the company asks for the client’s consent.

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.client_namerequired: string or null
data.phonerequired: string
data.emailrequired: string or null
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: 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.disputerequired: object or null
data.dispute.idrequired: Id
Opaque record id.
data.dispute.statusrequired: "open" | "decided" | "withdrawn"
data.visitsrequired: integer
data.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.can_schedule_visitrequired: boolean
data.created_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.duplicaterequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/registrations' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"name":"string","phone":"string","email":"name@example.com","project_id":"cmusrceel0000q7kaafxqi1om","note":"string","consent":true,"otp_code":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "client_name": "string",
    "phone": "string",
    "email": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "state": "pending",
    "note": "string",
    "lock_days": 0,
    "expires_at": "2026-10-06T05:30:00.000Z",
    "days_left": 0,
    "dispute": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "open"
    },
    "visits": 0,
    "verified_visit_at": "2026-10-06T05:30:00.000Z",
    "can_schedule_visit": true,
    "created_at": "2026-10-06T05:30:00.000Z",
    "duplicate": true
  },
  "meta": {}
}

Errors

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

POST/v1/cp/registrations/otp

Send the client a one-time code that confirms their consent to the registration

The code goes to the client’s phone; the partner enters it with the registration. Counts against the daily registration limit and the per-phone code limits.

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

Request body

phonerequired: string

Response · 200

datarequired: object
data.phonerequired: string
data.expires_in_secrequired: integer
data.resend_in_secrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "phone": "string",
    "expires_in_sec": 0,
    "resend_in_sec": 0
  },
  "meta": {}
}

Errors

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

Add a note to the evidence of the partner’s disputed registration

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

noterequired: string

Response · 200

datarequired: object
data.idrequired: Id
Opaque record id.
data.client_namerequired: string or null
data.phonerequired: string
data.emailrequired: string or null
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: 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.disputerequired: object or null
data.dispute.idrequired: Id
Opaque record id.
data.dispute.statusrequired: "open" | "decided" | "withdrawn"
data.visitsrequired: integer
data.verified_visit_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.can_schedule_visitrequired: boolean
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}/evidence' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"note":"string"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "client_name": "string",
    "phone": "string",
    "email": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "state": "pending",
    "note": "string",
    "lock_days": 0,
    "expires_at": "2026-10-06T05:30:00.000Z",
    "days_left": 0,
    "dispute": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "status": "open"
    },
    "visits": 0,
    "verified_visit_at": "2026-10-06T05:30:00.000Z",
    "can_schedule_visit": true,
    "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/registrations/{id}/visits

Book a site visit for a registered client (active registrations only)

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
project_id: Id or null
Opaque record id.

Response · 201

datarequired: object
data.idrequired: Id
Opaque record id.
data.registration_idrequired: Id or null
Opaque record id.
data.client_namerequired: string or null
data.projectrequired: object or null
data.project.idrequired: Id
Opaque record id.
data.project.namerequired: string
data.scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.statusrequired: string
data.otp_verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.check_in_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.proof_availablerequired: boolean
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/registrations/{id}/visits' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"scheduled_at":"2026-10-06T05:30:00.000Z","project_id":"cmusrceel0000q7kaafxqi1om"}'

Response example

{
  "data": {
    "id": "cmusrceel0000q7kaafxqi1om",
    "registration_id": "cmusrceel0000q7kaafxqi1om",
    "client_name": "string",
    "project": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "name": "string"
    },
    "scheduled_at": "2026-10-06T05:30:00.000Z",
    "status": "string",
    "otp_verified_at": "2026-10-06T05:30:00.000Z",
    "check_in_at": "2026-10-06T05:30:00.000Z",
    "completed_at": "2026-10-06T05:30:00.000Z",
    "proof_available": true
  },
  "meta": {}
}

Errors

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

GET/v1/cp/visits

Site visits of the partner’s clients, upcoming first

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

Response · 200

datarequired: array of object
data[].idrequired: Id
Opaque record id.
data[].registration_idrequired: Id or null
Opaque record id.
data[].client_namerequired: string or null
data[].projectrequired: object or null
data[].project.idrequired: Id
Opaque record id.
data[].project.namerequired: string
data[].scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].statusrequired: string
data[].otp_verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].check_in_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data[].proof_availablerequired: boolean
metarequired: object

Request

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

Response example

{
  "data": [
    {
      "id": "cmusrceel0000q7kaafxqi1om",
      "registration_id": "cmusrceel0000q7kaafxqi1om",
      "client_name": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "status": "string",
      "otp_verified_at": "2026-10-06T05:30:00.000Z",
      "check_in_at": "2026-10-06T05:30:00.000Z",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "proof_available": true
    }
  ],
  "meta": {}
}

Errors

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

POST/v1/cp/visits/{id}/check-in

GPS check-in at the site (optional photo and code); offline-safe with client_key

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

Parameters

idpathrequired: Id
Opaque record id.
Idempotency-Keyheader: string
Unique key (a UUID) per logical request. A retry with the same key and body replays the first response for 24 hours (marked Idempotent-Replayed: true); the same key with another body is a 409.

Request body

latrequired: number
lngrequired: number
accuracy_m: number or null
mock_location: boolean or null
The phone reported a mock (fake) location.
photo_key: string or null
Key from POST …/photos after the upload.
client_key: string or null
Offline queue key: sending the same key again returns the stored capture.
captured_at: DateTime or null
Phone time of the capture (kept when plausible).
otp: string or null

Response · 200

datarequired: object
data.visitrequired: object
data.visit.idrequired: Id
Opaque record id.
data.visit.registration_idrequired: Id or null
Opaque record id.
data.visit.client_namerequired: string or null
data.visit.projectrequired: object or null
data.visit.scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.statusrequired: string
data.visit.otp_verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.check_in_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.proof_availablerequired: boolean
data.warningsrequired: array of "far_from_site" | "mock_location" | "low_accuracy" | "no_site_location" | "early" | "late"
data.distance_mrequired: number or null
data.replayedrequired: boolean
data.otprequired: VisitOtpVerdict or null
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/visits/{id}/check-in' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Idempotency-Key: 6c0f1d3e-…' \
  -H 'Content-Type: application/json' \
  -d '{"lat":0,"lng":0,"accuracy_m":0,"mock_location":true,"photo_key":"string","client_key":"string","captured_at":"2026-10-06T05:30:00.000Z","otp":"string"}'

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "registration_id": "cmusrceel0000q7kaafxqi1om",
      "client_name": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "status": "string",
      "otp_verified_at": "2026-10-06T05:30:00.000Z",
      "check_in_at": "2026-10-06T05:30:00.000Z",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "proof_available": true
    },
    "warnings": [
      "far_from_site"
    ],
    "distance_m": 0,
    "replayed": true,
    "otp": {
      "verified": true,
      "reason": "invalid",
      "attempts_left": 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/cp/visits/{id}/otp

Send the visit code to the partner’s client

Through the send pipeline (30-second resend gap, 5 codes per visit). When no channel reaches the client the request fails — the code is never shown to the partner.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

No fields.

Response · 200

datarequired: object
data.visitrequired: object
data.visit.idrequired: Id
Opaque record id.
data.visit.registration_idrequired: Id or null
Opaque record id.
data.visit.client_namerequired: string or null
data.visit.projectrequired: object or null
data.visit.scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.statusrequired: string
data.visit.otp_verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.check_in_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.proof_availablerequired: boolean
data.channelrequired: string
data.expires_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.resend_in_secrequired: integer
metarequired: object

Request

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

Response example

{
  "data": {
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "registration_id": "cmusrceel0000q7kaafxqi1om",
      "client_name": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "status": "string",
      "otp_verified_at": "2026-10-06T05:30:00.000Z",
      "check_in_at": "2026-10-06T05:30:00.000Z",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "proof_available": true
    },
    "channel": "string",
    "expires_at": "2026-10-06T05:30:00.000Z",
    "resend_in_sec": 0
  },
  "meta": {}
}

Errors

401 No valid session or API key (missing, expired or revoked).
403 The caller lacks the permission, API-key scope or support grant this operation needs.
404 Not found — records of another company are reported the same way.
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/visits/{id}/otp/verify

Check the code the client read out at the site

A wrong code answers `verified: false` with the attempts left; the third locks the code.

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

coderequired: string

Response · 200

datarequired: object
data.resultrequired: VisitOtpVerdict
data.visitrequired: object
data.visit.idrequired: Id
Opaque record id.
data.visit.registration_idrequired: Id or null
Opaque record id.
data.visit.client_namerequired: string or null
data.visit.projectrequired: object or null
data.visit.scheduled_atrequired: DateTime
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.statusrequired: string
data.visit.otp_verified_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.check_in_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.completed_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.visit.proof_availablerequired: boolean
metarequired: object

Request

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

Response example

{
  "data": {
    "result": {
      "verified": true,
      "reason": "invalid",
      "attempts_left": 0
    },
    "visit": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "registration_id": "cmusrceel0000q7kaafxqi1om",
      "client_name": "string",
      "project": {
        "id": "cmusrceel0000q7kaafxqi1om",
        "name": "string"
      },
      "scheduled_at": "2026-10-06T05:30:00.000Z",
      "status": "string",
      "otp_verified_at": "2026-10-06T05:30:00.000Z",
      "check_in_at": "2026-10-06T05:30:00.000Z",
      "completed_at": "2026-10-06T05:30:00.000Z",
      "proof_available": true
    }
  },
  "meta": {}
}

Errors

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

POST/v1/cp/visits/{id}/photos

Upload URL for the partner’s check-in photo

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

Parameters

idpathrequired: Id
Opaque record id.

Request body

filenamerequired: string
content_typerequired: string
sizerequired: integer

Response · 200

datarequired: VisitPhotoUpload
metarequired: object

Request

curl -X POST 'https://api.propzolo.com/v1/cp/visits/{id}/photos' \
  -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.

GET/v1/cp/visits/{id}/proof

The visit proof pack (PDF): OTP verification, check-in time and place, photo, timestamps

For the partner who brought the client, or a member who sees partners. Audited.

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

Parameters

idpathrequired: Id
Opaque record id.
downloadquery: string

Response · 200

Returned as is.

Request

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

Response example

"string"

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/cp/me

Fill in or correct the partner’s own KYC details

Changing PAN, GSTIN, bank or RERA details of an approved partner sends it back for review.

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

Request body

firm_name: string
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.linkedrequired: boolean
false: this member is not a partner (an owner previewing the portal).
data.companyrequired: object
data.company.namerequired: string
data.partnerrequired: object or null
data.partner.idrequired: Id
Opaque record id.
data.partner.firm_namerequired: string
data.partner.typerequired: string
data.partner.contact_namerequired: string or null
data.partner.phonerequired: string or null
data.partner.emailrequired: string or null
data.partner.statusrequired: "pending" | "approved" | "rejected" | "suspended"
data.partner.status_reasonrequired: string or null
data.partner.rera_agent_numberrequired: string or null
data.partner.rera_expires_onrequired: LocalDate or null
Calendar date YYYY-MM-DD in the company time zone.
data.partner.rera_staterequired: string or null
data.partner.rera_statusrequired: "missing" | "valid" | "expiring" | "expired"
data.partner.kycrequired: object
data.partner.kyc_submitted_atrequired: DateTime or null
Instant in ISO 8601, e.g. 2026-10-03T04:30:00.000Z.
data.checklistrequired: object or null
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.
data.agreement.can_signrequired: boolean
data.countsrequired: object
data.counts.activerequired: integer
data.counts.expiringrequired: integer
data.counts.disputedrequired: integer
data.counts.upcoming_visitsrequired: integer
data.lock_daysrequired: integer
data.visit_extension_daysrequired: integer
data.registration_client_otprequired: boolean
Registering a client needs the code sent to them.
metarequired: object

Request

curl -X PATCH 'https://api.propzolo.com/v1/cp/me' \
  -H 'Authorization: Bearer pz_live_…' \
  -H 'Content-Type: application/json' \
  -d '{"firm_name":"string","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": {
    "linked": true,
    "company": {
      "name": "string"
    },
    "partner": {
      "id": "cmusrceel0000q7kaafxqi1om",
      "firm_name": "string",
      "type": "string",
      "contact_name": "string",
      "phone": "string",
      "email": "string",
      "status": "pending",
      "status_reason": "string",
      "rera_agent_number": "string",
      "rera_expires_on": "2026-10-06",
      "rera_state": "string",
      "rera_status": "missing",
      "kyc": {
        "pan": "string",
        "gstin": "string",
        "bank": "string"
      },
      "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",
      "can_sign": true
    },
    "counts": {
      "active": 0,
      "expiring": 0,
      "disputed": 0,
      "upcoming_visits": 0
    },
    "lock_days": 0,
    "visit_extension_days": 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.