Track API

The Track API lets you monitor a document after it has been scheduled for generation and throughout the signing workflow. Use the document_id returned by the Generate API to query the current status. Every request must include a valid X-API-KEY header as described in the Authentication section.

Endpoint

GET /api/track/{document_id}

Replace {document_id} with the identifier from the Generate API response.

Response Parameters

status string

High-level status of the document process.

  • In Progress – Document is under generation.
  • Awaiting Signatures – Document generated and waiting for signers.
  • Finished – Document fully signed or generation completed (if no signatures required).
  • Failed – Document generation failed or a signer rejected the document.
document object

Details of the document.

  • id (string) – Unique document identifier.
  • title (string) – Document title as defined in Generate API.
  • header_template (string) – Key of the header template.
  • footer_template (string) – Key of the footer template.
  • page_template (string) – Key of the page/body template.
  • service (string) – Service type (e.g. Analytical PDF Generation, Transactional PDF Generation, Structured Form Document Generation).
generated_pdf object

Details of the pre-signature draft PDF.

  • status (string) – Pending, In Progress, or Completed.
  • progress (integer) – Percentage of generation completed (0–100).
  • generated_at (datetime) – ISO timestamp when generation was completed.
  • file_url (string) – URL to download the draft PDF.
signing_process object

Details of the document signing workflow.

  • status (string) – Not Started, In Progress, or Completed.
  • started_at (datetime) – When signing started.
  • completed_at (datetime/null) – When signing completed, or null if still pending.
  • signers (array of objects) – Each signer has:
    • name (string) – Signer’s full name.
    • email (string) – Signer’s email address.
    • status (string) – Pending, Signed, Rejected.
    • signed_at (datetime/null) – Timestamp of signing.
final_pdf object

Details of the final signed PDF document.

  • status (string) – Waiting, Completed.
  • file_url (string) – Download URL for the signed PDF.
  • completed_at (datetime/null) – When the final PDF was completed.

Example Request

{
    "status": "Awaiting Signatures",
    "document": {
        "id": "A.YDUMPIMAGQ8JJNE",
        "title": "Employee Join Request",
        "header_template": "HEADER_1",
        "footer_template": "BLANK",
        "page_template": "BOXED_SECTIONS",
        "service": "Structured Form Document Generation"
    },
    "generated_pdf": {
        "status": "Completed",
        "progress": 100,
        "generated_at": "2025-09-03T13:24:49.000000Z",
        "file_url": "https://avocazo.com/api/file/..."
    },
    "signing_process": {
        "status": "In Progress",
        "started_at": "2025-09-03T13:24:49.000000Z",
        "completed_at": null,
        "signers": [
            {
                "name": "Omar Alkattan",
                "email": "omaralkattan@outlook.com",
                "status": "Pending",
                "signed_at": null
            }
        ]
    },
    "final_pdf": {
        "status": "Waiting",
        "file_url": "",
        "completed_at": null
    }
}

Notes

  • The top-level status summarizes the overall state; use nested objects for granular progress.
  • generated_pdf is the pre-signature draft; final_pdf becomes available after all required signatures are complete.
  • When status is Failed, the failure may be due to generation errors or an explicit signer refusal.
  • If no signatures are required, status moves directly from In Progress to Finished, and only generated_pdf is relevant.