## API Overview - [Getting started](/api-overview/getting-started.md): Learn the essential steps to begin using the BoldSign API. - [Developer sandbox account](/api-overview/developer-sandbox-account.md): Use a safe test environment to experiment with API features before going live. - [API in Postman](/api-overview/api-in-postman.md): Quickly test and explore API endpoints using the official Postman collection. - [Open API specification](/api-overview/open-api-specification.md): Review the OpenAPI definition that documents all endpoints in a structured format. - [API explorer](/api-overview/api-explorer.md): Run interactive, code-free API requests to understand responses and payloads. - [Requests](/api-overview/requests.md): Understand the required standards for making secure and consistent API requests. - [Versioning](/api-overview/versioning.md): Learn how API versions are managed to ensure stability and backward compatibility. - [Client libraries](/api-overview/client-libraries.md): Explore SDKs that simplify integration across different languages and frameworks. - [Rate limit](/api-overview/rate-limit.md): Review the request thresholds to ensure your application respects API usage limits. - [Changelog](/api-overview/changelog.md): See historical updates that document improvements across API versions. ## Authentication - [Introduction](/authentication/introduction.md): Learn how API authentication works and why it’s required for every request. - [API key](/authentication/api-key.md): Authenticate API calls quickly with an API key tied to your account. - [OAuth 2.0](/authentication/oauth-2-0.md): Implement OAuth 2.0 flows to enable secure delegated access for users. ## BoldSign Assistant - [Overview](/coding-assistant/overview.md): Learn how to streamline your development workflow with the BoldSign Assistant, including setup, best practices, and security guidelines. - [MCP Server](/coding-assistant/mcp-server.md): Set up and configure the BoldSign Assistant MCP Server to integrate seamlessly with your development environment. ## Documents — Sending - [Send document](/documents/send-document.md): Send a document for signature with configurable recipients, fields, and workflow settings. - [Send document from template](/documents/send-document-from-template.md): Send a signature request using a predefined template. - [Send document using multiple templates](/documents/send-document-using-multiple-templates.md): Merge multiple templates into a single signing workflow. - [Send document on behalf](/documents/send-document-on-behalf.md): Send a document on behalf of another user in your organization. - [Send document from draft](/documents/send-document-from-draft.md): Convert a draft into an active document for signing. ## Documents — Delivery Methods - [Request signature by email](/how-to-guides/request-signature-by-email.md): Deliver signature requests through email. - [Request signature by email from template](/how-to-guides/request-signature-by-email-from-template.md): Send email-based signature requests using templates. - [Request signature by email and SMS from template](/how-to-guides/request-signature-by-email-and-sms-from-template.md): Send signature requests through both email and SMS using a template. - [Request eSignature via SMS](/how-to-guides/How-to-request-esignature-via-sms.md): Send signature requests fully through SMS. ## Documents — Advanced Send Flows - [Send with in-person signing](/how-to-guides/send-document-with-in-person-signer.md): Allow recipients to sign documents in person. - [Send to multiple recipients](/how-to-guides/send-document-to-multiple-recipients.md): Send documents requiring signatures from multiple individuals. - [Send with multiple CCs](/how-to-guides/send-document-with-multiple-ccs.md): Add multiple CC recipients to receive document copies. - [Send using file URL](/how-to-guides/how-to-add-file-from-fileurl-while-sending-document.md): Use a file URL as the document source. - [Send using Base64 file input](/how-to-guides/how-to-add-file-as-base64-string-while-sending-document.md): Upload documents encoded as Base64 strings. - [Send with auto reminders](/how-to-guides/send_document_from-template_with_autoreminder.md): Automate reminder notifications for pending signatures. ## Documents — Management - [Send reminder](/documents/send-reminder.md): Remind signers to complete document signing with helpful reminders. - [Edit document](/documents/edit-document.md): Update document details or signer assignments. - [Cancel editing](/documents/cancel-editing.md): Allows you to cancel the editing of a document that is currently in edit mode. - [Change recipient](/how-to-guides/change-recipient-of-the-document.md): Replace or correct signer information. - [Change access code](/documents/change-access-code.md): Update the code required to access the document. - [Add authentication](/documents/add-authentication-to-the-document.md): Require authentication (SMS/email/access code). - [Remove authentication](/documents/remove-authentication-from-the-document.md): Remove authentication requirements. - [Revoke document](/documents/revoke-document.md): Cancel a document and stop all signing actions. - [Extend expiration](/documents/extend-document-expiry.md): Extend the signing deadline for a document. - [Delete document](/documents/delete-document.md): Permanently delete a document. - [Add document tags](/documents/add-document-tags.md): Add tags to categorize documents and make them easier to find. - [Delete document tags](/documents/delete-document-tags.md): Remove tags from documents to keep your library organized. - [Prefill form fields](/documents/prefill-form-fields.md): Automatically assign values to form fields before or after sending documents. ## Documents — Retrieval - [List documents](/documents/list-documents.md): Retrieve all documents in your account. - [List team documents](/documents/list-team-documents.md): Retrieve documents created by team members. - [List behalf documents](/documents/behalf-list-documents.md): Retrieve documents sent on behalf of others. - [Document details and status](/documents/document-details-and-status.md): View full metadata and status for a document. - [Retrieve document history](/how-to-guides/retrieve-esignature-document-history.md): View chronological events for a document. - [Track document by status](/how-to-guides/track-the-esignature-document-based-on-status.md): Track documents by their current state. - [Download document](/documents/download-document.md): Download the PDF version of a document. - [Download audit trail](/documents/download-audit-trail.md): Download the audit log for compliance. - [Download attachment](/how-to-guides/download-attachment.md): Retrieve attachments uploaded by signers. ## Templates - [Create template](/template/create-template.md): Create reusable templates with predefined fields and roles. - [Edit template](/template/edit-template.md): Update template content and configuration. - [Delete template](/template/delete-template.md): Remove a template from your account. - [Template details](/template/template-details.md): View detailed information about a template. - [Download template](/template/download-template.md): Download a PDF version of a template. - [List templates](/template/list-templates.md): Retrieve all templates in your organization. - [Add template tags](/template/add-template-tags.md): Tag templates for better organization. - [Delete template tags](/template/delete-template-tags.md): Remove tags from templates. - [Share template](/template/share-template.md): Share templates with other users or teams to enable collaboration and reuse. - [Remove roles during send](/how-to-guides/role-removal-indices.md): Exclude specific roles during the send process. - [Add additional files when sending](/how-to-guides/how-to-add-additional-files-while-sending-document-from-template.md): Attach extra files when sending template-based documents. ## Embedded Signing - [Get embedded signing link](/embedded-signing/get-embedded-signing-link.md): Generate a link for embedded signing inside your application. - [Embed signing in an iFrame](/embedded-signing/embed-in-an-iFrame.md): Embed the signing UI in your app using an iFrame. ## Embedded Request - [Create embedded request link](/embedded-request/create-embedded-request-link.md): Generate a session for embedded document creation. - [Create embedded request link from template](/embedded-request/create-embedded-request-link-from-template.md): Start an embedded request using a template. - [Create embedded request link using multiple templates](/embedded-request/create-embedded-request-link-using-multiple-templates.md): Use multiple templates in embedded request workflows. - [Create Embedded Edit Url](/embedded-request/create-embedded-edit-url.md): Allows you to generate an embedded link for editing documents that are in progress, scheduled as drafts, or saved in draft state. - [Embed request flow in an iFrame](/embedded-request/embed-in-an-iFrame.md): Embed the document creation UI. - [Restrict send and allow saving drafts](/how-to-guides/restrict-send-and-allow-to-save-in-drafts-for-embedded-request.md): Allow draft saving while restricting sending. - [Create embedded cloned document](/embedded-request/create-embedded-cloned-document.md): Create an embedded request by cloning an existing document with its fields and settings. ## Embedded Template - [Create embedded template](/embedded-template/create-embedded-template.md): Build reusable templates directly on your website using embedded links. - [Edit embedded template](/embedded-template/edit-embedded-template.md): Update and manage existing templates on your website through embedded links. - [Embed in an iFrame](/embedded-template/embed-in-an-iFrame.md): Embed the template creation UI. - [Preview embedded template](/embedded-template/preview-embedded-template.md): Preview existing templates on your website through embedded links. ## Identity Verification - [Identity verification introduction](/identity-verification/introduction.md): Learn how BoldSign verifies signer identities. - [Get verification report](/identity-verification/verification-report.md): Retrieve the verification results. - [Get verification image](/identity-verification/verification-image.md): Access uploaded identity images. - [Prefill verification data](/identity-verification/prefill-verification-data.md): Auto-fill fields using verified identity data. - [Embedded manual verification](/identity-verification/embedded-manual-verification.md): Review verification results inside an embedded UI. - [Sandbox mode](/identity-verification/sandbox-mode.md): Test identity verification using sandbox mode. ## Text Tags - [Text tags introduction](/text-tags/introduction.md): Learn how text tags define fields inside documents. - [Supported text tag fields](/text-tags/supported-fields.md): Explore supported text tag field types. - [Advanced text tag usage](/text-tags/advanced-usage.md): Implement advanced patterns using text tags. ## Sender Identities - [Create identity](/sender-identities/create-identity.md): Create a sender identity for document delivery. - [Update identity](/sender-identities/update-identity.md): Modify details of an existing sender identity. - [Delete identity](/sender-identities/delete-identity.md): Remove a sender identity. - [List identities](/sender-identities/list-identities.md): Retrieve all sender identities. - [Identity details](/sender-identities/identity-details.md): View specific sender identity details. - [Resend invitation](/sender-identities/resend-invitation.md): Send a new invitation to a pending user. - [Re-request approval](/sender-identities/re-request.md): Request approval again for a sender identity. ## Webhooks - [Webhook introduction](/webhooks/introduction.md): Learn how webhooks deliver real-time notifications. - [Available webhook events](/webhooks/available-events.md): Explore all event types available. - [Webhook configuration and lifecycle](/webhooks/webhook-configuration-and-lifecycle.md): Understand webhook activation and maintenance. - [Set up webhook](/webhooks/setting-webhook.md): Configure webhook endpoints. - [Listen for callback](/webhooks/listen-for-callback.md): Process inbound webhook payloads. - [Custom headers](/webhooks/custom-headers.md): Add custom headers for webhook requests. - [Event metadata](/webhooks/event-metadata.md): Retrieve details about webhook events, including event ID, type, and environment. - [Sample event data](/webhooks/sample-event-data.md): Explore sample webhook payloads for BoldSign events. - [Test webhooks](/webhooks/test-webhooks.md): Send test events to validate your setup. - [Verify webhook events](/webhooks/verify-webhook-events.md): Validate webhook signatures for security. - [IP whitelisting](/webhooks/ip-whitelisting.md): Restrict webhook processing to trusted IPs. - [Go live](/webhooks/go-live.md): Prepare webhook configurations for production. - [Event context](/webhooks/event-context.md): Understand webhook event payload structure, including detailed context information sent with each event. ## Users - [Create user](/users/create-user.md): Add a new user to your organization. - [Update user role](/users/update-user-role.md): Modify a user’s permissions. - [List users](/users/list-users.md): Retrieve all users in your organization. - [Get user details](/users/get-user-details.md): View user profile and permissions. - [Resend user invitation](/users/resend-user-invitation.md): Send a fresh invitation to a pending user. - [Cancel user invitation](/users/cancel-user-invitation.md): Cancel a pending user invite. - [Update metadata](/users/update-metadata.md): Modify metadata associated with a user. - [Change team](/users/change-team.md): Move a user to a different team. ## Teams - [Create team](/teams/create-team.md): Create a new team. - [Update team](/teams/update-team.md): Update team settings. - [List teams](/teams/list-teams.md): Retrieve all teams. - [Get team details](/teams/get-team-details.md): View detailed team information. ## Branding - [Create brand](/branding/create-brand.md): Create a custom brand for your organization. - [Update brand](/branding/update-brand.md): Modify brand appearance settings. - [List brands](/branding/list-brands.md): Retrieve all branding profiles. - [Get brand](/branding/get-brand.md): View details for a specific brand. - [Delete brand](/branding/delete-brand.md): Remove a brand profile. - [Reset brand settings to default](/branding/reset-brand-settings-to-default.md): Restore default branding options. - [Hide standard form fields](/how-to-guides/how-to-hide-standard-form-fields-using-branding.md): Hide default fields with branding. - [Show custom form fields](/how-to-guides/how-to-show-custom-form-fields-using-branding.md): Display custom fields using branding. ## Custom Field - [Create custom field](/custom-field/create-custom-field.md): Create reusable custom fields. - [Edit custom field](/custom-field/edit-custom-field.md): Modify custom field settings. - [Delete custom field](/custom-field/delete-custom-field.md): Delete a custom field. - [List custom fields](/custom-field/list-custom-field.md): Retrieve all custom fields. - [Embedded custom field create URL](/custom-field/embedded-custom-field-create-url.md): Generate an embedded field creation URL. ## Contacts - [Create contact](/contacts/create-contact.md): Add a new contact. - [Update contact](/contacts/update-contact.md): Modify existing contact details. - [List contacts](/contacts/list-contacts.md): Retrieve all contacts. - [Get contact details](/contacts/get-contact-details.md): View contact information. - [Delete contacts](/contacts/delete-contacts.md): Remove one or more contacts. ## Plan & Credits - [Get API document credit balance](/plan/planapicredits.md): Retrieve remaining API document credits. ## Troubleshooting - [Possible errors and solutions](/troubleshooting/possible-errors-and-solution.md): View common API issues and resolutions. - [Invalid email address](/how-to-guides/invalid-email-address.md): Understand and resolve email validation errors. - [SSL/TLS requirements](/how-to-guides/tls-requirements.md): Ensure integration meets security requirements. - [Accessing older documents](/how-to-guides/accessing-older-documents.md): Retrieve legacy documents. ## SDKs - [.NET SDK](/sdks/net-sdk.md): Integrate BoldSign into .NET applications. - [Node.js SDK](/sdks/node-sdk.md): Use the Node SDK for JavaScript and TypeScript workflows. - [Java SDK](/sdks/java-sdk.md): Integrate BoldSign into Java applications. - [Python SDK](/sdks/python-sdk.md): Use the Python SDK for automating workflows. - [PHP SDK](/sdks/php-sdk.md): Add eSignature features in PHP applications. ## How-to Guides — Document Sending - [Send document with in-person signer](/how-to-guides/send-document-with-in-person-signer.md): Allow recipients to sign documents in person under guided supervision. - [Send document to multiple recipients](/how-to-guides/send-document-to-multiple-recipients.md): Send documents that require signatures from multiple individuals. - [Send document with multiple CCs](/how-to-guides/send-document-with-multiple-ccs.md): Add multiple CC recipients to receive copies of completed documents. - [Send document using file URL](/how-to-guides/how-to-add-file-from-fileurl-while-sending-document.md): Attach files via a publicly accessible URL. - [Send document using Base64 input](/how-to-guides/how-to-add-file-as-base64-string-while-sending-document.md): Upload documents encoded as Base64 strings. - [Send document using multiple templates by filling existing form fields](/how-to-guides/send-document-using-multiple-templates-by-filling-existing-form-fields.md): Merge multiple templates and prefill fields before sending. - [Add metadata while sending document](/how-to-guides/how-to-add-metadata-while-sending-document.md): Add metadata when sending documents. ## How-to Guides — Signature Request Methods - [Request signature by email](/how-to-guides/request-signature-by-email.md): Send eSignature requests via email. - [Request signature by email from template](/how-to-guides/request-signature-by-email-from-template.md): Send email signature requests using templates. - [Request signature by email and SMS from template](/how-to-guides/request-signature-by-email-and-sms-from-template.md): Deliver signature requests through email and SMS. - [Request signature by email from multiple templates](/how-to-guides/request-signature-by-email-from-multiple-templates.md): Send email requests for merged templates. - [Request eSignature via SMS](/how-to-guides/How-to-request-esignature-via-sms.md): Send signature requests exclusively through SMS. - [Request signature with signer authentication](/how-to-guides/request-signature-with-signer-authentication.md): Require email, SMS, or access code verification before signing. - [Request signature with text tags](/how-to-guides/request-signature-with-text-tags.md): Send documents using text tags to auto-generate fields. ## How-to Guides — Workflow Controls - [Allow signer order](/how-to-guides/how-to-allow-the-signer-to-sign-in-a-particular-order.md): Enforce a specific signing order. - [Prevent signer reassignment](/how-to-guides/prevent-signers-from-reassigning-the-esignature-document.md): Block signers from delegating signing responsibilities. - [Require attachment upload before signing](/how-to-guides/how-to-set-attachment-form-fields.md): Require signers to upload attachments before completing the signing process. ## How-to Guides — Document Management After Sending - [Change recipient](/how-to-guides/change-recipient-of-the-document.md): Update signer details after sending. - [Add email authentication after sending](/how-to-guides/email-authentication-to-the-signer-after-sending-the-document.md): Enable email authentication post-send. - [Add SMS authentication after sending](/how-to-guides/sms-authentication-to-the-signer-after-sending-the-document.md): Apply SMS-based authentication after sending. - [Add access code authentication after sending](/how-to-guides/access-code-authentication-to-the-signer-after-sending-the-document.md): Add an access code requirement after a document has been issued. - [Remove authentication after sending](/how-to-guides/remove-authentication-after-sending-the-document.md): Remove signer authentication requirements post-send. ## How-to Guides — Tracking & Retrieval - [Retrieve document history](/how-to-guides/retrieve-esignature-document-history.md): Access a complete history of document events. - [Track document by status](/how-to-guides/track-the-esignature-document-based-on-status.md): Track documents based on their lifecycle status. - [Download attachment](/how-to-guides/download-attachment.md): Download signer-uploaded attachments. - [List expiring documents](/how-to-guides/list-behalf-documents.md): Identify documents due to expire soon. ## How-to Guides — Form Fields (Checkbox) - [Add checkbox field](/how-to-guides/add-checkbox-field.md): Add a checkbox input for signers. ## How-to Guides — Form Fields (Radio Buttons) - [Add radio button field](/how-to-guides/add-radio-button-field.md): Add radio button fields for single-option selection. - [Prefill radio values from template](/how-to-guides/how-to-prefill-values-for-radio-button-while-sending-documents-from-template.md): Prefill radio button selections when sending from templates. - [Prefill radio values after sending](/how-to-guides/how-to-prefill-values-for-radio-button-after-sending-document-for-signature.md): Prefill radio button values after sending. ## How-to Guides — Form Fields (Dropdowns, Text, Labels) - [Set dropdown form fields](/how-to-guides/how-to-set-drop-down-form-fields.md): Create dropdown fields with predefined options. - [Provide text direction](/how-to-guides/how-to-provide-textdirection-property-for-textbox-fields.md): Set text direction for text fields. - [Set default field value](/how-to-guides/how-to-set-the-default-value-for-form-fields.md): Apply a default value to form fields. - [Prefill read-only field](/how-to-guides/prefill-readonly-field-value.md): Prefill values in read-only fields. - [Add validation to textbox field](/how-to-guides/add-validation-to-textbox-field.md): Add regex validation to textbox fields. - [Set character limit](/how-to-guides/how-to-set-character-limit-for-form-fields.md): Apply limits to the number of characters allowed. ## How-to Guides — Form Fields (Dates) - [Set date format](/how-to-guides/how-to-set-date-format-on-a-form-field.md): Customize the date format. - [Set date range](/how-to-guides/how-to-set-date-range-on-a-form-field.md): Limit the allowed date range. ## How-to Guides — Form Fields (Images & Attachments) - [Add image form fields](/how-to-guides/how-to-set-image-form-fields.md): Add an image upload field. - [Prefill image fields from template](/how-to-guides/how-to-prefill-image-field-when-sending-document-from-template.md): Prefill image fields when sending from templates. - [Prefill image fields after sending](/how-to-guides/how-to-prefill-the-image-field-after-sending-document.md): Prefill image fields post-send. - [Add attachment form fields](/how-to-guides/how-to-set-attachment-form-fields.md): Add a required attachment field for signers. ## How-to Guides — Formatting & Visual Controls - [Set background color for label fields](/how-to-guides/how-to-provide-background-color-for-label-fields-while-sending-document.md): Customize label background colors. - [Set required property](/how-to-guides/how-to-provide-required-property-for-form-fields.md): Make fields mandatory. - [Set read-only property](/how-to-guides/how-to-provide-readonly-property-for-form-fields.md): Make fields non-editable. - [Replace PDF fillable fields](/how-to-guides/detect-fillable-fields-in-the-document-and-replace-it-with-BoldSign-form-fields-while-sending-the-document-via-API.md): Convert PDF fields into BoldSign form fields. ## How-to Guides — Conditional Fields - [Create conditional fields](/how-to-guides/create-conditional-fields.md): Display fields dynamically based on user input. ## How-to Guides — Embedded Workflow Add-ons - [Restrict send and allow saving drafts](/how-to-guides/restrict-send-and-allow-to-save-in-drafts-for-embedded-request.md): Prevent sending while allowing draft saving during embedded requests. ## BoldSign MCP Server - [MCP Server Authentication](/boldsign-mcp-server/authentication.md): Learn how to configure and use authentication for the BoldSign MCP server. - [Warranty Claim Agent Demo](/boldsign-mcp-server/mcp-demo.md): Explore a Warranty Claim Agent demo that uses the BoldSign MCP Server to automate a warranty claim workflow, from data collection through eSignature and status tracking. - [ChatGPT Integration](/boldsign-mcp-server/chatgpt.md): Integrate the BoldSign MCP server with ChatGPT for AI-powered workflows. - [Claude Web](/boldsign-mcp-server/claude-web.md): Connect the hosted BoldSign MCP Server to Claude Web as a remote connector using OAuth authentication. - [Claude Code](/boldsign-mcp-server/claude-code.md): Connect the hosted BoldSign MCP Server to Claude Code using a project-level .mcp.json file and API key authentication. - [GitHub Copilot Integration](/boldsign-mcp-server/github-copilot.md): Leverage GitHub Copilot with the BoldSign MCP server for enhanced developer productivity. - [Codex](/boldsign-mcp-server/codex.md): Connect the hosted BoldSign MCP Server to OpenAI Codex using API key authentication to automate eSignature workflows through natural language. - [Overview](/boldsign-mcp-server/overview.md): Get an overview of the BoldSign MCP server, its capabilities, and how it works.