How AI is applied across API Evangelist and APIs.io. Read my AI disclosure →
API Evangelist API Evangelist
Discovery
Learnings
Guidance
Toolbox
Alignment
API Evangelist LLC

BoldSign Document API

The Document API from BoldSign — 25 operation(s) for document.

BoldSign Document API is one of 11 APIs that BoldSign publishes on the APIs.io network, described by a machine-readable OpenAPI specification.

This API exposes 1 JSON Schema definition.

Tagged areas include Document. The published artifact set on APIs.io includes an OpenAPI specification, API documentation, and 1 JSON Schema.

This API exposes 25 operations across 25 paths, and defines 69 schemas. It is described by OpenAPI 3.0.3, at version 1.

Requests are made against 4 base URLs: https://api.boldsign.com, https://eu.boldsign.com, https://ca.boldsign.com, https://au.boldsign.com.

25 operations 25 paths 69 schemas 2 DELETE8 GET7 PATCH7 POST1 PUT

Metadata

The identity and technical contract details declared by the specification.

Specification
OpenAPI 3.0.3
API Version
1
Base URL
https://api.boldsign.com
Authentication
API Key, API Key
Terms of Service
Resource Areas
1

Authentication & Security 2

BoldSign Document API declares 2 security schemes for authenticating requests. An API key is passed in the header as Authorization (Bearer). An API key is passed in the header as X-API-KEY (X-API-KEY). By default, every request must be authenticated.

  • Bearer — Format 'Bearer' [space] [TOKEN]. Ex: 'Bearer eyJhbGciOiJIUzI1N'
  • X-API-KEY — Format [API-KEY]. Ex: 'abcdef12345'

Paths & Operations 25

Across 25 paths, the API surfaces 25 operations — 2 DELETE, 8 GET, 7 PATCH, 7 POST, 1 PUT. Each is listed below with its method, path, parameters, and response codes.

Document 25
POST
/v1/document/send
Sends the document for sign.
SendDocument body → 201401403400422
PATCH
/v1/document/extendExpiry
Extends the expiration date of the document.
ExtendExpiry 1 param body → 200401403
POST
/v1/document/createEmbeddedRequestUrl
Generates a send URL which embeds document sending process into your application.
CreateEmbeddedRequestUrlDocument body → 201401403400422
POST
/v1/document/createEmbeddedEditUrl
Generates an embedded edit URL that allows the document editing process to be integrated into your application.
createEmbeddedEditUrl 1 param body → 201400401403422
GET
/v1/document/list
List user documents.
ListDocuments 13 params → 200401
GET
/v1/document/teamlist
Get user Team documents.
TeamDocuments 13 params → 200401403
GET
/v1/document/behalfList
Gets the behalf documents.
BehalfDocuments 12 params → 200401403
GET
/v1/document/properties
Get summary of the document.
GetDocumentProperties 1 param → 200401403
GET
/v1/document/download
Download the document.
DownloadDocument 2 params → 200401403
GET
/v1/document/downloadAttachment
Download the Attachment.
DownloadAttachment 3 params → 200401403
GET
/v1/document/downloadAuditLog
Download the audit trail document.
DownloadAuditLog 2 params → 200401403
POST
/v1/document/revoke
Revoke the document.
RevokeDocument 1 param body → 204401403
DELETE
/v1/document/delete
Delete the document.
DeleteDocument 2 params → 204401403
POST
/v1/document/remind
Send reminder to pending signers.
RemindDocument 2 params body → 204401403
PATCH
/v1/document/changeAccessCode
Changes the access code for the given document signer.
ChangeAccessCode 3 params body → 204401403
PATCH
/v1/document/changeRecipient
Change recipient details of a document.
ChangeRecipient 1 param body → 204401403
GET
/v1/document/getEmbeddedSignLink
Get sign link for Embedded Sign.
GetEmbeddedSignLink 6 params → 200401403
PATCH
/v1/document/addTags
Add the Tags in Documents.
AddDocumentTag body → 200400401
DELETE
/v1/document/deleteTags
Delete the Tags in Documents.
DeleteDocumentTag body → 200401400
PATCH
/v1/document/RemoveAuthentication
Remove the access code for the given document signer.
RemoveAuthentication 1 param body → 204401403
PATCH
/v1/document/addAuthentication
The add authentication to recipient.
AddAuthentication 1 param body → 200401403
PATCH
/v1/document/prefillFields
Updates the value (prefill) of the fields in the document.
PrefillFields 1 param body → 200401403
POST
/v1/document/draftSend
Sends a draft-status document out for signature.
DraftSend 1 param → 201401403
PUT
/v1/document/edit
Edit and updates an existing document.
EditDocument 1 param body → 200401403400422
POST
/v1/document/cancelEditing
Cancels editing for a document that is currently in edit-mode.
cancelEditing 2 params → 200400401

