The Lettings Hub Partner API

Testing your integration

Pre-production serves the same API as production, so the calls, bodies and webhooks are the same. Three things behave differently, and each needs a step from you or from us.

Emails do not reach applicants

Pre-production does not deliver email to the addresses you enter. It catches every message instead. We forward the copies for the test addresses you gave us when you asked for access, so you can see the invitations and reminders an applicant would get. To add an address later, email us.

Use addresses you control. Do not enter real tenants' or guarantors' details on pre-production.

Referencing does not finish by itself

Submitting a tenant starts referencing, but nobody works the case on pre-production. When you are ready to test the end of the flow, email us the tenancy reference (ApplicationRef) and the tenant reference. We complete referencing by hand, and you then receive the report webhooks and can fetch the report PDF. Someone does this by hand, so give us some notice.

Some calls are slow

Creating or submitting a tenant can take 30 to 60 seconds on pre-production. Set your HTTP client's timeout to at least 120 seconds. If a call times out, the tenant may still have been created, and sending it again with the same email address can be refused as a duplicate. Email us the tenancy reference and we will check.

Before you ask to go live

Work through this list on pre-production:

  1. Authenticate, keep the Token, and sign in again when a call returns 401 (Getting started).
  2. GET /Branches returns your branch.
  3. Create a tenancy and store its ApplicationRef against your own record (Identifiers).
  4. Add a tenant and store the tenant reference.
  5. Submit the tenant's details, or let the tenant complete the form (IsApplicantFillingTheForm: true).
  6. Receive an updateApplicant webhook and answer it with a 2xx (Webhooks).
  7. Ask us to complete referencing, receive Report Available, and fetch the PDF with your Token.
  8. Show a 400 validation body to whoever entered the data, and treat a 500 as ours to fix (Errors).

When all eight work, email us to go live.

Cleaning up

Test tenancies stay on your test agency. Cancel the tenants you no longer need with POST …/CancelTenancy/{ApplicantRef}.