canonical: https://jentic.com/apis/eversign.com/eversign-xodosign

# Eversign Xodo Sign API

Jentic publishes the only available OpenAPI specification for Xodo Sign API, keeping it validated and agent-ready. This Xodo Sign variant covers e-signature workflows including raw and final document downloads, file uploads, signer reminders, and template-driven bulk signing via CSV jobs. The 11-endpoint surface is purpose-built for high-volume signing pipelines that combine template-based dispatch with file ingestion and downloadable artefacts.

## For AI agents

Run high-volume Xodo Sign signing pipelines with template bulk-CSV jobs, file uploads, and raw or final document downloads.

## Scope

Does not handle proposal authoring, pricing tables, or payment collection - use for sending, tracking, and downloading e-signature documents only.

## Capabilities

- Create signature documents and dispatch them to signers via POST /document
- Upload supporting files for inclusion in a signature document via POST /file
- Download a raw or final signed document for archive or further processing
- Trigger reminder emails to outstanding signers with POST /send_reminder
- Generate a blank CSV for a template's bulk-signing job to populate signer lists
- Submit a template bulk-signing job to send the same template to many signers in one call

## Use cases

### Template Bulk Signing via CSV

HR and procurement teams send the same NDA, vendor agreement, or onboarding form to dozens or hundreds of recipients at once. The Xodo Sign template bulk-CSV job endpoint accepts a recipient CSV and dispatches a personalised signature request per row, removing manual one-by-one sending and reducing per-recipient effort to roughly one second.

Example prompt: GET `/template/{template_hash}/bulk/csv/blank` to fetch the CSV schema, fill it with 50 vendor email rows, then POST `/template/{template_hash}/bulk/job` to dispatch

### File-Attached Signature Workflow

Some contracts ship with a PDF attachment that must be embedded into the signing experience (statements of work, exhibits, schedules). The /file upload endpoint registers the PDF with Xodo Sign and returns a file ID that can be referenced when creating the document, so an agent can stitch attachments into the signing flow programmatically.

Example prompt: POST /file with the SOW PDF, capture the file_id, then POST /document referencing that file_id alongside the master MSA template

### Signed Document Archive Pipeline

Compliance pipelines mirror every signed contract into an immutable store. The Xodo Sign download_final_document endpoint returns the fully executed PDF, while download_raw_document returns the unsigned source for audit purposes. An agent can fetch both on completion and ship them to S3 or a DMS in seconds.

Example prompt: On completion, GET /download_final_document with the document_hash and upload the PDF binary to s3://contracts-archive/{date}/

### AI Agent Bulk Send via Jentic

An AI agent embedded in an HR ops workflow uses Jentic to discover and run the Xodo Sign template bulk-job endpoint without ever reading vendor docs. The agent uploads a vendor list, dispatches the bulk job, and reports back per-recipient status to the operator.

Example prompt: Use Jentic search 'bulk send a template for signature' to discover Xodo Sign POST `/template/{template_hash}/bulk/job`, load schema, and execute with a 50-row vendor CSV

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | `/document` | Create a signature document |
| POST | `/file` | Upload a file for signing |
| GET | `/download_raw_document` | Download the unsigned document |
| GET | `/download_final_document` | Download the fully signed PDF |
| POST | `/send_reminder` | Send reminders to signers |
| GET | `/template/{template_hash}/bulk/csv/blank` | Get blank bulk-signing CSV |
| POST | `/template/{template_hash}/bulk/job` | Dispatch a bulk-signing job |
| GET | `/business` | List businesses |

## Key resources

- **document** — Create signature documents
- **file** — Upload PDFs to attach to documents
- **template** — Reusable signing templates with bulk-CSV job support
- **send_reminder** — Trigger reminders to outstanding signers
- **business** — List businesses on the account

## Why Jentic

- **Setup:** Wiring the Xodo Sign API by hand means passing your API key as the access_key query parameter, pointing at the api.eversign.com host, and coding the document, file-upload, and bulk-template calls yourself. Through Jentic you install once, import the Xodo Sign API from the API Directory, store the key once, and your agent calls it.
- **Permission scoping:** Xodo Sign puts the template hash in the URL path for bulk jobs (`/template/{template_hash}/bulk/job`), so a rule can pin your agent to one template for CSV bulk sends. You choose the operations it may call, so document creation and file upload are not included unless you add them to the allowed set.
- **Credential handling:** Your Xodo Sign 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 'bulk send a template for signature' or 'download a completed document', and Jentic returns the matching Xodo Sign operation with its input schema so the agent calls the right endpoint without browsing the reference docs.

## Related APIs

- **Xodo Sign (Eversign) E-Signature API** — Companion 17-endpoint Xodo Sign surface with reassignment, trash, and richer filtering.
- **Dropbox Sign API** — Dropbox Sign (HelloSign) e-signature with mature SDKs and bulk send.
- **PandaDoc API** — PandaDoc adds proposal generation, pricing tables, and payment collection.

## FAQ

### Why is there no official OpenAPI spec for Xodo Sign API?

Xodo Sign does not publish an OpenAPI specification. Jentic generates and maintains this spec so that AI agents and developers can call Xodo Sign 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 Xodo Sign API use?

It uses an apiKey credential (ApiKeyAuth scheme) against api.eversign.com. Through Jentic the key is held in your Jentic One instance and injected at call time so it never appears in agent context.

### How do I bulk send a Xodo Sign template to many signers?

Fetch the blank CSV via GET `/template/{template_hash}/bulk/csv/blank`, populate one row per recipient, then POST `/template/{template_hash}/bulk/job.` Xodo Sign sends a personalised signature request per row.

### What are the rate limits for the Xodo Sign API?

The OpenAPI spec does not declare quantitative limits; Xodo Sign applies plan-based throttling. Monitor 429 responses with Retry-After headers and confirm your plan ceiling with Xodo Sign before running large bulk jobs.

### How do I dispatch a bulk signing job through Jentic?

Run pip install jentic, then await client.search('bulk send a template for signature'), client.load, client.execute. Jentic returns POST `/template/{template_hash}/bulk/job` with the CSV payload schema wired in.

### Can I attach a PDF to a Xodo Sign signature document?

Yes. POST /file uploads the PDF and returns a file_id; reference that id when calling POST /document so the file is included in the signing workflow.

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

Yes. Jentic One runs self-hosted, so your own rules decide which Xodo Sign operations and credentials the agent may use. You choose the allowed set, so you can permit bulk-signing jobs while leaving document creation (POST /document) and file uploads (POST /file) out unless you add them. Because the template hash sits in the bulk-job path (`/template/{template_hash}/bulk/job`), a rule can even pin the agent to one specific template for its CSV bulk sends.