Status of a specific document

Retrieves the detailed status of a signature process by its ID (global route)

get/leases/signatures/document/{document_signature_id}/status

Request

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

Path parameters

document_signature_idstring uuid required

Signature process ID

Response

Status retrieved successfully

document_signature_idstring uuid required

Signature process ID

event_idstring required

Unique ID for traceability

pdf_urlstring uri required

PDF document URL

media_idstring uuid required

Reference to the media table

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

Status of the document signature process

Example response

{
  "document_signature_id": "550e8400-e29b-41d4-a716-446655440000",
  "event_id": "signature_550e8400-e29b-41d4-a716-446655440001_1704985200",
  "pdf_url": "https://api.faireplace.com/api/media/serve/550e8400-e29b-41d4-a716-446655440002",
  "media_id": "550e8400-e29b-41d4-a716-446655440002",
  "signature_requests": [
    {
      "id": "550e8400-e29b-41d4-a716-446655440000",
      "signer_type": "proprietaire",
      "signer_email": "jean.dupont@example.com",
      "status": "PENDING",
      "expires_at": "2024-01-20T10:00:00Z"
    }
  ],
  "status": "READY"
}

Changes

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