BoldSign

Permanently delete a branding profile. Documents already sent under it keep the branding they were sent with via DELETE /v1/brand/delete

Permanently delete one contact group. The contacts in it are kept via DELETE /v1/contactGroups/delete

Permanently delete one saved contact by id via DELETE /v1/contacts/delete

Permanently delete one reusable custom field by id via DELETE /v1/customField/delete

Move a document to the bin, or -- with deletePermanently -- destroy it outright, which cannot be undone via DELETE /v1/document/delete

Detach labels from one or more documents. The documents themselves are untouched via DELETE /v1/document/deleteTags

Permanently remove a sender identity. The account can no longer send from that address via DELETE /v1/senderIdentities/delete

Permanently delete one template by id. Documents already sent from it are untouched via DELETE /v1/template/delete

Detach labels from one or more templates. The templates themselves are untouched via DELETE /v1/template/deleteTags

Read one branding profile -- its name, logo, colours, sender email and the flags that decide what a signer sees -- by brand id via GET /v1/brand/get

List the account's branding profiles, one page at a time via GET /v1/brand/list

Read one contact group and its members by id via GET /v1/contactGroups/get

List the account's contact groups, one page at a time via GET /v1/contactGroups/list

Read one saved contact by id via GET /v1/contacts/get

List the account's saved contacts, filtered by contact type and search text, one page at a time via GET /v1/contacts/list

List the reusable custom fields defined under one brand via GET /v1/customField/list

List the signature requests this credential sent on another user's behalf via GET /v1/document/behalfList

Fetch the document's PDF. BoldSign answers with the FILE ITSELF, so Agentic Fabriq returns its content type, size, filename and -- only while it fits the inline bound -- its base64 bytes, never a truncated prefix via GET /v1/document/download

Fetch one file a signer attached to a document. BoldSign answers with the FILE ITSELF, returned as bounded base64 or, over the bound, as metadata naming its size via GET /v1/document/downloadAttachment

Fetch the document's certificate of completion -- who did what, when and from where. BoldSign answers with the FILE ITSELF, returned as bounded base64 or, over the bound, as metadata naming its size via GET /v1/document/downloadAuditLog

Mint a short-lived signing URL for one signer, to embed BoldSign's signing page in your product. The URL is a credential: whoever opens it can sign as that person via GET /v1/document/getEmbeddedSignLink

List the signature requests this credential can see, filtered by status, sender, recipient, date range, labels and brand, one page at a time via GET /v1/document/list

Read everything BoldSign records about one signature request: its status, every signer and their state, the form fields, reminders, expiry, labels and audit-relevant timestamps via GET /v1/document/properties

List the signature requests belonging to one or more teams, with the same filters as the account listing via GET /v1/document/teamlist

Read how many API credits the account has left. Sending documents spends them via GET /v1/plan/apiCreditsCount

List the addresses the account may send from and the state of each request, one page at a time via GET /v1/senderIdentities/list

Read one sender identity by email address, including its approval state via GET /v1/senderIdentities/properties

Read one team by id, including its members via GET /v1/teams/get

List the account's teams, one page at a time via GET /v1/teams/list

Fetch the template's PDF. BoldSign answers with the FILE ITSELF, returned as bounded base64 or, over the bound, as metadata naming its size via GET /v1/template/download

List the templates this credential can see, filtered by type, labels, brand and search text, one page at a time via GET /v1/template/list

Read everything BoldSign records about one template: its roles, form fields, default message, labels and sharing via GET /v1/template/properties

Read one account user by id, including their email address, role and team via GET /v1/users/get

List the people on the account with their roles, teams and state, one page at a time. This returns their email addresses via GET /v1/users/list

Require an extra identity check -- access code, email OTP, SMS or ID verification -- before a signer can open the document via PATCH /v1/document/addAuthentication

Attach labels to one or more documents so they can be found and filtered later via PATCH /v1/document/addTags

Replace the access code one signer must type before the document opens via PATCH /v1/document/changeAccessCode

Redirect an in-flight signature request to a different person, with a reason recorded in the audit trail via PATCH /v1/document/changeRecipient

Push out the date an in-flight signature request stops accepting signatures via PATCH /v1/document/extendExpiry

Write values into a document's form fields before the signer opens it via PATCH /v1/document/prefillFields

Drop the extra identity check (access code, email OTP, SMS or ID verification) a signer had to pass before opening the document via PATCH /v1/document/RemoveAuthentication

Attach labels to one or more templates so they can be found and filtered later via PATCH /v1/template/addTags

Change who may use a template -- the whole account, named teams, or its owner alone via PATCH /v1/template/share

Set which branding profile new documents use when none is named via POST /v1/brand/resetdefault

Create a named group of contacts that can be addressed as one recipient set via POST /v1/contactGroups/create

