# Blueink eSignature API — Developer Documentation

> Blueink is an eSignature platform. APIv2 is a RESTful JSON API for creating and sending Bundles (signature requests), managing Document Templates, embedding signing and preparation experiences, and receiving webhooks. This documentation is indexed here for AI agents.

## API Specification

- [OpenAPI 3.0 spec (YAML)](https://developer.blueink.com/openapi.yaml): Complete, self-contained machine-readable API contract.
- [OpenAPI 3.0 spec (JSON)](https://developer.blueink.com/openapi.json): The same contract in JSON.

## Getting Started

- [FAQs](https://developer.blueink.com/docs/faq.md): Find answers to frequently asked questions about the Blueink API, integration, security, and usage.
- [Introduction to Blueink eSignature API](https://developer.blueink.com/docs/introduction.md): Learn about the Blueink eSignature API, core concepts, and how to start integrating electronic signatures into your applications.
- [Getting Started with the Blueink eSignature API](https://developer.blueink.com/docs/quick-start.md): A quick start guide to get you up and running with the Blueink eSignature API

## API Reference

- [Add Tags to a bundle](https://developer.blueink.com/docs/api/add-bundle-tags.md): Add additional tags to a Bundle. No existing tags on the Bundle are removed. The result
- [Blueink API v2](https://developer.blueink.com/docs/api.md): # Overview
- [Bundles](https://developer.blueink.com/docs/api/bundles.md): Bundles
- [Cancel a Bundle](https://developer.blueink.com/docs/api/cancel-bundle.md): Cancel a Bundle
- [Check Rate Limit Status](https://developer.blueink.com/docs/api/check-rate-limit.md): Check the current rate limit status for your API key. This endpoint provides information
- [Create a Bundle from an Envelope Template](https://developer.blueink.com/docs/api/create-bundle-from-envelope-template.md): Create a Bundle from an Envelope Template
- [Create an embedded Bundle preparation session](https://developer.blueink.com/docs/api/create-bundle-preparation-session.md): Create a short-lived, single-use URL that hosts the Blueink Bundle
- [Create a Bundle](https://developer.blueink.com/docs/api/create-bundle.md): Create a new Bundle (signing workflow) consisting of one or more Documents and one
- [Create an Embedded Signing URL](https://developer.blueink.com/docs/api/create-packet-embed-url.md): Create a URL which can be used for embedded signing
- [Create a Person](https://developer.blueink.com/docs/api/create-person.md): Create a Person
- [Create an embedded Document Template preparation session](https://developer.blueink.com/docs/api/create-template-preparation-session.md): Create a short-lived, single-use URL that hosts the Blueink Document
- [Create a WebhookExtraHeader](https://developer.blueink.com/docs/api/create-webhook-extra-header.md): Create a WebhookExtraHeader
- [Create a Webhook](https://developer.blueink.com/docs/api/create-webhook.md): Create a Webhook
- [Delete a Person](https://developer.blueink.com/docs/api/delete-person.md): Delete a Person
- [Delete a WebhookExtraHeader](https://developer.blueink.com/docs/api/delete-webhook-extra-header.md): Delete a WebhookExtraHeader
- [Delete a Webhook](https://developer.blueink.com/docs/api/delete-webhook.md): Delete a Webhook
- [Envelope Templates](https://developer.blueink.com/docs/api/envelope-templates.md): Envelope Templates
- [Generate Interim Bundle Files](https://developer.blueink.com/docs/api/generate-interim-files.md): Start asynchronous generation of documents in their current state. The interim documents will include
- [Retrieve Bundle Data](https://developer.blueink.com/docs/api/get-bundle-data.md): Get data entered into fields for a completed Bundle
- [Retrieve Bundle Files](https://developer.blueink.com/docs/api/get-bundle-files.md): Get downloadable files for a completed Bundle
- [Retrieve Packet Certificate of Evidence](https://developer.blueink.com/docs/api/get-packet-coe.md): Get a link and checksum of the Certificate of Evidence for this Packet
- [Retrieve a Person](https://developer.blueink.com/docs/api/get-person.md): Retrieve a Person
- [Retrieve a WebhookDelivery](https://developer.blueink.com/docs/api/get-webhook-delivery.md): Retrieve a WebhookDelivery
- [Retrieve a WebhookEvent](https://developer.blueink.com/docs/api/get-webhook-event.md): Retrieve a WebhookEvent
- [Retrieve a WebhookExtraHeader](https://developer.blueink.com/docs/api/get-webhook-extra-header.md): Retrieve a WebhookExtraHeader
- [Get Webhook Shared Secret](https://developer.blueink.com/docs/api/get-webhook-secret.md): Get Webhook Shared Secret
- [Retrieve a Webhook](https://developer.blueink.com/docs/api/get-webhook.md): Retrieve a Webhook
- [List Bundle Events](https://developer.blueink.com/docs/api/list-bundle-events.md): Get a list of Events that are associated with the Bundle
- [List Bundles](https://developer.blueink.com/docs/api/list-bundles.md): Returns a paginated list of Bundles in your Account, ordered by created date (from most recent to
- [List Envelope Templates](https://developer.blueink.com/docs/api/list-envelope-templates.md): Retrieve a paginated list of Envelope Templates available to your account.
- [List Persons](https://developer.blueink.com/docs/api/list-persons.md): List Persons
- [List Document Templates](https://developer.blueink.com/docs/api/list-templates.md): List Document Templates
- [List WebhookEvents](https://developer.blueink.com/docs/api/list-webhook-deliveries.md): List WebhookEvents
- [List WebhookEvents](https://developer.blueink.com/docs/api/list-webhook-events.md): List WebhookEvents
- [List WebhookExtraHeaders](https://developer.blueink.com/docs/api/list-webhook-extra-headers.md): List WebhookExtraHeaders
- [List Webhooks](https://developer.blueink.com/docs/api/list-webhooks.md): List Webhooks
- [Packet](https://developer.blueink.com/docs/api/packet.md): Packet
- [Person](https://developer.blueink.com/docs/api/person.md): Person
- [Rate Limiting](https://developer.blueink.com/docs/api/rate-limiting.md): Rate Limiting
- [Regenerate Webhook Shared Secret](https://developer.blueink.com/docs/api/regenerate-webhook-secret.md): Regenerate Webhook Shared Secret
- [Remove Tags from a bundle](https://developer.blueink.com/docs/api/remove-bundle-tags.md): Remove tags from a Bundle. If a tag in the request does not exist on the Bundle, it is ignored.
- [Retrieve a Bundle](https://developer.blueink.com/docs/api/retrieve-bundle.md): Retrieve a Bundle by its slug. Optionally include additional related data such as form field data,
- [Retrieve Envelope Template](https://developer.blueink.com/docs/api/retrieve-envelope-template.md): Retrieve detailed information about a specific Envelope Template by its unique identifier.
- [Retrieve a Packet](https://developer.blueink.com/docs/api/retrieve-packet.md): Retrieve details for a specific Packet (signer). This endpoint provides information about
- [Retrieve a Document Template](https://developer.blueink.com/docs/api/retrieve-template.md): Retrieve a Document Template
- [Send a Bundle](https://developer.blueink.com/docs/api/send-bundle.md): Attempt to send a draft or pending Bundle. If successful, the Bundle's status will change to `se` (Sent).
- [Send a Reminder](https://developer.blueink.com/docs/api/send-packet-reminder.md): Send a Reminder email or SMS to a Signer. A reminder can only be sent once every hour. The reminder will be sent via the delivery method (email or SMS) and to the email address (or phone number) previously designated for this Packet.
- [Templates](https://developer.blueink.com/docs/api/templates.md): Templates
- [Partially Update a Bundle](https://developer.blueink.com/docs/api/update-bundle-partial.md): Partially update selected Bundle fields.
- [Update a Packet](https://developer.blueink.com/docs/api/update-packet.md): Update a Packet (aka signer) with a new email, phone number, name or authentication options
- [Partially update a Person](https://developer.blueink.com/docs/api/update-person-partial.md): Partially update the Person with new data.
- [Update a Person](https://developer.blueink.com/docs/api/update-person.md): Update the Person with new data. NOTE that any contact channels that are omitted from this request will be DELETED. If you don't want to replace all data on the Person, you probably want to use PATCH instead.
- [Update a Document Template](https://developer.blueink.com/docs/api/update-template.md): Update writable fields on a Document Template. Currently only `metadata`
- [Partially update a WebhookExtraHeader](https://developer.blueink.com/docs/api/update-webhook-extra-header-partial.md): Partially update the WebhookExtraHeader with new data.
- [Update a WebhookExtraHeader](https://developer.blueink.com/docs/api/update-webhook-extra-header.md): Update the WebhookExtraHeader with new data
- [Update a Webhook](https://developer.blueink.com/docs/api/update-webhook.md): Update the Webhook with new data. NOTE that any subscriptions that are omitted from this request will be DELETED. If you don't want to replace all data on the Webhook, you probably want to use PATCH instead.
- [Partially update a Webhook](https://developer.blueink.com/docs/api/update-webhookartial.md): Partially update the Webhook with new data.
- [Validate a Bundle](https://developer.blueink.com/docs/api/validate-bundle.md): Check if a given draft or pending Bundle is ready to be sent.
- [Verification](https://developer.blueink.com/docs/api/verification.md): Verification
- [Verify a signed document](https://developer.blueink.com/docs/api/verify-document.md): Public, unauthenticated endpoint for verifying that a PDF was signed
- [WebhookEvent](https://developer.blueink.com/docs/api/webhook-event.md): WebhookEvent
- [WebhookExtraHeader](https://developer.blueink.com/docs/api/webhook-extra-header.md): WebhookExtraHeader
- [WebhookSecret](https://developer.blueink.com/docs/api/webhook-secret.md): WebhookSecret
- [Webhook](https://developer.blueink.com/docs/api/webhook.md): Webhook
- [Blueink API Authentication](https://developer.blueink.com/docs/esignature-api/authentication.md): Securely authenticate your API requests using Private API Keys. Learn about authentication headers and security best practices.
- [Changelog](https://developer.blueink.com/docs/esignature-api/changelog.md)
- [Core Concepts](https://developer.blueink.com/docs/esignature-api/concepts.md): Understand the fundamental building blocks of the Blueink API, including Bundles, Packets, Persons, and Templates.
- [Error Handling](https://developer.blueink.com/docs/esignature-api/error-handling.md): Detailed explanation of the Blueink API error response format and common error codes.
- [Overview](https://developer.blueink.com/docs/esignature-api.md): An overview of concepts and usage of the Blueink API, including Authentication, Pagination, etc.
- [Pagination in the Blueink eSignature API](https://developer.blueink.com/docs/esignature-api/pagination.md): How to paginate through results in the Blueink eSignature API
- [RESTful API Principles](https://developer.blueink.com/docs/esignature-api/restful-api.md): Learn about the architectural principles of the Blueink API, including standard HTTP verbs and status codes.
- [Webhooks and Real-Time Notifications](https://developer.blueink.com/docs/esignature-api/webhook.md): Learn how to use webhooks to receive real-time notifications about envelope status changes, signer actions, and more.

## Client SDKs

- [.NET SDK](https://developer.blueink.com/docs/libraries/dotnet.md): Official Blueink client library for .NET applications.
- [Embedded Signing JS](https://developer.blueink.com/docs/libraries/embedded-js.md): Official JavaScript library for embedding the Blueink signing experience into your web applications.
- [SDK Examples and Demo Sites](https://developer.blueink.com/docs/libraries/examples.md): Explore practical examples and demo sites for Blueink SDKs
- [Javascript SDK for the Blueink eSignature API](https://developer.blueink.com/docs/libraries/javascript.md): Explore Blueink's powerful Javascript SDK to build eSignature integrations powered by Blueink.
- [Blueink Client SDKs and Libraries](https://developer.blueink.com/docs/libraries.md): Official Blueink client libraries for Python, JavaScript, PHP, and .NET to simplify your eSignature integration.
- [PHP SDK for the Blueink eSignature API](https://developer.blueink.com/docs/libraries/php.md): Explore Blueink's powerful PHP SDK to build eSignature integrations powered by Blueink.
- [Postman Collection](https://developer.blueink.com/docs/libraries/postman_collection.md): Get started with the Blueink eSignature API using Postman
- [Python SDK for the Blueink eSignature API](https://developer.blueink.com/docs/libraries/python.md): Explore Blueink's powerful Python SDK to build eSignature integrations powered by Blueink.
- [SDK Feature Parity](https://developer.blueink.com/docs/libraries/sdk-parity.md): Compare features across different Blueink client SDKs.

## Guides

- [Auto Field Placement](https://developer.blueink.com/docs/guides/auto-placement.md): Place fields automatically based on strings in PDF
- [Use the Blueink MCP Server](https://developer.blueink.com/docs/guides/blueink-mcp-server.md): Connect the Blueink MCP server to popular AI clients like Claude Code, Cursor, Windsurf, and VS Code
- [Creating Checkbox Groups](https://developer.blueink.com/docs/guides/checkbox-groups.md): Learn how to group multiple checkboxes together and apply validation rules like minimum and maximum selection.
- [Implement Embedded Signing](https://developer.blueink.com/docs/guides/embedded-signing.md): Complete guide for creating envelopes with embedded signing and generating iframe URLs using Blueink API v2
- [Generate PDFs from HTML](https://developer.blueink.com/docs/guides/html-to-pdf.md): Convert HTML to a PDF and send it for electronic signature in one Blueink API call. Auto-detect signature, initial, date, and form fields from your HTML.
- [Overview](https://developer.blueink.com/docs/guides.md): Step-by-step guides for common Blueink eSignature API integration scenarios
- [Send an Envelope with Templates](https://developer.blueink.com/docs/guides/send-envelope-with-templates.md): Complete guide for creating envelopes using document templates and envelope templates with BlueInk API v2
- [Send an Envelope with an Uploaded PDF File](https://developer.blueink.com/docs/guides/send-envelope-with-uploaded-pdf.md): Complete guide for uploading a PDF file and sending it as an envelope using BlueInk API v2
- [Zapier Integration](https://developer.blueink.com/docs/guides/zapier-integration.md): Learn how to connect Blueink with over 5,000 apps using Zapier to automate your eSignature workflows.

## Optional

- [Full documentation (single file)](https://developer.blueink.com/llms-full.txt): Every page concatenated as Markdown.