Lessees
Leases
Signatures

Sign a lease as a tenant

Allows the authenticated tenant to sign a lease by validating the OTP received via SMS/email.

Signing process

  1. The user must have received an OTP via SMS or email
  2. The OTP is validated via the DO Global service
  3. The signature is applied to the PDF document
  4. The signature request status is updated

Security validations

  • Verifies that the user is indeed a tenant of the lease
  • Verifies that the person_id derived from the JWT matches the lease signers
  • Validates the OTP before applying the signature

Required permissions

  • lessee:leases:sign
post/lessee/leases/{id}/signature/sign

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/lessee/leases/{id}/signature/sign
  • Auth: HTTP bearer

Path parameters

idstring uuid required
Example:550e8400-e29b-41d4-a716-446655440000

Lease ID to sign

Request body

document_signature_idstring uuid required

Signature document ID to sign

otpstring required

OTP code received via SMS or email

Example request

{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
  "otp": "123456"
}

Response

Signature initiated successfully (asynchronous processing)

successboolean

Indicates whether the request was accepted

messagestring

Confirmation message

document_signature_idstring uuid

Signature document ID

signed_media_idstring uuid nullable

Signed PDF media ID (available after processing)

signed_pdf_urlstring nullable

Signed PDF URL (available after processing)

Example response

{
  "success": true,
  "message": "OTP validation sent to processing queue",
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440001",
  "signed_media_id": null,
  "signed_pdf_url": null
}

Changes

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