What limits the features a partner can reach
Legal regulations, customer privacy and security controls decide which endpoints, events and fields each partner type receives. This page states those limits plainly so nobody designs an integration around data they will not get.
The principle
Each partner receives the minimum data needed to do its job, for the customers it is actually working with, for as long as the work lasts. The platform enforces this in the database (row-level security keyed to the company), in the API (key kinds with fixed scopes), and in the payloads (installer-safe projections that omit fields rather than mask them). A partner cannot request a wider view through a different endpoint; the same rule applies everywhere.
Regulations that shape access
| Rule | What it constrains | How it shows up in the API |
|---|---|---|
| TCPA and CAN-SPAM (US telemarketing and email consent) | Who may text, call or email a homeowner and when | Inbound leads carry smsConsent; messaging is done by the platform on the company's behalf, never by exporting phone lists. Partners do not receive customer email addresses by default. |
| State consumer-protection and contractor licensing law | Who may quote, contract and perform regulated work | Installer companies see scope and equipment, not prices or contract terms. Licence and insurance details are collected at intake and gate job assignment. |
| Payment card and banking rules (PCI DSS, NACHA for ACH) | Handling of card numbers and bank accounts | Card and bank data never enter the platform; the payment provider holds them. No API exposes payment instruments, only settlement events (deposit.paid and journal events) to accounting-class partners. |
| Lending and incentive program rules (TILA, ECOA, utility and federal rebate terms) | Credit decisions and rebate eligibility | Financing and incentive partners receive the amounts and status they administer, through their own application flow. The production design uses provider-hosted applications, with approved customer and proposal fields exchanged under the partner contract. See the financing data boundary. |
| State privacy laws (California CPRA, Utah UCPA, Colorado CPA and similar) | Purpose limitation, deletion, sale and sharing of personal data | Personal data is shared only with processors under a data processing agreement, for the stated purpose. Deletion requests propagate: partners must honour a customer.erasure_requested notice through the agreed privacy contact channel within 30 days. |
| Security commitments (SOC 2 control set the platform is built against) | Access control, change management, audit, vendor management | Key issuance is owner-only and audit-logged; webhooks go only to public HTTPS hosts; partners are vendors in the platform's register with a named security contact. |
Data boundary by partner type
| Field group | Lead source | Booking vendor | Installer company | Distributor | Financing design | Accounting | Licensee |
|---|---|---|---|---|---|---|---|
| Customer name | sends only | yes | assigned jobs | no | approved customer fields | no | own customers |
| Service address | sends only | yes | assigned jobs | no | approved customer fields | no | own |
| Phone | sends only | booked visit | assigned jobs | no | approved customer fields | no | own |
| sends only | no | no by default | no | approved customer fields | no | own | |
| Scope, equipment, schedule | no | schedule only | yes | their SKUs only | approved proposal and installation scope | no | own |
| Quote price, options, margin | never | never | never | never | proposal and financing amounts; no margin | journal level | own |
| Cost lines, supplier pricing | never | never | never | their own lines | never | journal level | own |
| Payments, deposits, refunds | never | never | never | never | status only | events | own |
| Signatures, contracts | never | never | completion docs only | never | provider document IDs and signing status | never | own |
| Other customers of the company | never | never | never | never | never | never | never |
| Knocking Intelligence rankings, permit history, property data | never | never | never | never | never | never | own territory |
The financing column describes the production integration design. Exact shared fields and receiver contracts are approved at onboarding. Incentive programs have a separate program-specific scope.
"Sends only" means the partner supplies the field and receives back an acknowledgement (created or merged) with an id, never the stored record. "Own" means the licensee's own company data; a licensee never sees another company's data on the same platform.
Features that may be unavailable to a partner
- Feature-flagged modules. Some capabilities (AI-assisted quoting, Knocking Intelligence, installer operations chain, incentive stacking) are enabled per company after an evidence review. Webhook events from a module a company has not enabled do not fire.
- Geography. Property-data and permit-history providers are licensed per state and per use. Fields sourced from them are absent outside the licensed area and are never passed to partners regardless.
- Consent. Marketing-related events (quote viewed, follow-up sent) are withheld for customers who have opted out of communications, so a partner cannot reconstruct contact activity for someone who declined it.
- Financial events go only to accounting-class partners with a signed agreement and a named finance contact.
- Document downloads (scope sheets, permits, manuals, completion packets) are time-limited signed URLs issued per job and per partner; they cannot be shared or listed.
- Bulk export is not available through partner APIs. Companies can export their own data from the console; partners receive records one event at a time.
Partner obligations
- Use data only for the purpose stated at intake, and delete it when the job or lead is closed and any retention period you are legally required to keep has passed.
- Keep API keys and webhook secrets in a secret manager, one key per system, rotated at least annually and immediately on suspected exposure.
- Notify [email protected] with SECURITY in the subject within 24 hours of discovering a breach involving platform data.
- Do not attempt to access records outside your boundary, enumerate ids, or scrape the console. Doing so revokes access and is reported to the company.
- Honour customer erasure notices within 30 days and confirm completion.
- Provide a security contact and a technical contact at intake and keep them current.
The binding versions of these obligations are in the partner agreement and the data processing terms referenced on the API terms page. This page explains; the agreement governs.