API

Every boldsign.api.* operation is listed below with parameter shapes and return types from the plugin Zod schemas.

New to Corsair? See API access, authentication, and error handling.

Brands

get

brands.get Get details of one brand by brandId. Risk: read

await corsair.boldsign.api.brands.get({});

Input

Name	Type	Required	Description
`brandId`	`string`	Yes	—

Output

Name	Type	Required	Description
`brandId`	`string`	Yes	—
`brandName`	`string`	No	—

list

brands.list List all brands available to the account. Risk: read

await corsair.boldsign.api.brands.list({});

Input: empty object Output

Name	Type	Required	Description
`result`	`object[]`	Yes	—

result full type

{
  brandId: string,
  brandName?: string
}[]

Custom Fields

create

customFields.create Create a reusable custom field under a BoldSign brand. Risk: write

await corsair.boldsign.api.customFields.create({});

Input

Name	Type	Required	Description
`fieldName`	`string`	Yes	—
`formField`	`object`	Yes	—
`fieldDescription`	`string`	No	—
`fieldOrder`	`number`	No	—
`brandId`	`string`	No	—
`sharedField`	`boolean`	No	—

formField full type

{
  id?: string,
  name?: string,
  fieldType?: string
}

Output

Name	Type	Required	Description
`customFieldId`	`string`	Yes	—
`message`	`string`	Yes	—

edit

customFields.edit Update a brand custom field by customFieldId. Risk: write

await corsair.boldsign.api.customFields.edit({});

Input

Name	Type	Required	Description
`fieldName`	`string`	Yes	—
`formField`	`object`	Yes	—
`fieldDescription`	`string`	No	—
`fieldOrder`	`number`	No	—
`brandId`	`string`	No	—
`sharedField`	`boolean`	No	—
`customFieldId`	`string`	Yes	—

formField full type

{
  id?: string,
  name?: string,
  fieldType?: string
}

Output

Name	Type	Required	Description
`customFieldId`	`string`	Yes	—
`message`	`string`	Yes	—

Documents

createEmbeddedRequestLink

documents.createEmbeddedRequestLink Create an embedded document request URL for draft/send flows. Risk: write

await corsair.boldsign.api.documents.createEmbeddedRequestLink({});

Input

Name	Type	Required	Description
`title`	`string`	No	—
`message`	`string`	No	—
`signers`	`object[]`	No	—
`files`	`object[]`	No	—
`fileUrls`	`string[]`	No	—
`redirectUrl`	`string`	No	—
`showToolbar`	`boolean`	No	—
`showSendButton`	`boolean`	No	—
`showSaveButton`	`boolean`	No	—
`showPreviewButton`	`boolean`	No	—
`showNavigationButtons`	`boolean`	No	—
`sendViewOption`	`PreparePage \| FillingPage`	No	—
`locale`	`string`	No	—
`sendLinkValidTill`	`string`	No	—
`embeddedSendLinkValidTill`	`string`	No	—
`enableSigningOrder`	`boolean`	No	—
`onBehalfOf`	`string`	No	—

signers full type

{
  name?: string,
  emailAddress?: string,
  signerType?: string,
  formFields?: {
    id?: string,
    name?: string,
    fieldType?: string
  }[]
}[]

files full type

(
  string | {
    base64: string,
    fileName: string
  }
)[]

Output

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`sendUrl`	`string`	Yes	—

editBeta

documents.editBeta Edit an existing document request (beta endpoint). Risk: write

