OpciloSeal and verify
Verify

Developers

Opcilo Developer API

Automate document upload, sealing, and verification for Business and Enterprise workspaces with workspace-bound API keys.

Contact us about API accessSee Business pricing

What you can automate

  • Upload documents into a workspace with idempotency keys.
  • Seal a document and receive a verification code and public verify URL.
  • Look up a seal by verification code through GET /api/v1/verify/{code}.
  • Optional thin invoicing endpoints when your key has invoice scopes.
  • Register HTTPS webhooks for seal lifecycle events: seal.created, seal.completed, seal.revoked, and seal.paid.

Authentication model

Partner calls to /api/v1 use a workspace API key (opc_dev_… on Development, opc_live_… on Production). JWT session tokens alone cannot call the Developer API v1 surface.

Create and rotate keys in the authenticated Developer console after your workspace has Developer API entitlement (Business, Enterprise, or an entitled custom plan).

Optional client certificates (mTLS fingerprint) are an advanced auth option for entitled workspaces. Registration requires proof of possession; see the client certificates guide for the partner-side how-to.

Webhooks guide

Events, HMAC signatures, HTTPS delivery, and secret rotation.

Client certificates how-to

Local key prep, proof of possession, OpenSSL/PowerShell, and registration.

Try verify with your API keys

Run a live GET /api/v1/verify/{code} call from the authenticated Developer console at /app/developer. Pick an active workspace key — never paste a secret on this public site.

Open Developer console

Simple workflow

  1. Step 1

    Create an API key

    In the Opcilo app Developer page, mint a key with the scopes you need (for example documents:write, documents:read, verify:read).

  2. Step 2

    Upload a document

    POST /api/v1/documents with multipart content and an Idempotency-Key header.

  3. Step 3

    Seal the document

    POST /api/v1/documents/{id}/seal to fingerprint the file and obtain a verification code.

  4. Step 4

    Verify by code

    GET /api/v1/verify/{code} (or open the public verify URL) to confirm document integrity for recipients.

Availability and limits

Developer API access requires Business, Enterprise, or an entitled custom plan.

Requests are rate limited per IP with separate windows for write, read, verify, and auth failures. Prefer retries with backoff and Idempotency-Key on writes. Exact numeric quotas are documented in OpenAPI and the partner guide — this page does not invent quotas.

OpenAPI and Scalar UIs are published on Development (and test) hosts. Pin integrations against the Dev OpenAPI document or an exported snapshot.

Technical documentation

Live OpenAPI (GET /openapi/developer-v1.json) and Scalar are available on Development API hosts. Production partners use keys minted in the Production app Developer console — never reuse Dev keys on Production.

What this API does not include today

  • Embedded verify iframes for third-party sites (not available).
  • Microsoft 365, Adobe, or e-sign product integrations (not available).
  • Person identity verification or cryptographic signature verification APIs (Identity and Signature remain Not checked on public verify).
  • A public verification-event history API for every viewer lookup.
  • White-label removal of the Opcilo mark from verify experiences.