New to Corsair? See API access, authentication, and error handling.
Documents
attachments.create.post
documents.attachments.create.post
POST /document/attachment/create — [Deprecated] Create attachment.
Risk: write
await corsair.documenso.api.documents.attachments.create.post({
documentId: 1,
data: { label: 'sample', data: 'https://documenso.invalid/resource' },
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
data | object | Yes | — |
POST /document/attachment/create); use the corresponding envelope-based operation for new integrations.
data full type
data full type
{
label: string,
data: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
attachments.delete.post
documents.attachments.delete.post
POST /document/attachment/delete — [Deprecated] Delete attachment.
Risk: destructive
await corsair.documenso.api.documents.attachments.delete.post({ id: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
POST /document/attachment/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
attachments.find.get
documents.attachments.find.get
GET /document/attachment — [Deprecated] Find attachments. Documenso’s server currently routes this path to the get-document handler and answers 400; use envelopes.attachments.find with the document’s envelopeId instead.
Risk: read
await corsair.documenso.api.documents.attachments.find.get({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
GET /document/attachment); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
id: string,
type: link,
label: string,
data: string
}[]
attachments.update.post
documents.attachments.update.post
POST /document/attachment/update — [Deprecated] Update attachment.
Risk: write
await corsair.documenso.api.documents.attachments.update.post({
id: 'sample',
data: { label: 'sample', data: 'https://documenso.invalid/resource' },
});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
data | object | Yes | — |
POST /document/attachment/update); use the corresponding envelope-based operation for new integrations.
data full type
data full type
{
label: string,
data: string
}
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
create.post
documents.create.post
POST /document/create — [Deprecated] Create document.
Risk: write
await corsair.documenso.api.documents.create.post({
payload: { title: 'sample' },
file: { filename: 'contract.pdf', contentType: 'application/pdf', contentBase64: 'JVBERi0xLjQK' },
});
| Name | Type | Required | Description |
|---|---|---|---|
payload | object | Yes | — |
file | object | Yes | — |
POST /document/create); use the corresponding envelope-based operation for new integrations.
payload full type
payload full type
{
title: string,
externalId?: string,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
formValues?: {
},
folderId?: string,
recipients?: {
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[],
fields?: (
{
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
}[],
attachments?: {
label: string,
data: string,
type?: link
}[],
meta?: {
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null,
reminderSettings?: {
sendAfter: {
unit: day | week | month,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month,
amount: number
} | {
disabled: true
}
} | null
}
}
file full type
file full type
{
filename: string,
contentType: string,
contentBase64: string
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
id | number | Yes | — |
createV0.post
documents.createV0.post
POST /document/create/beta — [Deprecated] Create document.
Risk: write
await corsair.documenso.api.documents.createV0.post({ title: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | — |
externalId | string | No | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | No | — |
globalAccessAuth | (ACCOUNT | TWO_FACTOR_AUTH)[] | No | — |
globalActionAuth | (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[] | No | — |
formValues | object | No | — |
folderId | string | No | — |
recipients | object[] | No | — |
attachments | object[] | No | — |
meta | object | No | — |
POST /document/create/beta); use the corresponding envelope-based operation for new integrations.
formValues full type
formValues full type
{
}
recipients full type
recipients full type
{
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[],
fields?: (
{
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
}[]
attachments full type
attachments full type
{
label: string,
data: string,
type?: link
}[]
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null,
reminderSettings?: {
sendAfter: {
unit: day | week | month,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month,
amount: number
} | {
disabled: true
}
} | null
}
| Name | Type | Required | Description |
|---|---|---|---|
document | object | Yes | — |
uploadUrl | string | Yes | — |
document full type
document full type
{
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
status: DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string,
source: DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string,
id: number,
externalId: string | null,
userId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
formValues: {
} | null,
title: string,
createdAt: string,
updatedAt: string,
completedAt: string | null,
deletedAt: string | null,
teamId: number,
folderId: string | null,
envelopeId: string,
internalVersion: number,
templateId?: number | null,
documentDataId: string,
documentData: {
type: S3_PATH | BYTES | BYTES_64 | string,
id: string,
data: string,
initialData: string,
envelopeItemId: string
},
documentMeta: {
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string,
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
redirectUrl: string | null,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
envelopeExpirationPeriod: {
unit: day | week | month | year | string,
amount: number
} | {
disabled: true
} | null,
reminderSettings: {
sendAfter: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
}
} | null,
password: string | null,
documentId?: number
},
envelopeItems: {
id: string,
envelopeId: string
}[],
folder: {
id: string,
name: string,
type: DOCUMENT | TEMPLATE | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
userId: number,
teamId: number,
pinned: boolean,
parentId: string | null,
createdAt: string,
updatedAt: string
} | null,
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
}
delete.post
documents.delete.post
POST /document/delete — [Deprecated] Delete document.
Risk: destructive
await corsair.documenso.api.documents.delete.post({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
POST /document/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
distribute.post
documents.distribute.post
POST /document/distribute — [Deprecated] Distribute document.
Risk: destructive
await corsair.documenso.api.documents.distribute.post({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
meta | object | No | — |
POST /document/distribute); use the corresponding envelope-based operation for new integrations.
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
}
}
| Name | Type | Required | Description |
|---|---|---|---|
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
userId | number | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
title | string | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
useLegacyFieldInsertion | boolean | Yes | — |
envelopeId | string | Yes | — |
internalVersion | number | Yes | — |
documentDataId | string | Yes | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
documentDownload.get
documents.documentDownload.get
GET /document/{documentId}/download-beta — [Deprecated] Download document (beta).
Risk: read
await corsair.documenso.api.documents.documentDownload.get({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
version | original | signed | No | — |
GET /document/{documentId}/download-beta); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
downloadUrl | string | Yes | — |
filename | string | Yes | — |
contentType | string | Yes | — |
download.get
documents.download.get
GET /document/{documentId}/download — [Deprecated] Download document.
Risk: read
await corsair.documenso.api.documents.download.get({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
version | original | signed | No | — |
GET /document/{documentId}/download); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
kind | binary | Yes | — |
contentType | application/pdf | Yes | — |
base64 | string | Yes | — |
size | number | Yes | — |
duplicate.post
documents.duplicate.post
POST /document/duplicate — [Deprecated] Duplicate document.
Risk: write
await corsair.documenso.api.documents.duplicate.post({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
POST /document/duplicate); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
documentId | number | Yes | — |
fields.create.post
documents.fields.create.post
POST /document/field/create — [Deprecated] Create document field.
Risk: write
await corsair.documenso.api.documents.fields.create.post({
documentId: 1,
field: {
type: 'SIGNATURE',
recipientId: 1,
pageNumber: 1,
pageX: 0,
pageY: 0,
width: 1,
height: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
field | object | Yes | — |
POST /document/field/create); use the corresponding envelope-based operation for new integrations.
field full type
field full type
{
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.createMany.post
documents.fields.createMany.post
POST /document/field/create-many — [Deprecated] Create document fields.
Risk: write
await corsair.documenso.api.documents.fields.createMany.post({
documentId: 1,
fields: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
fields | object[] | Yes | — |
POST /document/field/create-many); use the corresponding envelope-based operation for new integrations.
fields full type
fields full type
(
{
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
fields | object[] | Yes | — |
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
fields.delete.post
documents.fields.delete.post
POST /document/field/delete — [Deprecated] Delete document field.
Risk: destructive
await corsair.documenso.api.documents.fields.delete.post({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
POST /document/field/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
fields.get.get
documents.fields.get.get
GET /document/field/{fieldId} — [Deprecated] Get document field.
Risk: read
await corsair.documenso.api.documents.fields.get.get({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
GET /document/field/{fieldId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.update.post
documents.fields.update.post
POST /document/field/update — [Deprecated] Update document field.
Risk: write
await corsair.documenso.api.documents.fields.update.post({
documentId: 1,
field: { type: 'SIGNATURE', id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
field | object | Yes | — |
POST /document/field/update); use the corresponding envelope-based operation for new integrations.
field full type
field full type
{
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: FREE_SIGNATURE
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.updateMany.post
documents.fields.updateMany.post
POST /document/field/update-many — [Deprecated] Update document fields.
Risk: write
await corsair.documenso.api.documents.fields.updateMany.post({
documentId: 1,
fields: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
fields | object[] | Yes | — |
POST /document/field/update-many); use the corresponding envelope-based operation for new integrations.
fields full type
fields full type
(
{
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: FREE_SIGNATURE
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
fields | object[] | Yes | — |
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
find.get
documents.find.get
GET /document — [Deprecated] Find documents.
Risk: read
await corsair.documenso.api.documents.find.get({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | — |
page | number | No | — |
perPage | number | No | — |
templateId | number | No | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | No | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | No | — |
hasExpiredRecipients | true | false | No | — |
folderId | string | No | — |
orderByColumn | createdAt | No | — |
orderByDirection | asc | desc | No | — |
GET /document); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
count | number | Yes | — |
currentPage | number | Yes | — |
perPage | number | Yes | — |
totalPages | number | Yes | — |
data full type
data full type
{
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
status: DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string,
source: DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string,
id: number,
externalId: string | null,
userId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
formValues: {
} | null,
title: string,
createdAt: string,
updatedAt: string,
completedAt: string | null,
deletedAt: string | null,
teamId: number,
folderId: string | null,
useLegacyFieldInsertion: boolean,
envelopeId: string,
internalVersion: number,
documentDataId: string,
templateId?: number | null,
user: {
id: number,
name: string | null,
email: string
},
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
team: {
id: number,
url: string
} | null
}[]
get.get
documents.get.get
GET /document/{documentId} — [Deprecated] Get document.
Risk: read
await corsair.documenso.api.documents.get.get({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
GET /document/{documentId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
userId | number | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
title | string | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
envelopeId | string | Yes | — |
internalVersion | number | Yes | — |
templateId | number | null | No | — |
documentDataId | string | Yes | — |
documentData | object | Yes | — |
documentMeta | object | Yes | — |
envelopeItems | object[] | Yes | — |
folder | object | null | Yes | — |
recipients | object[] | Yes | — |
fields | object[] | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
documentData full type
documentData full type
{
type: S3_PATH | BYTES | BYTES_64 | string,
id: string,
data: string,
initialData: string,
envelopeItemId: string
}
documentMeta full type
documentMeta full type
{
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string,
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
redirectUrl: string | null,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
envelopeExpirationPeriod: {
unit: day | week | month | year | string,
amount: number
} | {
disabled: true
} | null,
reminderSettings: {
sendAfter: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
}
} | null,
password: string | null,
documentId?: number
}
envelopeItems full type
envelopeItems full type
{
id: string,
envelopeId: string
}[]
folder full type
folder full type
{
id: string,
name: string,
type: DOCUMENT | TEMPLATE | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
userId: number,
teamId: number,
pinned: boolean,
parentId: string | null,
createdAt: string,
updatedAt: string
} | null
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
getMany.post
documents.getMany.post
POST /document/get-many — [Deprecated] Get multiple documents.
Risk: read
await corsair.documenso.api.documents.getMany.post({
documentIds: [1],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentIds | number[] | Yes | — |
POST /document/get-many); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
status: DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string,
source: DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string,
id: number,
externalId: string | null,
userId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
formValues: {
} | null,
title: string,
createdAt: string,
updatedAt: string,
completedAt: string | null,
deletedAt: string | null,
teamId: number,
folderId: string | null,
useLegacyFieldInsertion: boolean,
envelopeId: string,
internalVersion: number,
documentDataId: string,
templateId?: number | null,
user: {
id: number,
name: string | null,
email: string
},
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
team: {
id: number,
url: string
} | null
}[]
recipients.create.post
documents.recipients.create.post
POST /document/recipient/create — [Deprecated] Create document recipient.
Risk: write
await corsair.documenso.api.documents.recipients.create.post({
documentId: 1,
recipient: { email: 'signer@documenso.invalid', name: 'sample', role: 'CC' },
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
recipient | object | Yes | — |
POST /document/recipient/create); use the corresponding envelope-based operation for new integrations.
recipient full type
recipient full type
{
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
recipients.createMany.post
documents.recipients.createMany.post
POST /document/recipient/create-many — [Deprecated] Create document recipients.
Risk: write
await corsair.documenso.api.documents.recipients.createMany.post({
documentId: 1,
recipients: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
recipients | object[] | Yes | — |
POST /document/recipient/create-many); use the corresponding envelope-based operation for new integrations.
recipients full type
recipients full type
{
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.delete.post
documents.recipients.delete.post
POST /document/recipient/delete — [Deprecated] Delete document recipient.
Risk: destructive
await corsair.documenso.api.documents.recipients.delete.post({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
POST /document/recipient/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
recipients.get.get
documents.recipients.get.get
GET /document/recipient/{recipientId} — [Deprecated] Get document recipient.
Risk: read
await corsair.documenso.api.documents.recipients.get.get({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
GET /document/recipient/{recipientId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.update.post
documents.recipients.update.post
POST /document/recipient/update — [Deprecated] Update document recipient.
Risk: write
await corsair.documenso.api.documents.recipients.update.post({
documentId: 1,
recipient: { id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
recipient | object | Yes | — |
POST /document/recipient/update); use the corresponding envelope-based operation for new integrations.
recipient full type
recipient full type
{
id: number,
email?: string,
name?: string,
role?: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.updateMany.post
documents.recipients.updateMany.post
POST /document/recipient/update-many — [Deprecated] Update document recipients.
Risk: write
await corsair.documenso.api.documents.recipients.updateMany.post({
documentId: 1,
recipients: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
recipients | object[] | Yes | — |
POST /document/recipient/update-many); use the corresponding envelope-based operation for new integrations.
recipients full type
recipients full type
{
id: number,
email?: string,
name?: string,
role?: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[],
documentId?: number | null,
templateId?: number | null
}[]
redistribute.post
documents.redistribute.post
POST /document/redistribute — [Deprecated] Redistribute document.
Risk: destructive
await corsair.documenso.api.documents.redistribute.post({
documentId: 1,
recipients: [1],
});
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
recipients | number[] | Yes | — |
POST /document/redistribute); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
update.post
documents.update.post
POST /document/update — [Deprecated] Update document.
Risk: write
await corsair.documenso.api.documents.update.post({ documentId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
documentId | number | Yes | — |
data | object | No | — |
meta | object | No | — |
POST /document/update); use the corresponding envelope-based operation for new integrations.
data full type
data full type
{
title?: string,
externalId?: string | null,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
useLegacyFieldInsertion?: boolean,
folderId?: string | null
}
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null,
reminderSettings?: {
sendAfter: {
unit: day | week | month,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month,
amount: number
} | {
disabled: true
}
} | null
}
| Name | Type | Required | Description |
|---|---|---|---|
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
userId | number | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
title | string | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
useLegacyFieldInsertion | boolean | Yes | — |
envelopeId | string | Yes | — |
internalVersion | number | Yes | — |
documentDataId | string | Yes | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
Embedding
presignCreateEmbeddingPresignToken.post
embedding.presignCreateEmbeddingPresignToken.post
POST /embedding/create-presign-token — Create embedding presign token.
Risk: write
await corsair.documenso.api.embedding.presignCreateEmbeddingPresignToken.post({});
| Name | Type | Required | Description |
|---|---|---|---|
expiresIn | number | No | — |
scope | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
token | string | Yes | — |
expiresAt | string | Yes | — |
expiresIn | number | Yes | — |
presignVerifyEmbeddingPresignToken.post
embedding.presignVerifyEmbeddingPresignToken.post
POST /embedding/verify-presign-token — Verify embedding presign token.
Risk: read
await corsair.documenso.api.embedding.presignVerifyEmbeddingPresignToken.post({ token: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
token | string | Yes | — |
scope | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
Envelopes
attachments.create.post
envelopes.attachments.create.post
POST /envelope/attachment/create — Create attachment.
Risk: write
await corsair.documenso.api.envelopes.attachments.create.post({
envelopeId: 'sample',
data: { label: 'sample', data: 'https://documenso.invalid/resource' },
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object | Yes | — |
data full type
data full type
{
label: string,
data: string
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
attachments.delete.post
envelopes.attachments.delete.post
POST /envelope/attachment/delete — Delete attachment.
Risk: destructive
await corsair.documenso.api.envelopes.attachments.delete.post({ id: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
attachments.find.get
envelopes.attachments.find.get
GET /envelope/attachment — Find attachments.
Risk: read
await corsair.documenso.api.envelopes.attachments.find.get({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
token | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
id: string,
type: link,
label: string,
data: string
}[]
attachments.update.post
envelopes.attachments.update.post
POST /envelope/attachment/update — Update attachment.
Risk: write
await corsair.documenso.api.envelopes.attachments.update.post({
id: 'sample',
data: { label: 'sample', data: 'https://documenso.invalid/resource' },
});
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
data | object | Yes | — |
data full type
data full type
{
label: string,
data: string
}
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
auditLogDownloadPdf.get
envelopes.auditLogDownloadPdf.get
GET /envelope/{envelopeId}/audit-log/download — Download envelope audit log PDF.
Risk: read
await corsair.documenso.api.envelopes.auditLogDownloadPdf.get({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | binary | Yes | — |
contentType | application/pdf | Yes | — |
base64 | string | Yes | — |
size | number | Yes | — |
auditLogFind.get
envelopes.auditLogFind.get
GET /envelope/{envelopeId}/audit-log — Get envelope audit logs.
Risk: read
await corsair.documenso.api.envelopes.auditLogFind.get({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
page | number | No | — |
perPage | number | No | — |
orderByColumn | createdAt | No | — |
orderByDirection | asc | desc | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
count | number | Yes | — |
currentPage | number | Yes | — |
perPage | number | Yes | — |
totalPages | number | Yes | — |
data full type
data full type
(
{
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: ENVELOPE_ITEM_CREATED,
data: {
envelopeItemId: string,
envelopeItemTitle: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: ENVELOPE_ITEM_DELETED,
data: {
envelopeItemId: string,
envelopeItemTitle: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: ENVELOPE_ITEM_UPDATED,
data: {
envelopeItemId: string,
changes: {
field: string,
from: string,
to: string
}[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: ENVELOPE_ITEM_PDF_REPLACED,
data: {
envelopeItemId: string,
envelopeItemTitle: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: EMAIL_SENT,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
emailType: SIGNING_REQUEST | VIEW_REQUEST | APPROVE_REQUEST | ASSISTING_REQUEST | CC | DOCUMENT_COMPLETED | REMINDER | string,
isResending: boolean
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_COMPLETED,
data: {
transactionId: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_CREATED,
data: {
title: string,
source?: {
type: DOCUMENT
} | {
type: TEMPLATE,
templateId: number
} | {
type: TEMPLATE_DIRECT_LINK,
templateId: number,
directRecipientEmail: string
}
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_DELETED,
data: {
type: SOFT | HARD | string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_CANCELLED,
data: {
reason?: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_MOVED_TO_TEAM,
data: {
movedByUserId: number,
fromPersonalAccount: boolean,
toTeamId: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_DELEGATED_OWNER_CREATED,
data: {
delegatedOwnerName: string | null,
delegatedOwnerEmail: string,
teamName: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_FIELDS_AUTO_INSERTED,
data: {
fields: {
fieldId: number,
fieldType: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
recipientId: number
}[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_FIELD_INSERTED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
fieldId: string,
field: {
type: INITIALS,
data: string
} | {
type: EMAIL,
data: string
} | {
type: DATE,
data: string
} | {
type: NAME,
data: string
} | {
type: TEXT,
data: string
} | {
type: SIGNATURE | FREE_SIGNATURE,
data: string
} | {
type: RADIO,
data: string
} | {
type: CHECKBOX,
data: string
} | {
type: DROPDOWN,
data: string
} | {
type: NUMBER,
data: string
},
fieldSecurity?: {
type?: ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string
}
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_FIELD_UNINSERTED,
data: {
field: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
fieldId: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_FIELD_PREFILLED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
fieldId: string,
field: {
type: INITIALS,
data: string
} | {
type: EMAIL,
data: string
} | {
type: DATE,
data: string
} | {
type: NAME,
data: string
} | {
type: TEXT,
data: string
} | {
type: SIGNATURE | FREE_SIGNATURE,
data: string
} | {
type: RADIO,
data: string
} | {
type: CHECKBOX,
data: string
} | {
type: DROPDOWN,
data: string
} | {
type: NUMBER,
data: string
},
fieldSecurity?: {
type?: ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string
}
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_VISIBILITY_UPDATED,
data: {
from: string | string[] | null,
to: string | string[] | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_GLOBAL_AUTH_ACCESS_UPDATED,
data: {
from: string | string[] | null,
to: string | string[] | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_GLOBAL_AUTH_ACTION_UPDATED,
data: {
from: string | string[] | null,
to: string | string[] | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_META_UPDATED,
data: {
changes: (
{
type: DATE_FORMAT | MESSAGE | REDIRECT_URL | SUBJECT | TIMEZONE | EMAIL_ID | EMAIL_REPLY_TO | EMAIL_SETTINGS,
from: string | null,
to: string | null
} | {
type: PASSWORD
}
)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_OPENED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_VIEWED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_COMPLETED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_REJECTED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
reason: string,
isExternal?: boolean,
onBehalfOfUserEmail?: string,
onBehalfOfUserName?: string | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_ACCESS_AUTH_2FA_REQUESTED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_ACCESS_AUTH_2FA_VALIDATED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_ACCESS_AUTH_2FA_FAILED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_SENT,
data: {
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_TITLE_UPDATED,
data: {
from: string,
to: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_EXTERNAL_ID_UPDATED,
data: {
from?: string | null,
to?: string | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: FIELD_CREATED,
data: {
fieldId: string,
fieldRecipientEmail: string,
fieldRecipientId: number,
fieldType: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: FIELD_DELETED,
data: {
fieldId: string,
fieldRecipientEmail: string,
fieldRecipientId: number,
fieldType: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: FIELD_UPDATED,
data: {
fieldId: string,
fieldRecipientEmail: string,
fieldRecipientId: number,
fieldType: string,
changes: (
{
type: DIMENSION,
from: {
width: number,
height: number
},
to: {
width: number,
height: number
}
} | {
type: POSITION,
from: {
page: number,
positionX: number,
positionY: number
},
to: {
page: number,
positionX: number,
positionY: number
}
}
)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: RECIPIENT_CREATED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: RECIPIENT_UPDATED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
changes: (
{
from: string | string[] | null,
to: string | string[] | null,
type: ACTION_AUTH
} | {
from: string | string[] | null,
to: string | string[] | null,
type: ACCESS_AUTH
} | {
from: string | string[] | null,
to: string | string[] | null,
type: NAME
} | {
from: string | string[] | null,
to: string | string[] | null,
type: ROLE
} | {
from: string | string[] | null,
to: string | string[] | null,
type: EMAIL
}
)[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: RECIPIENT_DELETED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_EXPIRED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_CSC_AUTHENTICATED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
providerId: string,
credentialId: string,
signatureAlgorithm: string,
digestAlgorithm: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_CSC_AUTHENTICATION_FAILED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
providerId: string,
reason: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_CSC_SIGN_REQUESTED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
providerId: string,
credentialId: string,
sessionId: string,
numSignatures: number
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_CSC_AUTHORIZED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
providerId: string,
credentialId: string,
sessionId: string,
sadExpiresAt: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: DOCUMENT_RECIPIENT_CSC_SIGNED,
data: {
recipientEmail: string,
recipientName: string,
recipientId: number,
recipientRole: string,
providerId: string,
credentialId: string,
sessionId: string,
numItemsSigned: number,
signatureAlgorithm: string,
digestAlgorithm: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: CONTENT_CREATED,
data: {
contentId: string,
contentType: string,
envelopeItemId: string,
contentMeta: Record<string, any>,
dataContentId: string | null
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: CONTENT_DELETED,
data: {
contentId: string,
contentType: string,
envelopeItemId: string
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: CONTENT_UPDATED,
data: {
contentId: string,
contentType: string,
envelopeItemId: string,
changes: {
type: PROPERTY | string,
key: string,
from: string | number | boolean | null,
to: string | number | boolean | null
}[]
}
} | {
id: string,
createdAt: string,
envelopeId: string,
name?: string | null,
email?: string | null,
userId?: number | null,
userAgent?: string | null,
ipAddress?: string | null,
type: string,
data?: Record<string, any>
}
)[]
cancel.post
envelopes.cancel.post
POST /envelope/cancel — Cancel envelope.
Risk: destructive
await corsair.documenso.api.envelopes.cancel.post({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
reason | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
certificateDownloadPdf.get
envelopes.certificateDownloadPdf.get
GET /envelope/{envelopeId}/certificate/download — Download envelope certificate PDF.
Risk: read
await corsair.documenso.api.envelopes.certificateDownloadPdf.get({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | binary | Yes | — |
contentType | application/pdf | Yes | — |
base64 | string | Yes | — |
size | number | Yes | — |
create.post
envelopes.create.post
POST /envelope/create — Create envelope.
Risk: write
await corsair.documenso.api.envelopes.create.post({
payload: { title: 'sample', type: 'DOCUMENT' },
files: [{ filename: 'contract.pdf', contentType: 'application/pdf', contentBase64: 'JVBERi0xLjQK' }],
});
| Name | Type | Required | Description |
|---|---|---|---|
payload | object | Yes | — |
files | object[] | No | — |
payload full type
payload full type
{
title: string,
type: DOCUMENT | TEMPLATE,
delegatedDocumentOwner?: string,
externalId?: string,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
formValues?: {
},
folderId?: string,
recipients?: {
email: "" | string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[],
fields?: (
{
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
identifier?: string | number,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
}[],
meta?: {
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null,
reminderSettings?: {
sendAfter: {
unit: day | week | month,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month,
amount: number
} | {
disabled: true
}
} | null
},
attachments?: {
label: string,
data: string,
type?: link
}[]
}
files full type
files full type
{
filename: string,
contentType: string,
contentBase64: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
delete.post
envelopes.delete.post
POST /envelope/delete — Delete envelope.
Risk: destructive
await corsair.documenso.api.envelopes.delete.post({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
distribute.post
envelopes.distribute.post
POST /envelope/distribute — Distribute envelope.
Risk: destructive
await corsair.documenso.api.envelopes.distribute.post({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
meta | object | No | — |
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null
}
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
id | string | Yes | — |
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
id: number,
name: string,
email: string,
token: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
signingOrder: number | null,
signingUrl: string
}[]
duplicate.post
envelopes.duplicate.post
POST /envelope/duplicate — Duplicate envelope.
Risk: write
await corsair.documenso.api.envelopes.duplicate.post({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
includeRecipients | boolean | No | — |
includeFields | boolean | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
fields.createMany.post
envelopes.fields.createMany.post
POST /envelope/field/create-many — Create envelope fields.
Risk: write
await corsair.documenso.api.envelopes.fields.createMany.post({
envelopeId: 'sample',
data: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object[] | Yes | — |
data full type
data full type
(
{
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
envelopeItemId?: string,
page: number,
positionX: number,
positionY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: FREE_SIGNATURE
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
envelopeItemId?: string,
placeholder: string,
width?: number,
height?: number,
matchAll?: boolean,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
fields.delete.post
envelopes.fields.delete.post
POST /envelope/field/delete — Delete envelope field.
Risk: destructive
await corsair.documenso.api.envelopes.fields.delete.post({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
fields.get.get
envelopes.fields.get.get
GET /envelope/field/{fieldId} — Get envelope field.
Risk: read
await corsair.documenso.api.envelopes.fields.get.get({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.updateMany.post
envelopes.fields.updateMany.post
POST /envelope/field/update-many — Update envelope fields.
Risk: write
await corsair.documenso.api.envelopes.fields.updateMany.post({
envelopeId: 'sample',
data: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object[] | Yes | — |
data full type
data full type
(
{
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: FREE_SIGNATURE
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
id: number,
envelopeItemId?: string,
page?: number,
positionX?: number,
positionY?: number,
width?: number,
height?: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
find.get
envelopes.find.get
GET /envelope — Find envelopes.
Risk: read
await corsair.documenso.api.envelopes.find.get({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | — |
page | number | No | — |
perPage | number | No | — |
type | DOCUMENT | TEMPLATE | No | — |
templateId | number | No | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | No | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | No | — |
hasExpiredRecipients | true | false | No | — |
folderId | string | No | — |
orderByColumn | createdAt | No | — |
orderByDirection | asc | desc | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
count | number | Yes | — |
currentPage | number | Yes | — |
perPage | number | Yes | — |
totalPages | number | Yes | — |
data full type
data full type
{
internalVersion: number,
type: DOCUMENT | TEMPLATE | string,
status: DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string,
source: DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
templateType: PUBLIC | PRIVATE | ORGANISATION | string,
id: string,
secondaryId: string,
externalId: string | null,
createdAt: string,
updatedAt: string,
completedAt: string | null,
deletedAt: string | null,
title: string,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
formValues: {
} | null,
publicTitle: string,
publicDescription: string,
userId: number,
teamId: number,
folderId: string | null,
templateId: number | null,
user: {
id: number,
name: string,
email: string
},
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null
}[],
team: {
id: number,
url: string
} | null
}[]
get.get
envelopes.get.get
GET /envelope/{envelopeId} — Get envelope.
Risk: read
await corsair.documenso.api.envelopes.get.get({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
internalVersion | number | Yes | — |
type | DOCUMENT | TEMPLATE | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
templateType | PUBLIC | PRIVATE | ORGANISATION | string | Yes | — |
id | string | Yes | — |
secondaryId | string | Yes | — |
externalId | string | null | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
title | string | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
publicTitle | string | Yes | — |
publicDescription | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
templateId | number | null | Yes | — |
documentMeta | object | Yes | — |
recipients | object[] | Yes | — |
fields | object[] | Yes | — |
envelopeItems | object[] | Yes | — |
directLink | object | null | Yes | — |
team | object | Yes | — |
user | object | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
documentMeta full type
documentMeta full type
{
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string,
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
redirectUrl: string | null,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
envelopeExpirationPeriod: {
unit: day | week | month | year | string,
amount: number
} | {
disabled: true
} | null
}
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null
}[]
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
}[]
envelopeItems full type
envelopeItems full type
{
envelopeId: string,
documentDataId: string,
id: string,
title: string,
order: number
}[]
directLink full type
directLink full type
{
directTemplateRecipientId: number,
enabled: boolean,
id: string,
token: string
} | null
team full type
team full type
{
id: number,
url: string
}
user full type
user full type
{
id: number,
name: string,
email: string
}
getMany.post
envelopes.getMany.post
POST /envelope/get-many — Get multiple envelopes.
Risk: read
await corsair.documenso.api.envelopes.getMany.post({
ids: {
type: 'envelopeId',
ids: ['sample'],
},
});
| Name | Type | Required | Description |
|---|---|---|---|
ids | object | Yes | — |
ids full type
ids full type
{
type: envelopeId,
ids: string[]
} | {
type: documentId,
ids: number[]
} | {
type: templateId,
ids: number[]
}
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
internalVersion: number,
type: DOCUMENT | TEMPLATE | string,
status: DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string,
source: DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
templateType: PUBLIC | PRIVATE | ORGANISATION | string,
id: string,
secondaryId: string,
externalId: string | null,
createdAt: string,
updatedAt: string,
completedAt: string | null,
deletedAt: string | null,
title: string,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
formValues: {
} | null,
publicTitle: string,
publicDescription: string,
userId: number,
teamId: number,
folderId: string | null,
templateId: number | null,
documentMeta: {
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string,
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
redirectUrl: string | null,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
envelopeExpirationPeriod: {
unit: day | week | month | year | string,
amount: number
} | {
disabled: true
} | null
},
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null
}[],
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
}[],
envelopeItems: {
envelopeId: string,
documentDataId: string,
id: string,
title: string,
order: number
}[],
directLink: {
directTemplateRecipientId: number,
enabled: boolean,
id: string,
token: string
} | null,
team: {
id: number,
url: string
},
user: {
id: number,
name: string,
email: string
}
}[]
items.createMany.post
envelopes.items.createMany.post
POST /envelope/item/create-many — Create envelope items.
Risk: write
await corsair.documenso.api.envelopes.items.createMany.post({
payload: { envelopeId: 'sample' },
files: [{ filename: 'contract.pdf', contentType: 'application/pdf', contentBase64: 'JVBERi0xLjQK' }],
});
| Name | Type | Required | Description |
|---|---|---|---|
payload | object | Yes | — |
files | object[] | No | — |
payload full type
payload full type
{
envelopeId: string
}
files full type
files full type
{
filename: string,
contentType: string,
contentBase64: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
id: string,
title: string,
envelopeId: string,
order: number,
documentDataId: string
}[]
items.delete.post
envelopes.items.delete.post
POST /envelope/item/delete — Delete envelope item.
Risk: destructive
await corsair.documenso.api.envelopes.items.delete.post({ envelopeId: 'sample', envelopeItemId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
items.download.get
envelopes.items.download.get
GET /envelope/item/{envelopeItemId}/download — Download an envelope item.
Risk: read
await corsair.documenso.api.envelopes.items.download.get({ envelopeItemId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeItemId | string | Yes | — |
version | original | signed | pending | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
kind | binary | Yes | — |
contentType | application/pdf | Yes | — |
base64 | string | Yes | — |
size | number | Yes | — |
items.updateMany.post
envelopes.items.updateMany.post
POST /envelope/item/update-many — Update envelope items.
Risk: write
await corsair.documenso.api.envelopes.items.updateMany.post({
envelopeId: 'sample',
data: [{ envelopeItemId: 'sample' }],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object[] | Yes | — |
data full type
data full type
{
envelopeItemId: string,
order?: number,
title?: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
id: string,
order: number,
title: string,
envelopeId: string
}[]
recipients.createMany.post
envelopes.recipients.createMany.post
POST /envelope/recipient/create-many — Create envelope recipients.
Risk: write
await corsair.documenso.api.envelopes.recipients.createMany.post({
envelopeId: 'sample',
data: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object[] | Yes | — |
data full type
data full type
{
email: "" | string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null
}[]
recipients.delete.post
envelopes.recipients.delete.post
POST /envelope/recipient/delete — Delete envelope recipient.
Risk: destructive
await corsair.documenso.api.envelopes.recipients.delete.post({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
recipients.get.get
envelopes.recipients.get.get
GET /envelope/recipient/{recipientId} — Get envelope recipient.
Risk: read
await corsair.documenso.api.envelopes.recipients.get.get({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.recipientRejectOnBehalfOf.post
envelopes.recipients.recipientRejectOnBehalfOf.post
POST /envelope/recipient/{recipientId}/reject — Reject envelope recipient on behalf of.
Risk: destructive
await corsair.documenso.api.envelopes.recipients.recipientRejectOnBehalfOf.post({ recipientId: 1, envelopeId: 'sample', reason: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
envelopeId | string | Yes | — |
reason | string | Yes | — |
actAsEmail | string | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.updateMany.post
envelopes.recipients.updateMany.post
POST /envelope/recipient/update-many — Update envelope recipients.
Risk: write
await corsair.documenso.api.envelopes.recipients.updateMany.post({
envelopeId: 'sample',
data: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object[] | Yes | — |
data full type
data full type
{
id: number,
email?: "" | string,
name?: string,
role?: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
redistribute.post
envelopes.redistribute.post
POST /envelope/redistribute — Redistribute envelope.
Risk: destructive
await corsair.documenso.api.envelopes.redistribute.post({
envelopeId: 'sample',
recipients: [1],
});
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
recipients | number[] | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
id | string | Yes | — |
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
id: number,
name: string,
email: string,
token: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
signingOrder: number | null,
signingUrl: string
}[]
update.post
envelopes.update.post
POST /envelope/update — Update envelope.
Risk: write
await corsair.documenso.api.envelopes.update.post({ envelopeId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
data | object | No | — |
meta | object | No | — |
data full type
data full type
{
title?: string,
externalId?: string | null,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
folderId?: string | null,
templateType?: PUBLIC | PRIVATE | ORGANISATION
}
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean,
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
} | null,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null,
reminderSettings?: {
sendAfter: {
unit: day | week | month,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month,
amount: number
} | {
disabled: true
}
} | null
}
| Name | Type | Required | Description |
|---|---|---|---|
internalVersion | number | Yes | — |
type | DOCUMENT | TEMPLATE | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
templateType | PUBLIC | PRIVATE | ORGANISATION | string | Yes | — |
id | string | Yes | — |
secondaryId | string | Yes | — |
externalId | string | null | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
title | string | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
publicTitle | string | Yes | — |
publicDescription | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
use.post
envelopes.use.post
POST /envelope/use — Use envelope.
Risk: destructive
await corsair.documenso.api.envelopes.use.post({
payload: { envelopeId: 'sample' },
files: [{ filename: 'contract.pdf', contentType: 'application/pdf', contentBase64: 'JVBERi0xLjQK' }],
});
| Name | Type | Required | Description |
|---|---|---|---|
payload | object | Yes | — |
files | object[] | No | — |
payload full type
payload full type
{
envelopeId: string,
externalId?: string,
recipients?: {
id: number,
email: "" | string,
name?: string,
signingOrder?: number
}[],
distributeDocument?: boolean,
customDocumentData?: {
identifier: string | number,
envelopeItemId: string
}[],
folderId?: string,
prefillFields?: (
{
id: number,
type: text,
label?: string,
placeholder?: string,
value?: string
} | {
id: number,
type: number,
label?: string,
placeholder?: string,
value?: string
} | {
id: number,
type: radio,
label?: string,
value?: string
} | {
id: number,
type: checkbox,
label?: string,
value?: string[]
} | {
id: number,
type: dropdown,
label?: string,
value?: string
} | {
id: number,
type: date,
value?: string
}
)[],
override?: {
title?: string,
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
redirectUrl?: string,
distributionMethod?: EMAIL | NONE,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
},
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
allowDictateNextSigner?: boolean,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null
},
attachments?: {
label: string,
data: string,
type?: link
}[],
formValues?: {
}
}
files full type
files full type
{
filename: string,
contentType: string,
contentBase64: string
}[]
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
id: number,
name: string,
email: string,
token: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
signingOrder: number | null,
signingUrl: string
}[]
Folders
create.post
folders.create.post
POST /folder/create — Create new folder.
Risk: write
await corsair.documenso.api.folders.create.post({ name: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
name | string | Yes | — |
parentId | string | No | — |
type | DOCUMENT | TEMPLATE | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
parentId | string | null | Yes | — |
pinned | boolean | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
type | DOCUMENT | TEMPLATE | string | Yes | — |
delete.post
folders.delete.post
POST /folder/delete — Delete folder.
Risk: destructive
await corsair.documenso.api.folders.delete.post({ folderId: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | — |
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
find.get
folders.find.get
GET /folder — Find folders.
Risk: read
await corsair.documenso.api.folders.find.get({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | — |
page | number | No | — |
perPage | number | No | — |
parentId | string | No | — |
type | DOCUMENT | TEMPLATE | No | — |
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
count | number | Yes | — |
currentPage | number | Yes | — |
perPage | number | Yes | — |
totalPages | number | Yes | — |
data full type
data full type
{
id: string,
name: string,
userId: number,
teamId: number,
parentId: string | null,
pinned: boolean,
createdAt: string,
updatedAt: string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
type: DOCUMENT | TEMPLATE | string
}[]
update.post
folders.update.post
POST /folder/update — Update folder.
Risk: write
await corsair.documenso.api.folders.update.post({
folderId: 'sample',
data: {},
});
| Name | Type | Required | Description |
|---|---|---|---|
folderId | string | Yes | — |
data | object | Yes | — |
data full type
data full type
{
name?: string,
parentId?: string | null,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
pinned?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
name | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
parentId | string | null | Yes | — |
pinned | boolean | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
type | DOCUMENT | TEMPLATE | string | Yes | — |
Templates
create.post
templates.create.post
POST /template/create — [Deprecated] Create template.
Risk: write
await corsair.documenso.api.templates.create.post({
payload: { title: 'sample' },
file: { filename: 'contract.pdf', contentType: 'application/pdf', contentBase64: 'JVBERi0xLjQK' },
});
| Name | Type | Required | Description |
|---|---|---|---|
payload | object | Yes | — |
file | object | Yes | — |
POST /template/create); use the corresponding envelope-based operation for new integrations.
payload full type
payload full type
{
title: string,
folderId?: string,
externalId?: string | null,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
publicTitle?: string,
publicDescription?: string,
type?: PUBLIC | PRIVATE | ORGANISATION,
meta?: {
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
},
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean
},
attachments?: {
label: string,
data: string,
type?: link
}[]
}
file full type
file full type
{
filename: string,
contentType: string,
contentBase64: string
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
id | number | Yes | — |
createTemplateTemporary.post
templates.createTemplateTemporary.post
POST /template/create/beta — [Deprecated] Create template.
Risk: write
await corsair.documenso.api.templates.createTemplateTemporary.post({ title: 'sample' });
| Name | Type | Required | Description |
|---|---|---|---|
title | string | Yes | — |
folderId | string | No | — |
externalId | string | null | No | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | No | — |
globalAccessAuth | (ACCOUNT | TWO_FACTOR_AUTH)[] | No | — |
globalActionAuth | (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[] | No | — |
publicTitle | string | No | — |
publicDescription | string | No | — |
type | PUBLIC | PRIVATE | ORGANISATION | No | — |
meta | object | No | — |
attachments | object[] | No | — |
POST /template/create/beta); use the corresponding envelope-based operation for new integrations.
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
},
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean
}
attachments full type
attachments full type
{
label: string,
data: string,
type?: link
}[]
| Name | Type | Required | Description |
|---|---|---|---|
template | object | Yes | — |
uploadUrl | string | Yes | — |
template full type
template full type
{
type: PUBLIC | PRIVATE | ORGANISATION | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
id: number,
externalId: string | null,
title: string,
userId: number,
teamId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
createdAt: string,
updatedAt: string,
publicTitle: string,
publicDescription: string,
folderId: string | null,
envelopeId: string,
templateDocumentDataId: string,
templateDocumentData: {
type: S3_PATH | BYTES | BYTES_64 | string,
id: string,
data: string,
initialData: string,
envelopeItemId: string
},
templateMeta: {
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
signingOrder: PARALLEL | SEQUENTIAL | string,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
distributionMethod: EMAIL | NONE | string,
redirectUrl: string | null,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
templateId: number | null
},
directLink: {
id: string,
envelopeId: string,
token: string,
createdAt: string,
enabled: boolean,
directTemplateRecipientId: number,
templateId: number
} | null,
user: {
id: number,
name: string | null,
email: string
},
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[],
folder: {
id: string,
name: string,
type: DOCUMENT | TEMPLATE | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
userId: number,
teamId: number,
pinned: boolean,
parentId: string | null,
createdAt: string,
updatedAt: string
} | null,
envelopeItems: {
id: string,
envelopeId: string
}[]
}
delete.post
templates.delete.post
POST /template/delete — [Deprecated] Delete template.
Risk: destructive
await corsair.documenso.api.templates.delete.post({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
POST /template/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
directLinks.create.post
templates.directLinks.create.post
POST /template/direct/create — [Deprecated] Create direct link.
Risk: write
await corsair.documenso.api.templates.directLinks.create.post({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
directRecipientId | number | No | — |
POST /template/direct/create); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
token | string | Yes | — |
createdAt | string | Yes | — |
enabled | boolean | Yes | — |
directTemplateRecipientId | number | Yes | — |
envelopeId | string | Yes | — |
templateId | number | Yes | — |
directLinks.delete.post
templates.directLinks.delete.post
POST /template/direct/delete — [Deprecated] Delete direct link.
Risk: destructive
await corsair.documenso.api.templates.directLinks.delete.post({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
POST /template/direct/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
directLinks.toggle.post
templates.directLinks.toggle.post
POST /template/direct/toggle — [Deprecated] Toggle direct link.
Risk: write
await corsair.documenso.api.templates.directLinks.toggle.post({ templateId: 1, enabled: false });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
enabled | boolean | Yes | — |
POST /template/direct/toggle); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
id | string | Yes | — |
token | string | Yes | — |
createdAt | string | Yes | — |
enabled | boolean | Yes | — |
directTemplateRecipientId | number | Yes | — |
envelopeId | string | Yes | — |
templateId | number | Yes | — |
duplicate.post
templates.duplicate.post
POST /template/duplicate — [Deprecated] Duplicate template.
Risk: write
await corsair.documenso.api.templates.duplicate.post({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
POST /template/duplicate); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
type | PUBLIC | PRIVATE | ORGANISATION | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
title | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
authOptions | object | null | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
publicTitle | string | Yes | — |
publicDescription | string | Yes | — |
folderId | string | null | Yes | — |
useLegacyFieldInsertion | boolean | Yes | — |
envelopeId | string | Yes | — |
templateDocumentDataId | string | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
fields.create.post
templates.fields.create.post
POST /template/field/create — [Deprecated] Create template field.
Risk: write
await corsair.documenso.api.templates.fields.create.post({
templateId: 1,
field: {
type: 'SIGNATURE',
recipientId: 1,
pageNumber: 1,
pageX: 0,
pageY: 0,
width: 1,
height: 1,
},
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
field | object | Yes | — |
POST /template/field/create); use the corresponding envelope-based operation for new integrations.
field full type
field full type
{
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.createMany.post
templates.fields.createMany.post
POST /template/field/create-many — [Deprecated] Create template fields.
Risk: write
await corsair.documenso.api.templates.fields.createMany.post({
templateId: 1,
fields: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
fields | object[] | Yes | — |
POST /template/field/create-many); use the corresponding envelope-based operation for new integrations.
fields full type
fields full type
(
{
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: FREE_SIGNATURE
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
recipientId: number,
pageNumber: number,
pageX: number,
pageY: number,
width: number,
height: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
fields | object[] | Yes | — |
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
fields.delete.post
templates.fields.delete.post
POST /template/field/delete — [Deprecated] Delete template field.
Risk: destructive
await corsair.documenso.api.templates.fields.delete.post({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
POST /template/field/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
fields.get.get
templates.fields.get.get
GET /template/field/{fieldId} — [Deprecated] Get template field.
Risk: read
await corsair.documenso.api.templates.fields.get.get({ fieldId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
fieldId | number | Yes | — |
GET /template/field/{fieldId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.update.post
templates.fields.update.post
POST /template/field/update — [Deprecated] Update template field.
Risk: write
await corsair.documenso.api.templates.fields.update.post({
templateId: 1,
field: { type: 'SIGNATURE', id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
field | object | Yes | — |
POST /template/field/update); use the corresponding envelope-based operation for new integrations.
field full type
field full type
{
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: FREE_SIGNATURE
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
envelopeItemId | string | Yes | — |
type | SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string | Yes | — |
id | number | Yes | — |
secondaryId | string | Yes | — |
recipientId | number | Yes | — |
page | number | Yes | — |
positionX | any | Yes | — |
positionY | any | Yes | — |
width | any | Yes | — |
height | any | Yes | — |
customText | string | Yes | — |
inserted | boolean | Yes | — |
fieldMeta | object | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
fieldMeta full type
fieldMeta full type
{
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null
fields.updateMany.post
templates.fields.updateMany.post
POST /template/field/update-many — [Deprecated] Update template fields.
Risk: write
await corsair.documenso.api.templates.fields.updateMany.post({
templateId: 1,
fields: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
fields | object[] | Yes | — |
POST /template/field/update-many); use the corresponding envelope-based operation for new integrations.
fields full type
fields full type
(
{
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: SIGNATURE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: signature
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: FREE_SIGNATURE
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: INITIALS,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: initials,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NAME,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: name,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: EMAIL,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: email,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DATE,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: date,
textAlign?: left | center | right
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: TEXT,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: NUMBER,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: RADIO,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: CHECKBOX,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction?: vertical | horizontal
}
} | {
id: number,
pageNumber?: number,
pageX?: number,
pageY?: number,
width?: number,
height?: number,
type: DROPDOWN,
fieldMeta?: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
}
}
)[]
| Name | Type | Required | Description |
|---|---|---|---|
fields | object[] | Yes | — |
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
find.get
templates.find.get
GET /template — [Deprecated] Find templates.
Risk: read
await corsair.documenso.api.templates.find.get({});
| Name | Type | Required | Description |
|---|---|---|---|
query | string | No | — |
page | number | No | — |
perPage | number | No | — |
type | PUBLIC | PRIVATE | ORGANISATION | No | — |
folderId | string | No | — |
GET /template); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
count | number | Yes | — |
currentPage | number | Yes | — |
perPage | number | Yes | — |
totalPages | number | Yes | — |
data full type
data full type
{
type: PUBLIC | PRIVATE | ORGANISATION | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
id: number,
externalId: string | null,
title: string,
userId: number,
teamId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
createdAt: string,
updatedAt: string,
publicTitle: string,
publicDescription: string,
folderId: string | null,
useLegacyFieldInsertion: boolean,
envelopeId: string,
team: {
id: number,
url: string,
name: string
} | null,
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[],
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
templateMeta: {
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string
} | null,
directLink: {
token: string,
enabled: boolean
} | null,
templateDocumentDataId: string
}[]
get.get
templates.get.get
GET /template/{templateId} — [Deprecated] Get template.
Risk: read
await corsair.documenso.api.templates.get.get({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
GET /template/{templateId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
type | PUBLIC | PRIVATE | ORGANISATION | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
title | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
authOptions | object | null | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
publicTitle | string | Yes | — |
publicDescription | string | Yes | — |
folderId | string | null | Yes | — |
envelopeId | string | Yes | — |
templateDocumentDataId | string | Yes | — |
templateDocumentData | object | Yes | — |
templateMeta | object | Yes | — |
directLink | object | null | Yes | — |
user | object | Yes | — |
recipients | object[] | Yes | — |
fields | object[] | Yes | — |
folder | object | null | Yes | — |
envelopeItems | object[] | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
templateDocumentData full type
templateDocumentData full type
{
type: S3_PATH | BYTES | BYTES_64 | string,
id: string,
data: string,
initialData: string,
envelopeItemId: string
}
templateMeta full type
templateMeta full type
{
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
signingOrder: PARALLEL | SEQUENTIAL | string,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
distributionMethod: EMAIL | NONE | string,
redirectUrl: string | null,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
templateId: number | null
}
directLink full type
directLink full type
{
id: string,
envelopeId: string,
token: string,
createdAt: string,
enabled: boolean,
directTemplateRecipientId: number,
templateId: number
} | null
user full type
user full type
{
id: number,
name: string | null,
email: string
}
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
folder full type
folder full type
{
id: string,
name: string,
type: DOCUMENT | TEMPLATE | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
userId: number,
teamId: number,
pinned: boolean,
parentId: string | null,
createdAt: string,
updatedAt: string
} | null
envelopeItems full type
envelopeItems full type
{
id: string,
envelopeId: string
}[]
getMany.post
templates.getMany.post
POST /template/get-many — [Deprecated] Get multiple templates.
Risk: read
await corsair.documenso.api.templates.getMany.post({
templateIds: [1],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateIds | number[] | Yes | — |
POST /template/get-many); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
data | object[] | Yes | — |
data full type
data full type
{
type: PUBLIC | PRIVATE | ORGANISATION | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
id: number,
externalId: string | null,
title: string,
userId: number,
teamId: number,
authOptions: {
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null,
createdAt: string,
updatedAt: string,
publicTitle: string,
publicDescription: string,
folderId: string | null,
useLegacyFieldInsertion: boolean,
envelopeId: string,
team: {
id: number,
url: string,
name: string
} | null,
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[],
recipients: {
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[],
templateMeta: {
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string
} | null,
directLink: {
token: string,
enabled: boolean
} | null,
templateDocumentDataId: string
}[]
recipients.create.post
templates.recipients.create.post
POST /template/recipient/create — [Deprecated] Create template recipient.
Risk: write
await corsair.documenso.api.templates.recipients.create.post({
templateId: 1,
recipient: { email: 'signer@documenso.invalid', name: 'sample', role: 'CC' },
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
recipient | object | Yes | — |
POST /template/recipient/create); use the corresponding envelope-based operation for new integrations.
recipient full type
recipient full type
{
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
recipients.createMany.post
templates.recipients.createMany.post
POST /template/recipient/create-many — [Deprecated] Create template recipients.
Risk: write
await corsair.documenso.api.templates.recipients.createMany.post({
templateId: 1,
recipients: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
recipients | object[] | Yes | — |
POST /template/recipient/create-many); use the corresponding envelope-based operation for new integrations.
recipients full type
recipients full type
{
email: string,
name: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.delete.post
templates.recipients.delete.post
POST /template/recipient/delete — [Deprecated] Delete template recipient.
Risk: destructive
await corsair.documenso.api.templates.recipients.delete.post({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
POST /template/recipient/delete); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
success | boolean | Yes | — |
recipients.get.get
templates.recipients.get.get
GET /template/recipient/{recipientId} — [Deprecated] Get template recipient.
Risk: read
await corsair.documenso.api.templates.recipients.get.get({ recipientId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
recipientId | number | Yes | — |
GET /template/recipient/{recipientId}); use the corresponding envelope-based operation for new integrations.
Output
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.update.post
templates.recipients.update.post
POST /template/recipient/update — [Deprecated] Update template recipient.
Risk: write
await corsair.documenso.api.templates.recipients.update.post({
templateId: 1,
recipient: { id: 1 },
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
recipient | object | Yes | — |
POST /template/recipient/update); use the corresponding envelope-based operation for new integrations.
recipient full type
recipient full type
{
id: number,
email?: string,
name?: string,
role?: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}
| Name | Type | Required | Description |
|---|---|---|---|
envelopeId | string | Yes | — |
role | CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string | Yes | — |
readStatus | NOT_OPENED | OPENED | string | Yes | — |
signingStatus | NOT_SIGNED | SIGNED | REJECTED | string | Yes | — |
sendStatus | NOT_SENT | SENT | string | Yes | — |
id | number | Yes | — |
email | string | Yes | — |
name | string | Yes | — |
token | string | Yes | — |
documentDeletedAt | string | null | Yes | — |
expired | string | null | Yes | — |
expiresAt | string | null | Yes | — |
expirationNotifiedAt | string | null | Yes | — |
signedAt | string | null | Yes | — |
authOptions | object | null | Yes | — |
signingOrder | number | null | Yes | — |
rejectionReason | string | null | Yes | — |
fields | object[] | Yes | — |
documentId | number | null | No | — |
templateId | number | null | No | — |
authOptions full type
authOptions full type
{
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]
recipients.updateMany.post
templates.recipients.updateMany.post
POST /template/recipient/update-many — [Deprecated] Update template recipients.
Risk: write
await corsair.documenso.api.templates.recipients.updateMany.post({
templateId: 1,
recipients: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
recipients | object[] | Yes | — |
POST /template/recipient/update-many); use the corresponding envelope-based operation for new integrations.
recipients full type
recipients full type
{
id: number,
email?: string,
name?: string,
role?: CC | SIGNER | VIEWER | APPROVER | ASSISTANT,
signingOrder?: number,
accessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
actionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE)[]
}[]
| Name | Type | Required | Description |
|---|---|---|---|
recipients | object[] | Yes | — |
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
fields: {
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[],
documentId?: number | null,
templateId?: number | null
}[]
update.post
templates.update.post
POST /template/update — [Deprecated] Update template.
Risk: write
await corsair.documenso.api.templates.update.post({ templateId: 1 });
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
data | object | No | — |
meta | object | No | — |
POST /template/update); use the corresponding envelope-based operation for new integrations.
data full type
data full type
{
title?: string,
externalId?: string | null,
visibility?: EVERYONE | MANAGER_AND_ABOVE | ADMIN,
globalAccessAuth?: (ACCOUNT | TWO_FACTOR_AUTH)[],
globalActionAuth?: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD)[],
publicTitle?: string,
publicDescription?: string,
type?: PUBLIC | PRIVATE | ORGANISATION,
useLegacyFieldInsertion?: boolean,
folderId?: string | null
}
meta full type
meta full type
{
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
distributionMethod?: EMAIL | NONE,
emailId?: string | null,
emailReplyTo?: string | null,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
},
redirectUrl?: string,
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
signingOrder?: PARALLEL | SEQUENTIAL,
allowDictateNextSigner?: boolean
}
| Name | Type | Required | Description |
|---|---|---|---|
type | PUBLIC | PRIVATE | ORGANISATION | string | Yes | — |
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
title | string | Yes | — |
userId | number | Yes | — |
teamId | number | Yes | — |
authOptions | object | null | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
publicTitle | string | Yes | — |
publicDescription | string | Yes | — |
folderId | string | null | Yes | — |
useLegacyFieldInsertion | boolean | Yes | — |
envelopeId | string | Yes | — |
templateDocumentDataId | string | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
use.post
templates.use.post
POST /template/use — [Deprecated] Use template.
Risk: destructive
await corsair.documenso.api.templates.use.post({
templateId: 1,
recipients: [],
});
| Name | Type | Required | Description |
|---|---|---|---|
templateId | number | Yes | — |
externalId | string | No | — |
recipients | object[] | Yes | — |
distributeDocument | boolean | No | — |
customDocumentDataId | string | No | — |
customDocumentData | object[] | No | — |
folderId | string | No | — |
prefillFields | object[] | No | — |
override | object | No | — |
attachments | object[] | No | — |
formValues | object | No | — |
POST /template/use); use the corresponding envelope-based operation for new integrations.
recipients full type
recipients full type
{
id: number,
email: "" | string,
name?: string
}[]
customDocumentData full type
customDocumentData full type
{
documentDataId: string,
envelopeItemId: string
}[]
prefillFields full type
prefillFields full type
(
{
id: number,
type: text,
label?: string,
placeholder?: string,
value?: string
} | {
id: number,
type: number,
label?: string,
placeholder?: string,
value?: string
} | {
id: number,
type: radio,
label?: string,
value?: string
} | {
id: number,
type: checkbox,
label?: string,
value?: string[]
} | {
id: number,
type: dropdown,
label?: string,
value?: string
} | {
id: number,
type: date,
value?: string
}
)[]
override full type
override full type
{
title?: string,
subject?: string,
message?: string,
timezone?: string,
dateFormat?: yyyy-MM-dd hh:mm a | yyyy-MM-dd | dd/MM/yyyy | dd-MM-yyyy | MM/dd/yyyy | yy-MM-dd | MMMM dd,
yyyy | EEEE,
MMMM dd,
yyyy | dd/MM/yyyy hh:mm a | dd/MM/yyyy HH:mm | dd-MM-yyyy hh:mm a | dd-MM-yyyy HH:mm | MM/dd/yyyy hh:mm a | MM/dd/yyyy HH:mm | dd.MM.yyyy | dd.MM.yyyy HH:mm | yyyy-MM-dd HH:mm | yy-MM-dd hh:mm a | yy-MM-dd HH:mm | yyyy-MM-dd HH:mm:ss | MMMM dd,
yyyy hh:mm a | MMMM dd,
yyyy HH:mm | EEEE,
MMMM dd,
yyyy hh:mm a | EEEE,
MMMM dd,
yyyy HH:mm | yyyy-MM-dd'T'HH:mm:ss.SSSXXX,
redirectUrl?: string,
distributionMethod?: EMAIL | NONE,
emailSettings?: {
recipientSigningRequest?: boolean,
recipientRemoved?: boolean,
recipientSigned?: boolean,
documentPending?: boolean,
documentCompleted?: boolean,
documentDeleted?: boolean,
ownerDocumentCompleted?: boolean,
ownerRecipientExpired?: boolean,
ownerDocumentCreated?: boolean
},
language?: de | en | fr | es | it | nl | pl | pt-BR | ja | ko | zh,
typedSignatureEnabled?: boolean,
uploadSignatureEnabled?: boolean,
drawSignatureEnabled?: boolean,
allowDictateNextSigner?: boolean,
envelopeExpirationPeriod?: {
unit: day | week | month | year,
amount: number
} | {
disabled: true
} | null
}
attachments full type
attachments full type
{
label: string,
data: string,
type?: link
}[]
formValues full type
formValues full type
{
}
| Name | Type | Required | Description |
|---|---|---|---|
visibility | EVERYONE | MANAGER_AND_ABOVE | ADMIN | string | Yes | — |
status | DRAFT | PENDING | COMPLETED | REJECTED | CANCELLED | string | Yes | — |
source | DOCUMENT | TEMPLATE | TEMPLATE_DIRECT_LINK | string | Yes | — |
id | number | Yes | — |
externalId | string | null | Yes | — |
userId | number | Yes | — |
authOptions | object | null | Yes | — |
formValues | object | null | Yes | — |
title | string | Yes | — |
createdAt | string | Yes | — |
updatedAt | string | Yes | — |
completedAt | string | null | Yes | — |
deletedAt | string | null | Yes | — |
teamId | number | Yes | — |
folderId | string | null | Yes | — |
envelopeId | string | Yes | — |
internalVersion | number | Yes | — |
templateId | number | null | No | — |
documentDataId | string | Yes | — |
documentData | object | Yes | — |
documentMeta | object | Yes | — |
envelopeItems | object[] | Yes | — |
folder | object | null | Yes | — |
recipients | object[] | Yes | — |
fields | object[] | Yes | — |
authOptions full type
authOptions full type
{
globalAccessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
globalActionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | string)[]
} | null
formValues full type
formValues full type
{
} | null
documentData full type
documentData full type
{
type: S3_PATH | BYTES | BYTES_64 | string,
id: string,
data: string,
initialData: string,
envelopeItemId: string
}
documentMeta full type
documentMeta full type
{
signingOrder: PARALLEL | SEQUENTIAL | string,
distributionMethod: EMAIL | NONE | string,
id: string,
subject: string | null,
message: string | null,
timezone: string | null,
dateFormat: string | null,
redirectUrl: string | null,
typedSignatureEnabled: boolean,
uploadSignatureEnabled: boolean,
drawSignatureEnabled: boolean,
allowDictateNextSigner: boolean,
language: string,
emailSettings: {
recipientSigningRequest: boolean,
recipientRemoved: boolean,
recipientSigned: boolean,
documentPending: boolean,
documentCompleted: boolean,
documentDeleted: boolean,
ownerDocumentCompleted: boolean,
ownerRecipientExpired: boolean,
ownerDocumentCreated: boolean
} | null,
emailId: string | null,
emailReplyTo: string | null,
envelopeExpirationPeriod: {
unit: day | week | month | year | string,
amount: number
} | {
disabled: true
} | null,
reminderSettings: {
sendAfter: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
},
repeatEvery: {
unit: day | week | month | string,
amount: number
} | {
disabled: true
}
} | null,
password: string | null,
documentId?: number
}
envelopeItems full type
envelopeItems full type
{
id: string,
envelopeId: string
}[]
folder full type
folder full type
{
id: string,
name: string,
type: DOCUMENT | TEMPLATE | string,
visibility: EVERYONE | MANAGER_AND_ABOVE | ADMIN | string,
userId: number,
teamId: number,
pinned: boolean,
parentId: string | null,
createdAt: string,
updatedAt: string
} | null
recipients full type
recipients full type
{
envelopeId: string,
role: CC | SIGNER | VIEWER | APPROVER | ASSISTANT | string,
readStatus: NOT_OPENED | OPENED | string,
signingStatus: NOT_SIGNED | SIGNED | REJECTED | string,
sendStatus: NOT_SENT | SENT | string,
id: number,
email: string,
name: string,
token: string,
documentDeletedAt: string | null,
expired: string | null,
expiresAt: string | null,
expirationNotifiedAt: string | null,
signedAt: string | null,
authOptions: {
accessAuth: (ACCOUNT | TWO_FACTOR_AUTH | string)[],
actionAuth: (ACCOUNT | PASSKEY | TWO_FACTOR_AUTH | PASSWORD | EXPLICIT_NONE | string)[]
} | null,
signingOrder: number | null,
rejectionReason: string | null,
documentId?: number | null,
templateId?: number | null
}[]
fields full type
fields full type
{
envelopeId: string,
envelopeItemId: string,
type: SIGNATURE | FREE_SIGNATURE | INITIALS | NAME | EMAIL | DATE | TEXT | NUMBER | RADIO | CHECKBOX | DROPDOWN | string,
id: number,
secondaryId: string,
recipientId: number,
page: number,
positionX: any,
positionY: any,
width: any,
height: any,
customText: string,
inserted: boolean,
fieldMeta: {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: signature
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: initials,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: name,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: email,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow: auto | horizontal | vertical | crop | string,
type: date,
textAlign?: left | center | right | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: text,
text?: string,
characterLimit?: number,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: number,
numberFormat?: string | null,
value?: string,
minValue?: number | null,
maxValue?: number | null,
textAlign?: left | center | right | string,
lineHeight?: number | null,
letterSpacing?: number | null,
verticalAlign?: top | middle | bottom | null
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: radio,
values?: {
id: number,
checked: boolean,
value: string
}[],
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: checkbox,
values?: {
id: number,
checked: boolean,
value: string
}[],
validationRule?: string,
validationLength?: number,
direction: vertical | horizontal | string
} | {
label?: string,
placeholder?: string,
required?: boolean,
readOnly?: boolean,
fontSize?: number,
overflow?: auto | horizontal | vertical | crop | string,
type: dropdown,
values?: {
value: string
}[],
defaultValue?: string
} | null,
documentId?: number | null,
templateId?: number | null
}[]