Leases
Lessees
Rent Receipts

Ask a tenant for their consent to email delivery

Emails the tenant a one-click link inviting them to authorise the sending of their rent receipts by email.

Prefer this over setting the flag yourself with PUT /leases/{lease_id}/lessees/{lessee_id}/consent: the consent is then the tenant's own act, which is what ALUR §6 asks for.

The tenant follows the link to GET /public/tenant/consent?token=…, which is public, single-use and time-limited: no login needed.

Queued, not sent inline, hence 202. The response says the request was accepted, not that the tenant consented.

Note {lessee_id} is the person's id.

post/leases/{lease_id}/lessees/{lessee_id}/request-consent

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/lessees/{lessee_id}/request-consent
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required
lessee_idstring uuid required

The tenant (person) id, not the lease-lessee association id.

Response

Consent request accepted for delivery.

requestedboolean

Example response

{
  "requested": true
}

Changes

No recorded changes to this operation across all 1 revision of this API.