Introduction
Summit supports renters‑insurance compliance data exchange with leading property management systems in Canada (excluding Quebec) so portfolio and resident records stay synchronized with verified evidence of insurance. This page documents how to connect with Buildium via its Open API and with Yardi via the Yardi Interface Partner Program, along with the core data mappings, event patterns, and implementation steps.
Availability and scope
-
Region: Canada (excluding Quebec).
-
Use cases: tenant evidence‑of‑insurance intake, verification, status write‑back, audit reporting.
-
Data sources of record: your PMS (properties/units/leases/tenants), insurer or broker for policy evidence, Summit for compliance status and audit trail.
Works with Buildium (Open API)
Buildium exposes a RESTful, JSON Open API with sandbox and production environments, API‑key authentication via x‑buildium-client-id and x‑buildium-client-secret headers, and webhooks for near real‑time event ingestion. Common resources used for compliance workflows include Tenants, Leases, Rental Units, and Rentals (properties). Rate limiting is 10 concurrent requests per second. See the Buildium developer site for details and full endpoint coverage.
Implementation notes (Buildium):
-
Authentication: API keys in headers; HTTPS required; versioned API.
-
Events: subscribe to Lease., Tenant., RentalUnit., and Rental. webhooks to trigger verification jobs and delta syncs.
-
Files: evidence files can be attached to Tenants and/or Leases; file metadata is retrievable via API for audit linking.
-
Write‑back: compliance status can be reflected in a designated custom field (tenant or lease) and/or as a note.
Works with Yardi (Interface Program API)
Yardi provides API access through its Interface Partner Program (Voyager and RentCafe). Access requires an executed Data Exchange Agreement and development via Yardi’s standardized interfaces; approved partners receive sandbox access and technical support. This is not an open/public API; connectivity, payloads, and cadence are finalized per client and interface.
Implementation notes (Yardi):
-
Access model: licensed partner interface; sandbox and pilot client required.
-
Data domains: Property, Unit, Resident/Tenant, and Lease are typical sources for compliance; availability and field names vary by Voyager version and enabled modules.
-
Patterns: batch (scheduled) or event‑proxied (via middleware) syncs; write‑backs commonly use user‑defined fields (UDFs), notes, or document links.
Data field mapping (side‑by‑side)
The mappings below reflect a standard proof‑of‑insurance compliance workflow. Field names may be tailored to each portfolio (e.g., custom fields/UDFs). “Write‑back” indicates how compliance status is stored in the PMS.
| Summit compliance field | Buildium Open API (resource.field) | Yardi interface (Voyager/RentCafe) |
|---|---|---|
| Property ID | Rentals. Properties. PropertyId | Property (PropertyID/Code) |
| Unit ID | Rentals. RentalUnits. RentalUnitId | Unit (UnitID) |
| Lease ID | Leases. LeaseId | Lease (LeaseID) |
| Tenant ID | Tenants. TenantId | Resident/Tenant (TenantID/ResidentID) |
| Tenant name | Tenants. FirstName, Tenants. LastName | Resident/Tenant (Name fields) |
| Tenant email | Tenants. Email | Resident/Tenant (Email) |
| Lease start/end | Leases. StartDate, Leases. EndDate | Lease (Begin/End Date) |
| Policy number | Custom field on Lease or Tenant (e.g., InsurancePolicyNumber) | UDF on Lease/Resident (configured) |
| Liability limit (CAD) | Custom field (e.g., InsuranceLiabilityLimit) | UDF (configured) |
| Policy effective/expiry | Custom fields on Lease/Tenant | UDFs on Lease/Resident |
| Evidence of insurance | Files on Tenant/Lease (File metadata + URL) | Document link/file attachment |
| Compliance status | Custom field (e.g., InsuranceComplianceStatus) | UDF/Note (configured) |
| Last verified at | Custom field (e.g., InsuranceVerifiedAt, UTC) | UDF/Note timestamp |
Notes:
-
Buildium supports uploading/downloading files for Leases and Tenants; store certificate PDFs and reference file IDs in the audit trail.
-
Yardi UDF naming and availability are provisioned per client environment; validation rules can be enforced in middleware.
Event flows and webhook payloads
Event triggers are used to launch verification and reconciliation jobs. Buildium offers native webhooks; Yardi integrations typically use scheduled deltas or partner‑side event proxies.
Sample inbound: Buildium webhook (Lease. Created)
{
"EventName": "Lease. Created",
"EventDateTime": "2025-10-23T15:32:11.231Z",
"AccountId": 123456,
"PropertyId": 23,
"RentalUnitId": 9876,
"LeaseId": 54321
}
Handler actions:
-
Fetch lease and tenant records via Open API using LeaseId.
-
Create a verification task; if policy found and valid, set status to Compliant and write back to the designated field; otherwise flag as Non‑Compliant/Pending.
Sample outbound: compliance status webhook (to your systems)
{
"event": "insurance.compliance_status.updated",
"occurred_at": "2025-10-23T16:05:00Z",
"tenant_id": "T-78421",
"lease_id": "L-54321",
"unit_id": "U-9876",
"property_id": "P-23",
"status": "Compliant",
"policy_number": "ABC-1234567",
"effective_date": "2025-09-01",
"expiration_date": "2026-08-31",
"liability_limit_cad": 1000000,
"evidence_url": "[evidence file url]",
"signature": "base64(HMAC-SHA256)"
}
Best practices:
- Validate webhook signatures; make processing idempotent; implement exponential backoff on 5xx responses; log event IDs to prevent duplicates.
Implementation checklist
-
Buildium
-
Obtain client ID/secret; confirm required permissions for Rentals, RentalUnits, Leases, Tenants.
-
Register webhooks for Lease and Tenant changes; point to a publicly reachable HTTPS endpoint.
-
Map/write‑back fields (custom fields) and test in sandbox before production.
-
Yardi
-
Enroll in the Interface Partner Program; execute Data Exchange Agreement for required interfaces.
-
Provision sandbox and pilot client; finalize UDFs/notes for write‑back.
-
Establish data cadence (batch or proxied events) and document file/document‑link strategy for evidence.
Security and privacy
-
Transport: HTTPS for all inbound/outbound API/webhook traffic; implement HMAC signature verification for webhooks you receive.
-
Data retention: align retention with landlord/portfolio policy and insurer recordkeeping requirements.
-
Data residency: Summit stores personal information exclusively in Canada; review our privacy policy and execute a DPA as needed.
Compliance dashboard (screenshot descriptions)
-
Screenshot A — Portfolio overview: compliance rate by property, outstanding verifications, approaching expirations (30/60/90 days), and webhook health.
-
Screenshot B — Lease detail: tenant profile, linked policy evidence file IDs/URLs, current status with timestamp and verifier, and write‑back audit to PMS.
Download integration guide (PDF)
- Download integration guide (PDF) — request access via Contact Us.
References
-
Buildium Open API (overview, authentication, webhooks, resources): developer.buildium.com/docs
-
Yardi Interface Partner Program (API access via Voyager/RentCafe interfaces): yardi.com/services/interfaces/become-interface-partner/
-
Summit Privacy Policy (data storage in Canada): summitcover.ca/company-privacy-policy