Partner API

HTTP API used by CRM integrations to manage tenancies and referencing, and run KYC checks. Pre-production base URL: https://pre-prod.lettingshub.co.uk/webapi/v2.

Getting access
How to get pre-production credentials, what you receive, and how to go live.
Getting started
Authentication, the Token header, and listing branches.
Tenancy & Referencing Management
Create a tenancy, add tenants, submit for referencing, and fetch reports.
Webhooks
Agent-level topic POSTs, retries, and optional static header. Also see Notifications (deprecated — use Webhooks instead).
Testing your integration
How pre-production differs from live, and the checks to pass before you go live.
Identifiers
Environments, token lifetime, and which references to persist.
Dictionaries
Integer codes for titles, reports, living status, income types.
Errors
Status codes and the two error body shapes.
API Reference
OpenAPI operations, schemas, and try-it-out.