canonical: https://jentic.com/apis/ezidox.com/ezidox

# EziDox API

Jentic publishes the only available OpenAPI specification for EziDox API, keeping it validated and agent-ready. EziDox is a document-management and e-signature platform, and version 2.0 of its public API is intentionally narrow: a single Applications/Test endpoint that lets integrators verify connectivity and credentials before progressing to the broader product workflows. Authentication is by an X-API-Key header.

## For AI agents

Verify EziDox connectivity and X-API-Key credentials against the v2.0 Applications test endpoint at api.ezidox.com.

## Scope

Does not handle document upload, e-signature, or workflow management - use for v2.0 credential and connectivity verification only.

## Capabilities

- Verify the configured X-API-Key against the v2.0 EziDox API via /api/v2.0/Applications/Test
- Confirm baseline connectivity to api.ezidox.com before deeper integration
- Smoke-test EziDox credentials in CI pipelines before deployment
- Detect credential rotation issues by treating non-2xx responses as a failure signal

## Use cases

### Credential Smoke Test

Use the single /api/v2.0/Applications/Test endpoint to confirm that the configured EziDox X-API-Key is valid and that api.ezidox.com is reachable. Suitable for CI pipelines that gate deployment of an EziDox integration on a green credential check, and for periodic monitors that detect rotated or revoked keys.

Example prompt: Call /api/v2.0/Applications/Test with the X-API-Key header and assert a 2xx status code in the deployment pipeline.

### Pre-Integration Connectivity Check

Before wiring deeper EziDox workflows in a downstream service, run /api/v2.0/Applications/Test to validate that the network path, TLS configuration, and X-API-Key are all in good shape. Use it in onboarding scripts that first-time customers run after pasting their key into a configuration UI.

Example prompt: Call /api/v2.0/Applications/Test from the onboarding script and surface a clear error message to the user when the response is non-2xx.

### Agent-Driven Credential Health Check via Jentic

An AI agent that orchestrates document workflows can use Jentic to run the EziDox connectivity test without embedding the bespoke client. The X-API-Key value lives in your Jentic One instance, so the agent can fire the smoke test on demand without ever holding the raw key in its prompt context.

Example prompt: Through Jentic, search 'verify EziDox credentials', load /api/v2.0/Applications/Test, and execute it as part of the agent's daily health-check routine.

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| GET | /api/v2.0/Applications/Test | Verify connectivity and the X-API-Key |

## Key resources

- **Applications test** — Verify connectivity and the configured X-API-Key

## Why Jentic

- **Setup:** Wiring the EziDox API by hand means registering its X-API-Key scheme, targeting the api.ezidox.com host, and confirming the v2.0 test route yourself. Through Jentic you install once, import the EziDox API from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** EziDox here exposes a single read operation, GET /api/v2.0/Applications/Test, so you limit the agent to the operations it needs: it can verify credentials and connectivity and nothing else. Because you choose the operations, no document, e-signature, or workflow actions are included.
- **Credential handling:** Your EziDox X-API-Key is stored once, encrypted, by your own Jentic One instance and injected at execution time. It never enters the agent's prompt, logs, or context.
- **Discovery method:** Agents search Jentic by intent such as 'verify EziDox credentials', and Jentic returns the /api/v2.0/Applications/Test operation with its input schema so the agent calls the right endpoint without needing the exact path or header name.

## Related APIs

- **EZ File Drop API** — File-collection API - useful upstream of EziDox when documents arrive via a public form drop before document management.
- **ezeep Blue Printing API** — Cloud printing - pair with EziDox when signed documents need to be printed once a workflow completes.

## FAQ

### Why is there no official OpenAPI spec for EziDox API?

EziDox does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call EziDox API via structured tooling. It is validated against the live API and kept up to date. Get started with Jentic One, the self-hosted execution layer.

### What authentication does the EziDox API use?

The spec declares an apiKey scheme that expects the X-API-Key header on the /api/v2.0/Applications/Test request. Store the key in your Jentic One instance so it is supplied to the request at execution time without leaking into the agent prompt.

### Can I attach an e-signature to a document with this OpenAPI spec?

Not directly. The currently published OpenAPI spec covers only the /api/v2.0/Applications/Test connectivity endpoint; the broader EziDox e-signature operations are not yet exposed in this spec, so use it as a credential health check only.

### How do I verify my EziDox credentials through Jentic?

Run pip install jentic, search 'verify EziDox credentials', load /api/v2.0/Applications/Test, and execute it; Jentic injects the X-API-Key header from the vault and returns the result for your CI to assert on.

### What are the rate limits for the EziDox API?

The spec does not declare explicit rate limits, so use the test endpoint sparingly - for example as part of CI runs and scheduled health checks rather than as a tight polling loop.

### Is the EziDox API free?

EziDox is a paid commercial document-management product, so use of the API is governed by your EziDox subscription rather than by the OpenAPI spec; consult the EziDox sales documentation for the current commercial terms.

### Can I limit what my agent is allowed to do with the EziDox API?

Yes. Jentic One runs self-hosted, so your own rules decide which EziDox operations and credentials the agent may use. This published spec exposes a single read operation, GET /api/v2.0/Applications/Test, so you can restrict the agent to verifying credentials and connectivity and nothing more. Because you choose the operations, no document, e-signature, or workflow actions are made available to the agent.