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

# BoldSign API

BoldSign is an electronic signature platform from Syncfusion that lets businesses send, sign, and manage legally binding documents. The API exposes 84 endpoints covering documents, templates, contacts, brands, teams, sender identities, custom fields, and identity verification. Use it to send documents for signature, embed signing into your own application, build reusable templates, and download signed copies and audit trails. It also supports advanced flows like ID verification, prefill, and embedded designer URLs.

## For AI agents

Send documents for e-signature, manage templates and contacts, embed signing into your app, and download signed PDFs and audit trails through BoldSign.

## Scope

Does not handle contract drafting, payment collection, or document storage outside the signature lifecycle - use for sending and managing e-signature workflows only.

## Capabilities

- Send a document for signature with one or more signers and an optional access code
- Create reusable templates and dispatch documents from them, including merging multiple templates
- Generate embedded URLs so signers can sign without leaving your application
- Download the final signed PDF and the tamper-evident audit trail for compliance
- Run identity verification on signers and retrieve the resulting verification report
- Manage contacts, contact groups, and brands used to personalise signature requests
- Send reminders, extend expiry, change recipients, or revoke a document mid-flight

## Use cases

### Embedded Signing in a SaaS Product

Embed the signing experience directly inside your product so signers never leave the app. Create the document with /v1/document/createEmbeddedRequestUrl, render the returned URL in an iframe, and use /v1/document/getEmbeddedSignLink for subsequent signers. Removes the email round-trip and keeps users inside your branded experience.

Example prompt: POST /v1/document/createEmbeddedRequestUrl with one signer and the contract PDF, then return the embed URL to the frontend

### Template-Driven Sales Contracts

Build a sales contract template once with placeholder fields, then dispatch personalised copies for each new deal. /v1/template/create stores the template, /v1/template/send fires it off with merged values, and /v1/template/mergeAndSend combines multiple templates into a single envelope. Sales ops teams use this to remove the copy-paste work of generating contracts.

Example prompt: POST /v1/template/send with templateId tmpl_5521 and the buyer's name, email, and contract value

### ID Verification for High-Trust Documents

Require government ID verification before a signer can complete a sensitive document such as a loan or NDA. Generate the verification URL with /v1/identityVerification/createEmbeddedVerificationUrl, then pull the report via /v1/identityVerification/report once the signer has completed it. Useful for fintech, legal, and HR onboarding flows.

Example prompt: POST /v1/identityVerification/report for documentId doc_8821 and signer email signer@example.com

### Compliance Archive and Audit Trail

Pull the signed PDF and audit log for every completed document and archive both into your compliance store. /v1/document/download returns the signed file and /v1/document/downloadAuditLog returns the tamper-evident trail. Required for regulated industries that need a defensible record of who signed what and when.

Example prompt: GET /v1/document/download and /v1/document/downloadAuditLog for documentId doc_8821 and store in s3://compliance/contracts/

### AI Agent Document Workflow

An AI agent uses Jentic to discover BoldSign operations from natural-language requests, sends documents for signature, sends reminders, and pulls signed PDFs without ever holding the API key. The credential lives in your Jentic One instance while the agent runs the search-load-execute cycle for each step. Time-to-integration drops from days of API key plumbing to under an hour.

Example prompt: Search Jentic for 'send a document for signature', load the operation, and execute it with the contract file and signer list

## Key endpoints

| Method | Path | Description |
| --- | --- | --- |
| POST | /v1/document/send | Send a document for signature |
| POST | /v1/document/createEmbeddedRequestUrl | Generate an embedded send URL |
| GET | /v1/document/download | Download the signed document |
| GET | /v1/document/downloadAuditLog | Download the audit trail |
| POST | /v1/document/remind | Send reminder to pending signers |
| POST | /v1/template/send | Send a document for signature using a template |
| POST | /v1/identityVerification/createEmbeddedVerificationUrl | Generate an embedded ID verification URL |
| POST | /v1/document/revoke | Revoke a document already in flight |

## Key resources

- **Documents** — Send, list, download, remind, revoke, edit, and delete signature documents
- **Templates** — Create, send, merge, and edit reusable document templates
- **Contacts** — Manage individual signers and contact groups
- **Brands** — Configure branding shown to signers during the signing experience
- **Identity Verification** — Run KYC-style identity checks on signers and retrieve reports
- **Sender Identities** — Manage verified sender identities used to dispatch documents
- **Teams and Users** — Manage teams, user roles, and invitations within the BoldSign account

## Why Jentic

- **Setup:** Wiring BoldSign by hand means choosing between its Authorization bearer and X-API-KEY header schemes and mapping the document signature lifecycle yourself. Through Jentic you install once, import BoldSign from the API Directory, store the API key once, and your agent calls it.
- **Permission scoping:** BoldSign's document actions carry the document identifier in the request body or query, not a fixed URL path segment, so limit the agent to the operations it needs, such as sending a document or downloading a signed copy. You choose that set, so revoking a document is not included unless you add it.
- **Credential handling:** Your BoldSign 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 'send a document for signature' or 'download a signed PDF', and Jentic returns the matching BoldSign operation with its input schema so the agent calls the right endpoint without browsing the BoldSign reference.

## Related APIs

- **Boast API** — After a contract signs in BoldSign, request a customer testimonial via Boast.
- **Bokio API** — Issue a Bokio invoice once a BoldSign contract is countersigned.
- **Bonusly API** — An unrelated workflow API focused on internal recognition rather than signature.

## FAQ

### What authentication does the BoldSign API use?

BoldSign supports two API key schemes sent via header: an X-API-KEY header with the raw API key, or an Authorization header with the value 'Bearer <token>'. Through Jentic the key is stored encrypted in the vault and the agent never sees the raw value.

### Can I embed signing into my application with the BoldSign API?

Yes. Use POST /v1/document/createEmbeddedRequestUrl to get a send URL for embedding the request flow, and GET /v1/document/getEmbeddedSignLink to retrieve a sign URL for each signer. Render either inside an iframe in your application.

### How do I send a document for signature through Jentic?

Search Jentic for 'send a document for signature', load the POST /v1/document/send operation schema, then execute it with the file, signer list, and any access code. Jentic handles the API key automatically.

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

BoldSign meters usage in API credits rather than fixed per-minute limits. Use GET /v1/plan/apiCreditsCount to read your current credit balance and pace requests accordingly. Different operations consume different credit amounts.

### Can I download the signed PDF and audit log?

Yes. GET /v1/document/download returns the final signed PDF and GET /v1/document/downloadAuditLog returns the tamper-evident audit trail. Both accept the documentId as a query parameter.

### Does the BoldSign API support signer identity verification?

Yes. Use POST /v1/identityVerification/createEmbeddedVerificationUrl to require ID verification before signing, then POST /v1/identityVerification/report to retrieve the verification result for that signer.

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

Yes. Because you self-host Jentic One, your own rules decide which BoldSign operations and credentials the agent may use, and you grant only the ones it needs, such as POST /v1/document/send to send a document or GET /v1/document/download to fetch a signed copy. BoldSign carries the document identifier in the request body or query rather than a fixed URL path, so you scope access at the operation level. If you do not add POST /v1/document/revoke, the agent cannot revoke a document, and your stored API key is injected only at execution time so the agent never sees it.