Schemas 69

The contract defines 69 schemas that model the data the API accepts and returns. The most detailed are EmbeddedDocumentRequest (49 properties), DocumentProperties (48 properties), DocumentFormFields (43 properties), FormField (43 properties). Each schema is shown below with its type and property counts.

FormulaFieldSettings
object
2 properties
TextTagOffset
object
2 properties
AuthenticationSettings
object
1 property
DocumentCC
object
1 property 1 required
FormField
object
43 properties 3 required
PageDetails
object
6 properties
DocumentCcDetails
object
2 properties
DocumentSignerDetails
object
31 properties
DocumentReassign
object
3 properties
EmbeddedDocumentEdited
object
1 property
DocumentFormFields
object
43 properties
AuditTrail
object
15 properties
EditDocumentFile
object
4 properties 1 required
Rectangle
object
4 properties
ModificationDetails
object
2 properties
DocumentRecords
object
2 properties
GroupSigner
object
7 properties
RecipientChangeLog
object
2 properties
PrefillField
object
2 properties 2 required
ExtendExpiry
object
4 properties
AccessCodeDetails
object
3 properties 1 required
DocumentSenderDetail
object
4 properties
DocumentProperties
object
48 properties
ReminderSettings
object
3 properties
DocumentFiles
object
6 properties
DocumentTags
object
2 properties 2 required
PhoneNumber
object
2 properties
ChangeRecipient
object
8 properties 2 required
AttachmentInfo
object
4 properties 2 required
ConditionalRule
object
3 properties
SignerAuthenticationSettings
object
2 properties
DocumentCreated
object
1 property
Removed
object
3 properties
Document
object
18 properties
BehalfDocument
object
19 properties
ReminderMessage
object
3 properties
PrefillFieldRequest
object
2 properties 1 required
BehalfDocumentRecords
object
2 properties
CollaborationSettings
object
4 properties
RevokeDocument
object
2 properties 1 required
Added
object
3 properties
SendForSign
object
39 properties
DocumentEdited
object
1 property
AccessCodeDetail
object
9 properties 1 required
FileInfo
object
4 properties
Font
object
8 properties
RecipientNotificationSettings
object
12 properties
EmbeddedSigningLink
object
1 property
EmbeddedDocumentEditJsonRequest
object
9 properties
EditableDateFieldSettings
object
4 properties 1 required
EditFormField
object
42 properties 1 required
ImageInfo
object
3 properties 2 required
BehalfOf
object
2 properties
Validation
object
3 properties 1 required
TeamDocumentRecords
object
2 properties
DocumentSigner
object
24 properties
DocumentInfo
object
4 properties 2 required
ErrorResult
object
1 property
EditDocumentRequest
object
32 properties
EditDocumentSigner
object
25 properties 1 required
TextTagDefinition
object
33 properties 3 required
IdVerificationDetails
object
10 properties
IdentityVerificationSettings
object
7 properties
RemoveAuthentication
object
4 properties
GroupSignerSettings
object
2 properties
Size
object
2 properties
EmbeddedSendCreated
object
2 properties
FormGroup
object
5 properties 2 required
EmbeddedDocumentRequest
object
49 properties

Specification

The full machine-readable OpenAPI contract behind this narrative.

Source

boldsign-document-api-openapi.yml Raw ↑

Other APIs BoldSign publishes across the network.

BoldSign Branding API
BoldSign Contacts API
BoldSign Custom Field API
BoldSign GroupContacts API
BoldSign Identity Verification API
BoldSign Plan API
BoldSign Sender Identities API
BoldSign Teams API
BoldSign Template API
BoldSign User API
Where this information came from

This is an independent, third-party profile of BoldSign Document API, published by API Evangelist. We do not operate, host, resell, or support these APIs, and we are not affiliated with or endorsed by the company unless stated above. Everything here is built from publicly available information — the company's own site, developer portal, documentation, public repositories, and the specifications it publishes for public use. Nothing is obtained by breaching a system, defeating an access control, or using credentials.

The Kin Score and Agent Readiness rating are independently calculated assessments of a company's public API artifacts, scored against a published rubric. They are not certifications, endorsements, security assessments, or audits.

Corrections, re-scores, and removal are free — no partnership or purchase required, and you do not need to justify the request. A removed company is recorded as unrated, never scored zero for having asked. Acknowledgement within one business day; removal within two.

info@apievangelist.com · Read the full data-sourcing policy →
On a security or compliance team? Put security in the subject line and you will get a person, not a form — we will tell you exactly which public URLs this profile was built from.