Signature contract details

Retrieves the complete details of a signature contract, including all signers and their statuses

get/leases/signatures/contracts/{document_signature_id}

Request

Base URL: https://api.faireplace.com/api
URL: https://api.faireplace.com/api/leases/signatures/contracts/{document_signature_id}
Auth: HTTP bearer

Path parameters

document_signature_idstring uuid required

Signature process ID

Response

Details retrieved successfully

document_signature_idstring uuid required

lease_idstring uuid required

media_idstring uuid required

Reference to the media table

status'READY' | 'SIGNING' | 'COMPLETED' | 'FAILED' | 'ARCHIVED' required

Status of the document signature process

initiator_type'proprietaire' | 'locataire' | 'agent_immobilier' | 'caution' required

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.

initiator_idstring uuid required

Initiator ID

event_idstring required

Unique ID for traceability

created_atstring date-time required

expires_atstring date-time nullable

document_urlstring uri nullable

signed_pdf_urlstring uri nullable

archive_urlstring uri nullable

URL of the archived PDF with electronic timestamping

Example response

{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "lease_id": "550e8400-e29b-41d4-a716-446655440001",
  "media_id": "550e8400-e29b-41d4-a716-446655440002",
  "status": "READY",
  "initiator_type": "proprietaire",
  "initiator_id": "550e8400-e29b-41d4-a716-446655440003",
  "event_id": "signature_550e8400-e29b-41d4-a716-446655440001_1704985200",
  "created_at": "2024-01-15T10:00:00Z",
  "expires_at": "2024-01-20T10:00:00Z",
  "signers": [
    {
      "signer_type": "proprietaire",
      "signer_email": "jean.dupont@example.com",
      "signer_phone": "+33612345678",
      "status": "PENDING",
      "expires_at": "2024-01-20T10:00:00Z",
      "signed_at": "2024-01-16T15:30:00Z",
      "first_name": "Jean",
      "last_name": "Dupont",
      "legal_name": "SARL Dupont Immobilier",
      "title": "M."
    }
  ],
  "document_url": "https://storage.example.com/leases/unsigned-doc.pdf",
  "signed_pdf_url": "https://storage.example.com/leases/signed-doc.pdf",
  "archive_url": "https://storage.example.com/leases/archived-doc.pdf"
}

Changes

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