Add one or more contacts to the address book. The body is an ARRAY of contacts, each needing at least a name and an email address via POST /v1/contacts/create

Define a reusable form field -- its type, validation, default value and appearance -- that can be dropped onto any document or template via POST /v1/customField/create

Mint a short-lived URL that embeds BoldSign's own custom-field editor in your product. The URL is a credential: anyone holding it can edit the brand's custom fields until it expires via POST /v1/customField/createEmbeddedCustomFieldUrl

Change a reusable custom field's definition. Documents already sent keep the definition they were sent with via POST /v1/customField/edit

Release the edit lock an embedded editor session took on a document via POST /v1/document/cancelEditing

Mint a short-lived URL that embeds BoldSign's prepare page pre-filled from an existing document, so a new request can be sent from it via POST /v1/document/createEmbeddedCloneUrl

Mint a short-lived URL that embeds BoldSign's editor for an existing draft document. The URL is a credential for that document via POST /v1/document/createEmbeddedEditUrl

Create a signature request and return a short-lived URL that embeds BoldSign's own prepare-and-send page in your product. The URL is a credential for that document via POST /v1/document/createEmbeddedRequestUrl

Send a document that is still a draft. Every signer is emailed immediately via POST /v1/document/draftSend

Email a reminder to the signers who have not yet acted. This sends real mail to real people via POST /v1/document/remind

Stop an in-flight signature request. Signers who have not finished can no longer sign, and the reason given is shown to them via POST /v1/document/revoke

Create a signature request from uploaded files or file URLs and SEND IT -- every signer is emailed immediately unless the request is scheduled or disabled via POST /v1/document/send

Mint a short-lived URL that embeds BoldSign's identity-verification flow for one signer in your product via POST /v1/identityVerification/createEmbeddedVerificationUrl

Fetch an image captured during identity verification -- a selfie or a photo of an identity document. BoldSign answers with the FILE ITSELF, returned as bounded base64. This is personal identity data via POST /v1/identityVerification/image

Read the identity-verification result for one signer: the document they presented, the checks that ran and what each returned. This is personal identity data via POST /v1/identityVerification/report

Ask a person to let the account send documents from their email address. BoldSign emails them a request they must approve via POST /v1/senderIdentities/create

Ask again after a sender identity was declined or revoked. This sends real mail to a real person via POST /v1/senderIdentities/rerequest

Email the approval request again to a sender identity that has not responded. This sends real mail to a real person via POST /v1/senderIdentities/resendInvitation

Change the display name or redirect address on a sender identity via POST /v1/senderIdentities/update

Create a team so documents and templates can be shared within it via POST /v1/teams/create

Create a reusable template from uploaded files or file URLs, with its roles, fields and default message via POST /v1/template/create

Mint a short-lived URL that embeds BoldSign's template builder pre-filled from an existing template, so a copy can be built from it via POST /v1/template/createEmbeddedCloneUrl

Mint a short-lived URL that embeds a read-only preview of a template in your product via POST /v1/template/createEmbeddedPreviewUrl

Create a signature request from a template and return a short-lived URL that embeds BoldSign's prepare-and-send page in your product via POST /v1/template/createEmbeddedRequestUrl

Mint a short-lived URL that embeds BoldSign's template builder in your product so a new template can be built there via POST /v1/template/createEmbeddedTemplateUrl

Mint a short-lived URL that embeds BoldSign's template builder for an existing template. The URL is a credential for that template via POST /v1/template/getEmbeddedTemplateEditUrl

Combine several templates into one signature request and SEND IT. Every signer is emailed immediately via POST /v1/template/mergeAndSend

Combine several templates into one signature request and return a short-lived URL that embeds BoldSign's prepare-and-send page via POST /v1/template/mergeCreateEmbeddedRequestUrl

Create a signature request from a template and SEND IT -- every signer is emailed immediately unless the request is scheduled or disabled via POST /v1/template/send

Withdraw an invitation that has not been accepted via POST /v1/users/cancelInvitation

Invite a person to the BoldSign account with a role and an optional team. BoldSign emails them an invitation via POST /v1/users/create

Email the account invitation again to a user who has not accepted. This sends real mail to a real person via POST /v1/users/resendInvitation

Replace a contact group's name and membership via PUT /v1/contactGroups/update

Replace one saved contact's name, email, company, job title and phone number via PUT /v1/contacts/update

Replace a draft document's files, signers, fields, message, expiry and reminder settings via PUT /v1/document/edit

Change a team's name via PUT /v1/teams/update

Replace a template's files, roles, fields, message and settings via PUT /v1/template/edit

Change which team a user belongs to via PUT /v1/users/changeTeam

Change a user's name, role, team or active state via PUT /v1/users/update

Write the account-level metadata BoldSign keeps beside a user record via PUT /v1/users/updateMetaData