await corsair.boldsign.api.documents.editBeta({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`title`	`string`	No	—
`message`	`string`	No	—
`signers`	`object[]`	No	—
`cc`	`object[]`	No	—
`files`	`object[]`	No	—
`enableSigningOrder`	`boolean`	No	—
`disableEmails`	`boolean`	No	—
`disableSMS`	`boolean`	No	—
`onBehalfOf`	`string`	No	—

signers full type

{
  name?: string,
  emailAddress?: string,
  signerType?: string,
  formFields?: {
    id?: string,
    name?: string,
    fieldType?: string
  }[]
}[]

cc full type

{
}[]

files full type

{
}[]

Output

Name	Type	Required	Description
`status`	`string`	Yes	—

extendExpiry

documents.extendExpiry Extend document expiry window for pending signers. Risk: write

await corsair.boldsign.api.documents.extendExpiry({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`newExpiryValue`	`string`	Yes	—
`warnPrior`	`boolean`	No	—
`onBehalfOf`	`string`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

list

documents.list List documents with filters and pagination. Risk: read

await corsair.boldsign.api.documents.list({});

Input

Name	Type	Required	Description
`page`	`number`	Yes	—
`pageSize`	`number`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`status`	`string[]`	No	—
`sentBy`	`string[]`	No	—
`recipients`	`string[]`	No	—
`transmitType`	`string`	No	—
`dateFilterType`	`string`	No	—
`searchKey`	`string`	No	—
`labels`	`string[]`	No	—
`nextCursor`	`number`	No	—
`brandIds`	`string[]`	No	—

Output

Name	Type	Required	Description
`pageDetails`	`object`	Yes	—
`result`	`object[]`	Yes	—

pageDetails full type

{
  page?: number,
  pageSize?: number,
  totalRecordsCount?: number,
  totalPages?: number
}

result full type

{
  documentId?: string,
  status?: string,
  title?: string,
  nextCursor?: number
}[]

listBehalf

documents.listBehalf List documents sent on behalf of users. Risk: read

await corsair.boldsign.api.documents.listBehalf({});

Input

Name	Type	Required	Description
`page`	`number`	Yes	—
`pageType`	`string`	No	—
`pageSize`	`number`	No	—
`emailAddress`	`string[]`	No	—
`signers`	`string[]`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`status`	`string[]`	No	—
`searchKey`	`string`	No	—
`labels`	`string[]`	No	—
`nextCursor`	`number`	No	—
`brandIds`	`string[]`	No	—

Output

Name	Type	Required	Description
`pageDetails`	`object`	Yes	—
`result`	`object[]`	Yes	—

pageDetails full type

{
  page?: number,
  pageSize?: number,
  totalRecordsCount?: number,
  totalPages?: number
}

result full type

{
  documentId?: string,
  status?: string,
  title?: string,
  nextCursor?: number
}[]

listTeam

documents.listTeam List documents across teams/users with filters. Risk: read

await corsair.boldsign.api.documents.listTeam({});

Input

Name	Type	Required	Description
`page`	`number`	Yes	—
`pageSize`	`number`	No	—
`userId`	`string[]`	No	—
`teamId`	`string[]`	No	—
`startDate`	`string`	No	—
`endDate`	`string`	No	—
`status`	`string[]`	No	—
`searchKey`	`string`	No	—
`labels`	`string[]`	No	—
`transmitType`	`string`	No	—
`dateFilterType`	`string`	No	—
`nextCursor`	`number`	No	—
`brandIds`	`string[]`	No	—

Output

Name	Type	Required	Description
`pageDetails`	`object`	Yes	—
`result`	`object[]`	Yes	—

pageDetails full type

{
  page?: number,
  pageSize?: number,
  totalRecordsCount?: number,
  totalPages?: number
}

result full type

{
  documentId?: string,
  status?: string,
  title?: string,
  nextCursor?: number
}[]

removeAuthentication

documents.removeAuthentication Remove signer authentication from a document recipient. Risk: write

await corsair.boldsign.api.documents.removeAuthentication({});

Input

Name	Type	Required	Description
`documentId`	`string`	Yes	—
`emailId`	`string`	Yes	—
`zOrder`	`number`	No	—
`onBehalfOf`	`string`	No	—

Output

Name	Type	Required	Description
`success`	`boolean`	Yes	—

send

documents.send Send a document for signature. Risk: write

await corsair.boldsign.api.documents.send({});

Input

Name	Type	Required	Description
`title`	`string`	Yes	—
`message`	`string`	No	—
`signers`	`object[]`	No	—
`files`	`object[]`	No	—
`fileUrls`	`string[]`	No	—
`enableSigningOrder`	`boolean`	No	—
`expiryValue`	`number`	No	—
`expiryDateType`	`Days \| DateTime`	No	—
`reminderSettings`	`object`	No	—
`disableEmails`	`boolean`	No	—
`disableSMS`	`boolean`	No	—
`brandId`	`string`	No	—
`labels`	`string[]`	No	—
`sendLinkValidTill`	`string`	No	—
`useTextTags`	`boolean`	No	—
`onBehalfOf`	`string`	No	—

signers full type

{
  name?: string,
  emailAddress?: string,
  signerType?: string,
  formFields?: {
    id?: string,
    name?: string,
    fieldType?: string
  }[]
}[]

files full type

(
  string | {
    base64: string,
    fileName: string
  }
)[]

reminderSettings full type

{
}

Output

Name	Type	Required	Description
`documentId`	`string`	Yes	—

Helpers

uploadFile

helpers.uploadFile Prepare a file payload for BoldSign multipart/json send APIs using base64 data URI. Risk: read

await corsair.boldsign.api.helpers.uploadFile({});

Input

Name	Type	Required	Description
`fileName`	`string`	Yes	—
`mimeType`	`string`	Yes	—
`base64Content`	`string`	Yes	—

Output

Name	Type	Required	Description
`file`	`object`	Yes	—

file full type

{
  base64: string,
  fileName: string
}

Plan

getApiCreditsCount

plan.getApiCreditsCount Get remaining API credits count. Risk: read

await corsair.boldsign.api.plan.getApiCreditsCount({});

Input: empty object Output

Name	Type	Required	Description
`BalanceCredits`	`number`	No	—
`balanceCredits`	`number`	No	—

Overview

Plugins

Brands

get

list

Custom Fields

create

edit

Documents

createEmbeddedRequestLink

editBeta

extendExpiry

list

listBehalf

listTeam

removeAuthentication

send

Helpers

uploadFile

Plan

getApiCreditsCount

​Brands

​get

​list

​Custom Fields

​create

​edit

​Documents

​createEmbeddedRequestLink

​editBeta

​extendExpiry

​list

​listBehalf

​listTeam

​removeAuthentication

​send

​Helpers

​uploadFile

​Plan

​getApiCreditsCount

Brands

get

list

Custom Fields

create

edit

Documents

createEmbeddedRequestLink

editBeta

extendExpiry

list

listBehalf

listTeam

removeAuthentication

send

Helpers

uploadFile

Plan

getApiCreditsCount