Workspace External API
available in WorkspaceUpload documents, read status, list export formats, request exports and integrate monthly processes.
API integration
Connect controlled invoice data to ERP, DMS, accounting and custom finance workflows.
Workspace sign-in requiredAccess and integration paths
Upload documents, read status, list export formats, request exports and integrate monthly processes.
Public flow for upload, extraction, review, validation, artifact generation and gated structured downloads.
Verification links and QR codes generated from Convert expose limited metadata. Structured downloads remain gated.
Deliver document, invoice, export and monthly-process events to your systems.
Manage scopes, rate limits, usage and sandbox/live keys in the Workspace.
Implementation status
POST /api/v1/documents Upload a document into the Workspace workflow available in WorkspaceGET /api/v1/documents/{document_id} Read document status and metadata available in WorkspaceGET /api/v1/invoices/{invoice_id} Read invoice and review status available in WorkspaceGET /api/v1/export-formats List approved export formats available in WorkspacePOST /api/v1/invoices/{invoice_id}/exports Submit an export request to the internal pipeline available in WorkspacePOST /api/convert/jobs Create a public Convert job public flow availablePOST /api/convert/jobs/{job_id}/validate Validate data with the selected target-format validator public flow availablePOST /api/convert/jobs/{job_id}/generate Generate an artifact; download remains gated until unlock public flow availablePOST /api/v1/convert/extract Versioned External API access for Convert on request / plannedPOST /api/v1/verify-links Versioned External API access for Verify/QR on request / plannedAccess and accountability
API keys are created in the Workspace and shown in full only once. Scopes, limits, usage, webhooks and sandbox/live separation are evaluated server-side. Write requests should use an Idempotency-Key.
The authenticated Workspace API covers documents, invoice status, export formats, export packages and monthly processes. The public Convert flow uses separate /api/convert endpoints. Versioned /api/v1 Convert and Verify endpoints are shown as available only after implementation and release.