Leases
Signatures

Process a signature event for a lease

Processes a signature request event received from the notifier function in the context of a specific lease

post/leases/{lease_id}/signature/events/process

Request

  • Base URL: https://api.faireplace.com/api
  • URL: https://api.faireplace.com/api/leases/{lease_id}/signature/events/process
  • Auth: HTTP bearer

Path parameters

lease_idstring uuid required

Lease ID

Request body

document_signature_idstring uuid required

Signature process ID

lease_idstring uuid required

Lease ID

document_urlstring uri required

URL of the PDF document to sign

signature_urlstring uri required

URL to access the signature

expires_atstring date-time required

Signature request expiration date

Example request

{
  "base": {
    "event_id": "evt_550e8400-e29b-41d4-a716-446655440000",
    "event_type": "SignatureRequested",
    "timestamp": "2024-01-15T10:00:00Z",
    "correlation_id": "corr_550e8400-e29b-41d4-a716-446655440000",
    "tenant_id": "tenant_123"
  },
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "signer_info": {
    "signer_type": "proprietaire",
    "phone": "+33612345678",
    "email": "jean.dupont@example.com",
    "person_id": "550e8400-e29b-41d4-a716-446655440000",
    "first_name": "Jean",
    "last_name": "Dupont",
    "legal_name": "SARL Dupont Immobilier",
    "title": "M."
  },
  "document_url": "https://storage.example.com/leases/unsigned-doc.pdf",
  "signature_url": "https://api.faireplace.com/api/signature/550e8400-e29b-41d4-a716-446655440000",
  "expires_at": "2024-01-22T10:00:00Z"
}

Response

Event processed successfully

statusstring
event_idstring

The processed event ID

document_signature_idstring uuid
lease_idstring uuid
signer_emailstring email
signer_type'proprietaire' | 'locataire' | 'agent_immobilier' | 'caution'

Who is signing. Always lowercase on the wire.

caution is deliberately distinct from locataire: a surety does not sign the lease, they sign their own surety deed, on which they must themselves write the mention required by article 2297 of the Civil Code: without it their undertaking is void.

Example response

{
  "status": "processed",
  "event_id": "evt_550e8400-e29b-41d4-a716-446655440000",
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "signer_email": "jean.dupont@example.com",
  "signer_type": "proprietaire"
}

Changes

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