Typedef

Static Public Summary
public	AccessTokenGetParams: Object Request access token payload
public	AccessTokenGetResponse: Object Request access token response data
public	AccessTokenRefreshParams: Object Refresh access token payload
public	AccessTokenRefreshResponse: Object Refresh access token response data
public	AccessTokenVerifyParams: Object Verify access token payload
public	AccessTokenVerifyResponse: Object Verify access token response data
public	ApiError: Object Api error object
public	ApiErrorResponse: ApiError[] \| ApiError \| Error \| string Api error response
public	AttachmentField: Object
public	CalculatedField: Object
public	CancelFreeformInviteParams: Object Cancel freeform invite payload
public	CancelFreeformInviteResponse: Object Cancel freeform invite response data
public	CheckField: Object
public	CreateUserOptions: Object Create User optional settings
public	DocumentCreateParams: Object Create document payload
public	DocumentCreateResponse: Object Create document response data
public	DocumentDownloadOptions: Object Download document optional settings
public	DocumentDownloadParams: Object Document download payload
public	DocumentDownloadResponse: Buffer Document binary data
public	DocumentEvent: Object Document action log item
public	DocumentFieldExtractParams: Object Upload document with field extract payload
public	DocumentFieldExtractResponse: Object Upload document with field extract response data
public	DocumentFieldInviteCancelParams: Object Cancel document field invite payload
public	DocumentFieldInviteCancelResponse: Object Cancel document field invite response data
public	DocumentFieldInviteResponse: Object Create document field invite response data
public	DocumentFields: Object
public	DocumentFreeformInviteResponse: Object Create document free form invite response data
public	DocumentGroupCancelInviteParams: Object Cancel Document Group Invite payload
public	DocumentGroupCancelInviteResponse: Object Cancel Document Group Invite response data
public	DocumentGroupCreateParams: Object Create document group payload
public	DocumentGroupCreateResponse: Object Create document group response data
public	DocumentGroupDownloadParams: Object Document Group download payload
public	DocumentGroupDownloadResponse: Buffer Document Group binary data
public	DocumentGroupInviteAction: Object Document Group invite action configurations
public	DocumentGroupInviteAuthenticationPassword: Object Document Group signer's authentication with password config
public	DocumentGroupInviteAuthenticationPhoneCall: Object Document Group signer's authentication with phone call config
public	DocumentGroupInviteAuthenticationPhoneSMS: Object Document Group signer's authentication with phone SMS config
public	DocumentGroupInviteCompletionEmailConfig: Object Document Group invite completion email configuration
public	DocumentGroupInviteEmail: Object Document Group invite email configurations
public	DocumentGroupInviteParams: Object Create Document Group invite payload
public	DocumentGroupInviteResponse: Object Create Document Group invite response data
public	DocumentGroupInviteSettings: Object Document Group invite settings
public	DocumentGroupInviteStep: Object Document Group invite step configurations
public	DocumentGroupItem: Object Details of single Document in group
public	DocumentGroupTemplateCreateParams: Object Create Document Group Template payload
public	DocumentGroupTemplateCreateResponse: Object Create Document Group Template response data
public	DocumentGroupTemplateInviteAction: Object Document Group Template invite action congfigurations
public	DocumentGroupTemplateInviteEmail: Object Document Group Template invite email congfigurations
public	DocumentGroupTemplateInviteParams: Object Create Document Group Template invite payload
public	DocumentGroupTemplateInviteResponse: DocumentGroupInviteResponse Create Document Group Template invite response data
public	DocumentGroupTemplateInviteStep: Object Document Group Template invite step congfigurations
public	DocumentGroupTemplateItem: Object Details of single template in group
public	DocumentGroupTemplateRoutingDetails: Object Document Group Template invite congfigurations
public	DocumentGroupTemplateViewParams: Object Document Group Template view payload
public	DocumentGroupTemplateViewResponse: Object Document Group Template view response
public	DocumentGroupViewParams: Object Document Group view payload
public	DocumentGroupViewResponse: Object Document Group view response data
public	DocumentHistoryParams: Object Document history payload
public	DocumentHistoryResponse: DocumentEvent[] Document history response data
public	DocumentInviteOptions: Object Document invite optional settings
public	DocumentInviteParams: Object Create document invite payload
public	DocumentInviteResponse: DocumentFieldInviteResponse \| DocumentFreeformInviteResponse Create document invite response data
public	DocumentInviteSettings: Object Document invite settings
public	DocumentListItem: Object Document list response item
public	DocumentListParams: Object Payload to receive user's document list
public	DocumentListResponse: DocumentListItem[] User's Document list response
public	DocumentMergeOptions: Object Merge documents optional settings
public	DocumentMergeParams: Object Merge documents payload
public	DocumentMergeResponse: Object Merge documents response data
public	DocumentRemoveOptions: Object Document remove optional settings
public	DocumentRemoveParams: Object Remove document payload
public	DocumentRemoveResponse: Object Remove document response data
public	DocumentShareParams: Object Document share payload
public	DocumentShareResponse: Object Document share response data
public	DocumentSignersOptions: Object Get Document Signers optional settings
public	DocumentSignersParams: Object Get Document Signers payload
public	DocumentSignersResponse: Object Get Document Signers response data
public	DocumentThumbnails: Object Document thumbnail urls with different sizes (small, medium, large)
public	DocumentUpdateParams: Object Update document payload
public	DocumentUpdateResponse: Object Update document response data
public	DocumentViewParams: Object Document view payload
public	DocumentViewResponse: Object Document view response of specific document
public	EmbeddedCancelInvitePayload: Object Delete embedded invites for a document payload
public	EmbeddedCancelInviteResponse: Object Generate a link for the embedded invite response data
public	EmbeddedCreateInvitesPayload: Object Create embedded signing invites payload
public	EmbeddedCreateInvitesResponse: Object Create embedded signing invites response data
public	EmbeddedGenerateLinkPayload: Object Generate embedded invite link payload
public	EmbeddedGenerateLinkResponse: Object Generate a link for the embedded invite response data
public	EmbeddedGeneratedLink: Object Response EmbeddedGeneratedLink
public	EmbeddedInvite: Object Response EmbeddedInvite
public	EmbeddedSigningInvite: Object Create embedded signing invite payload
public	EnumerationField: Object
public	Features: Object Api client features
public	FormulaTree: Object
public	FormulaTreeBranch: Object
public	FormulaTreeBranchTerminator: Object
public	InitParams: Object Api client initialization params
public	InitialsField: Object
public	RadioButton: Object
public	RadioButtonField: Object
public	SignatureField: Object
public	SignerSettings: Object Document invite signer settings
public	SigningLinkCreateParams: Object Create signing link payload
public	SigningLinkCreateResponse: Object Create signing link response data
public	TemplateBulkInviteParams: Object Send Template Bulk Invite payload
public	TemplateBulkInviteResponse: Object Send Template Bulk Invite response data
public	TemplateBulkInviteSettings: Object Template Bulk Invite settings
public	TemplateCreateOptions: Object Document invite optional settings
public	TemplateCreateParams: Object Create template payload
public	TemplateCreateResponse: Object Create template response data
public	TemplateDuplicateParams: Object Copy template payload
public	TemplateDuplicateResponse: Object Copy template response data
public	TemplateGetRoutingDetailsParams: Object Get Template Routing Details payload
public	TemplateGetRoutingDetailsResponse: Object Get Template Routing Details response data
public	TemplateInviteParams: DocumentInviteParams Create invite with template payload
public	TemplateInviteResponse: DocumentInviteResponse Create invite with template response data
public	TemplateRemoveParams: DocumentRemoveParams Remove template payload
public	TemplateRemoveResponse: DocumentRemoveResponse Remove template response data
public	TemplateRoutingDetailsCCStep: Object Template Routing Details CC step info
public	TemplateRoutingDetailsItem: Object Template Routing Details item data
public	TemplateUpdateRoutingDetailsItem: Object Template Update Routing Details item data
public	TemplateUpdateRoutingDetailsParams: Object Update Template Routing Details payload
public	TemplateUpdateRoutingDetailsResponse: Object Update Template Routing Details response data
public	TemplateUpdateRoutingDetailsSettings: Object Update Template Routing Details settings
public	TemplateUpdateSigningRoleParams: Object Update Signing Role payload
public	TemplateUpdateSigningRoleResponse: Object Update Signing Role response data
public	TextField: Object
public	UserCreateParams: Object Create user payload
public	UserCreateResponse: Object Create user response data
public	UserGetParams: Object Get user payload
public	UserGetResponse: Object Retrieve user response data
public	UserVerifyEmailParams: Object Verify user email payload
public	UserVerifyEmailResponse: Object Verify user email response data

Static Public

public AccessTokenGetParams: Object source

Request access token payload

Properties:

Name	Type	Attribute	Description
username	string		email of a user
password	string		password of a user

public AccessTokenGetResponse: Object source

Request access token response data

Properties:

Name	Type	Attribute	Description
expires_in	number		time in seconds for which the token was issued
token_type	string		type of access token (e.g. 'bearer')
access_token	string		access token
refresh_token	string		refresh token
scope	string		access scopes

public AccessTokenRefreshParams: Object source

Refresh access token payload

Properties:

Name	Type	Attribute	Description
refresh_token	string		your refresh token
scope	string	optional	access scopes of access token
expiration_time	number	optional	time in seconds for which the token was issued

public AccessTokenRefreshResponse: Object source

Refresh access token response data

Properties:

Name	Type	Attribute	Description
expires_in	number		time in seconds for which the token was issued
token_type	string		type of access token (e.g. 'bearer')
access_token	string		access token
refresh_token	string		refresh token
scope	string		access scopes

public AccessTokenVerifyParams: Object source

Verify access token payload

Properties:

Name	Type	Attribute	Description
token	string		your auth token

public AccessTokenVerifyResponse: Object source

Verify access token response data

Properties:

Name	Type	Attribute	Description
expires_in	number		time in seconds for which the token was issued
token_type	string		type of access token (e.g. 'bearer')
access_token	string		access token
scope	string		access scopes

public ApiError: Object source

Api error object

Properties:

Name	Type	Attribute	Description
code	number		error code
message	string		error message

public ApiErrorResponse: ApiError[] | ApiError | Error | string source

Api error response

public AttachmentField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (attachment)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
label	string	optional	field label

public CalculatedField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (text)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
formula	string		arithmetic formula, e.g. 'TextName+EnumerationName'
calculation_formula	FormulaTree		formula parsed into tree
calculation_precision	number		calculation precision
label	string	optional	field label
custom_defined_option	boolean	optional default: false	if 'true' user can change values, if 'false' user can only read

public CancelFreeformInviteParams: Object source

Cancel freeform invite payload

Properties:

Name	Type	Attribute	Description
id	string		unique id of invite
token	string		your auth token

public CancelFreeformInviteResponse: Object source

Cancel freeform invite response data

Properties:

Name	Type	Attribute	Description
id	string		unique id of invite

public CheckField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (checkbox)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
prefilled_text	boolean	optional	prefilled field value
label	string	optional	field label

public CreateUserOptions: Object source

Create User optional settings

Properties:

Name	Type	Attribute	Description
verifyEmail	boolean	optional default: false	if `true` verification email will be sent
startTrial	number	optional default: false	if `true` start 30 days free trial

public DocumentCreateParams: Object source

Create document payload

Properties:

Name	Type	Attribute	Description
filepath	string		path to file to be uploaded
token	string		your auth token

public DocumentCreateResponse: Object source

Create document response data

Properties:

Name	Type	Attribute	Description
id	string		an id of created document

public DocumentDownloadOptions: Object source

Download document optional settings

Properties:

Name	Type	Attribute	Description
withAttachments	boolean	optional default: false	if true document will be downloaded as zip package with its attachments
withHistory	boolean	optional default: false	if true document will be downloaded with history

public DocumentDownloadParams: Object source

Document download payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token
options	DocumentDownloadOptions		download document optional settings

public DocumentDownloadResponse: Buffer source

Document binary data

public DocumentEvent: Object source

Document action log item

Properties:

Name	Type	Attribute	Description
client_app_name	string		name of a client application
client_timestamp	string	nullable: true	client application timestamp
created	string		timestamp of action creation
email	string		email of an actor
event	string		name of event
ip_address	string		actor's IP address
element_id	string	nullable: true	an ID of specific element
field_id	string	nullable: true	an ID of specific field
json_attributes	string	nullable: true	field attributes (e.g. font, style, size etc.)
document_id	string	optional	an ID of specific document
origin	string	optional	an origin of document
unique_id	string	optional	an ID of event
user_agent	string	optional	user agent
user_id	string	optional	id of an actor
version	string	optional	version of signed document (incremented after each signature addition)

public DocumentFieldExtractParams: Object source

Upload document with field extract payload

Properties:

Name	Type	Attribute	Description
filepath	string		path to file to be uploaded
token	string		your auth token

public DocumentFieldExtractResponse: Object source

Upload document with field extract response data

Properties:

Name	Type	Attribute	Description
id	string		an id of created document

public DocumentFieldInviteCancelParams: Object source

Cancel document field invite payload

Properties:

Name	Type	Attribute	Description
id	string		an id of document
token	string		your auth token

public DocumentFieldInviteCancelResponse: Object source

Cancel document field invite response data

Properties:

Name	Type	Attribute	Description
status	string		status of field invite cancellation, e.g. 'success'

public DocumentFieldInviteResponse: Object source

Create document field invite response data

Properties:

Name	Type	Attribute	Description
status	string		status of invitation, e.g. 'success'

public DocumentFields: Object source

Properties:

Name	Type	Attribute	Description
client_timestamp	number		local time of user
fields	Array<SignatureField\|InitialsField\|TextField\|CheckField\|EnumerationField\|RadioButtonField\|CalculatedField\|AttachmentField>		all types of fields

public DocumentFreeformInviteResponse: Object source

Create document free form invite response data

Properties:

Name	Type	Attribute	Description
result	string		free form invitation result, e.g. 'success'
id	string		unique id of invite
callback_url	string		url for front-end redirect or 'none'

public DocumentGroupCancelInviteParams: Object source

Cancel Document Group Invite payload

Properties:

Name	Type	Attribute	Description
id	string		ID of specific Document Group
invite_id	string		ID of Document Group Invite
token	string		your auth token

public DocumentGroupCancelInviteResponse: Object source

Cancel Document Group Invite response data

Properties:

Name	Type	Attribute	Description
status	string		status of invite cancellation (e.g. "success")

public DocumentGroupCreateParams: Object source

Create document group payload

Properties:

Name	Type	Attribute	Description
token	string		your auth token
ids	string[]		array of document or template ids for document group creation
group_name	string		new name of document group

public DocumentGroupCreateResponse: Object source

Create document group response data

Properties:

Name	Type	Attribute	Description
id	string		document group unique id

public DocumentGroupDownloadParams: Object source

Document Group download payload

Properties:

Name	Type	Attribute	Description
id	string		an ID of a Document Group
token	string		your auth token
type	string	optional default: 'zip'	type of download flow, can be either `zip` or `merged`
with_history	string	optional default: 'no'	type of history merging flow, can be `no`, `after_each_document`, or `after_merged_pdf`
document_order	string[]	optional	document order for merging flow

public DocumentGroupDownloadResponse: Buffer source

Document Group binary data

public DocumentGroupInviteAction: Object source

Document Group invite action configurations

Properties:

Name	Type	Attribute	Description
email	string		signer's email
role_name	string		signer's role name
action	string		name of action with document in signing step
document_id	string		ID of document in specific signing step
allow_reassign	string	optional	allow reassigning of signer
decline_by_signature	string	optional	signer can decline invite
authentication	DocumentGroupInviteAuthenticationPassword \| DocumentGroupInviteAuthenticationPhoneCall \| DocumentGroupInviteAuthenticationPhoneSMS	optional	signer's authentication configuration

public DocumentGroupInviteAuthenticationPassword: Object source

Document Group signer's authentication with password config

Properties:

Name	Type	Attribute	Description
type	string		set `password` to authenticate signer with password
value	string		authentication password value

public DocumentGroupInviteAuthenticationPhoneCall: Object source

Document Group signer's authentication with phone call config

Properties:

Name	Type	Attribute	Description
type	string		set `phone` to authenticate signer with phone call
method	string		set `phone_call` to authenticate signer with phone call
phone	string		phone number

public DocumentGroupInviteAuthenticationPhoneSMS: Object source

Document Group signer's authentication with phone SMS config

Properties:

Name	Type	Attribute	Description
type	string		set `phone` to authenticate signer with phone SMS
method	string		set `sms` to authenticate signer with phone SMS
phone	string		phone number

public DocumentGroupInviteCompletionEmailConfig: Object source

Document Group invite completion email configuration

Properties:

Name	Type	Attribute	Description
email	string		email for completion (only from the signers and document owner emails)
disable_document_attachment	number		disable attachment of signed document group to completion email (values: 0\|1)

public DocumentGroupInviteEmail: Object source

Document Group invite email configurations

Properties:

Name	Type	Attribute	Description
email	string		signer's email
subject	string	optional	subject of invitation email
message	string	optional	content of invitation email
expiration_days	number	optional	expiration of invite in days
reminder	number	optional	number of days in which to remind about invitation via email

public DocumentGroupInviteParams: Object source

Create Document Group invite payload

Properties:

Name	Type	Attribute	Description
id	string		ID of specific Document Group
data	DocumentGroupInviteSettings		Document Group invite settings data
token	string		your auth token

public DocumentGroupInviteResponse: Object source

Create Document Group invite response data

Properties:

Name	Type	Attribute	Description
id	string		ID of created Document Group invitation
pending_invite_link	string	nullable: true	pending invite link

public DocumentGroupInviteSettings: Object source

Document Group invite settings

Properties:

Name	Type	Attribute	Description
invite_steps	DocumentGroupInviteStep[]		Document Group invite steps settings
completion_emails	DocumentGroupInviteCompletionEmailConfig[]	optional	set of completion email configutrations

public DocumentGroupInviteStep: Object source

Document Group invite step configurations

Properties:

Name	Type	Attribute	Description
order	number		an order number of invitation step
invite_emails	DocumentGroupInviteEmail[]	optional	Document Group invite emails settings
invite_actions	DocumentGroupInviteAction[]		Document Group invite actions settings

public DocumentGroupItem: Object source

Details of single Document in group

Properties:

Name	Type	Attribute	Description
id	string		an ID of Document
document_name	string		a name of Document
origin_document_id	string		an ID of Document origin
has_credit_card_number	boolean		Document has Credit Card number attached
has_unassigned_field	boolean		Document has unassigned field(s)
thumbnail	DocumentThumbnails		thumbnail urls with different sizes (small, medium, large)
roles	string[]		list of template signer roles

public DocumentGroupTemplateCreateParams: Object source

Create Document Group Template payload

Properties:

Name	Type	Attribute	Description
token	string		your auth token
template_ids	string[]		array of template ids for Document Group Template creation
template_group_name	string		new name of document group
routing_details	DocumentGroupTemplateRoutingDetails		invite congfigurations

public DocumentGroupTemplateCreateResponse: Object source

Create Document Group Template response data

Properties:

Name	Type	Attribute	Description
id	string		Document Group Template unique id

public DocumentGroupTemplateInviteAction: Object source

Document Group Template invite action congfigurations

Properties:

Name	Type	Attribute	Description
email	string	optional	signer's email
role_name	string	optional	signer's role name
action	string	optional	name of action with document in signing step
document_id	string	optional	ID of document in specific signing step
document_name	string	optional	name of document in specific signing step
allow_reassign	string	optional	allow reassigning of signer
decline_by_signature	string		signer can decline invite

public DocumentGroupTemplateInviteEmail: Object source

Document Group Template invite email congfigurations

Properties:

Name	Type	Attribute	Description
email	string	optional	signer's email
subject	string	optional	subject of invitation email
message	string	optional	content of invitation email
expiration_days	number	optional	expiration of invite in days
reminder	number	optional	number of days in which to remind about invite via email
hasSignActions	boolean	optional	does signer need to sign documents of document group

public DocumentGroupTemplateInviteParams: Object source

Create Document Group Template invite payload

Properties:

Name	Type	Attribute	Description
id	string		ID of specific Document Group Template
data	DocumentGroupInviteSettings	optional	Document Group Template invite settings data
token	string		your auth token

public DocumentGroupTemplateInviteResponse: DocumentGroupInviteResponse source

Create Document Group Template invite response data

Properties:

Name	Type	Attribute	Description
id	string		an ID of created invite
pending_invite_link	string	nullable: true	pending invite link

public DocumentGroupTemplateInviteStep: Object source

Document Group Template invite step congfigurations

Properties:

Name	Type	Attribute	Description
order	number	optional	an order number of invitation step
invite_emails	DocumentGroupTemplateInviteEmail[]	optional	Document Group Template invite emails settings
invite_actions	DocumentGroupTemplateInviteAction[]		Document Group Template invite actions settings

public DocumentGroupTemplateItem: Object source

Details of single template in group

Properties:

Name	Type	Attribute	Description
id	string		id of template
template_name	string		name of template
owner_email	string		template owner email
readable	number	nullable: true
thumbnail	DocumentThumbnails		thumbnail urls with different sizes (small, medium, large)
roles	string[]		list of template signer roles

public DocumentGroupTemplateRoutingDetails: Object source

Document Group Template invite congfigurations

Properties:

Name	Type	Attribute	Description
invite_steps	DocumentGroupTemplateInviteStep[]		Document Group Template invite steps settings
include_email_attachments	number	optional

public DocumentGroupTemplateViewParams: Object source

Document Group Template view payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific Document Group Template
token	string		your auth token

public DocumentGroupTemplateViewResponse: Object source

Document Group Template view response

Properties:

Name	Type	Attribute	Description
id	string		id of Document Group Template
group_name	string		name of Document Group Template
document_group_template_owner_email	string		Document Group Template owner email
shared	number		is Document Group Template shared or not (values: 0 or 1)
shared_team_id	string	nullable: true	id of team which Document Group Template is shared with
templates	DocumentGroupTemplateItem[]		each single template details
routing_details	DocumentGroupTemplateRoutingDetails		signing steps configuration
originator_organization_settings	Object[]		originator organization settings

public DocumentGroupViewParams: Object source

Document Group view payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific Document Group
token	string		your auth token

public DocumentGroupViewResponse: Object source

Document Group view response data

Properties:

Name	Type	Attribute	Description
id	string		an ID of Document Group
group_name	string		a name of Document Group
documents	DocumentGroupItem[]		each single document details
invite_id	string	nullable: true	an ID of active invite
originator_organization_settings	Object[]		originator organization settings

public DocumentHistoryParams: Object source

Document history payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token

public DocumentHistoryResponse: DocumentEvent[] source

Document history response data

public DocumentInviteOptions: Object source

Document invite optional settings

Properties:

Name	Type	Attribute	Description
email	string	optional	ability to disable invitation by email. to disable email assign value 'disable'

public DocumentInviteParams: Object source

Create document invite payload

Properties:

Name	Type	Attribute	Description
id	string		an id of document
data	DocumentInviteSettings		document invite settings
options	DocumentInviteOptions	optional	document invite optional settings
token	string		your auth token

public DocumentInviteResponse: DocumentFieldInviteResponse | DocumentFreeformInviteResponse source

Create document invite response data

public DocumentInviteSettings: Object source

Document invite settings

Properties:

Name	Type	Attribute	Description
from	string		email of sender
to	SignerSettings[] \| string		array of signers or email of single signer
document_id	string	optional	an id of document
cc	string[]	optional	array with emails of copy receivers
subject	string	optional	specify subject of email
message	string	optional	specify body of email
on_complete	string	optional	on signing complete action

public DocumentListItem: Object source

Document list response item

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
user_id	string		id of user that uploaded document
document_name	string		name of document
page_count	string		amount of pages in the document
created	string		timestamp document was created
updated	string		timestamp document was updated
original_filename	string		original filename with document format (.pdf, .doc, etc...)
origin_document_id	string	nullable: true	an id of original document (if document is a copy)
owner	string		email of document owner
template	boolean		is document a template or not
origin_user_id	string	nullable: true	id of user who created document
thumbnail	DocumentThumbnails		thumbnail urls with different sizes (small, medium, large)
signatures	Object[]		signature signed elements
texts	Object[]		text and enumeration filled elements
checks	Object[]		checkbox checked elements
tags	Object[]		field types document contains
fields	Object[]		all document fillable fields
requests	Object[]		requests for signing document
roles	Object[]		document signer roles
field_invites	Object[]		sent invites data
version_time	number		document updated timestamp
enumeration_options	Object[]		dropdown options
attachments	Object[]		attachments in document
routing_details	Object[]		signing steps routing details
integrations	Object[]		document integrations
hyperlinks	Object[]		document hyperlinks
radiobuttons	Object[]		checked radiobuttons after document was signed
document_group_template_info	Object[]		document group templates data
document_group_info	Object[]		document group template's data
originator_organization_settings	Object[]		specific organization settings for document
field_validators	Object[]		validation rules for fields (date fields, payment fields etc.)
settings	Object		specific document settings

public DocumentListParams: Object source

Payload to receive user's document list

Properties:

Name	Type	Attribute	Description
token	string		your auth token

public DocumentListResponse: DocumentListItem[] source

User's Document list response

public DocumentMergeOptions: Object source

Merge documents optional settings

Properties:

Name	Type	Attribute	Description
removeOriginalDocuments	boolean	optional default: false	if true original documents will be removed

public DocumentMergeParams: Object source

Merge documents payload

Properties:

Name	Type	Attribute	Description
token	string		your auth token
name	string		new name for merged document
document_ids	string[]		an array of document IDs
options	DocumentMergeOptions		merge documents optional settings

public DocumentMergeResponse: Object source

Merge documents response data

Properties:

Name	Type	Attribute	Description
document_id	string		an ID of merged document

public DocumentRemoveOptions: Object source

Document remove optional settings

Properties:

Name	Type	Attribute	Description
cancelInvites	boolean	optional default: false	ability to cancel all document invites during deletion

public DocumentRemoveParams: Object source

Remove document payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token
options	DocumentRemoveOptions	optional	document remove optional settings

public DocumentRemoveResponse: Object source

Remove document response data

Properties:

Name	Type	Attribute	Description
status	string		status of deletion, e.g. 'success'

public DocumentShareParams: Object source

Document share payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token

public DocumentShareResponse: Object source

Document share response data

Properties:

Name	Type	Attribute	Description
link	string		link to download specified document in PDF format

public DocumentSignersOptions: Object source

Get Document Signers optional settings

Properties:

Name	Type	Attribute	Description
allSignatures	boolean	optional default: true	if true receive all document signers email
freeFormInvites	boolean	optional default: false	if `true` return free from invite signer emails
fieldInvitesStatus	string[]	optional default: null nullable: true	return signers according to specified field invite status(es) Accepts list of statuses or a single status. Acceptable statuses: all, pending, declined, fulfilled, created, skipped.
paymentRequestsStatus	string[]	optional default: null nullable: true	return signers according to specified to payment request status(es) Accepts list of statuses or a single status. Available statuses: all, pending, fulfilled, created, skipped.

public DocumentSignersParams: Object source

Get Document Signers payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token
options	DocumentSignersOptions	optional	document signers optional settings,

public DocumentSignersResponse: Object source

Get Document Signers response data

Properties:

Name	Type	Attribute	Description
-	string[]		emails of document signers

public DocumentThumbnails: Object source

Document thumbnail urls with different sizes (small, medium, large)

Properties:

Name	Type	Attribute	Description
large	string
medium	string
small	string

public DocumentUpdateParams: Object source

Update document payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
fields	DocumentFields		set of fields
token	string		your auth token

public DocumentUpdateResponse: Object source

Update document response data

Properties:

Name	Type	Attribute	Description
id	string		an id of document
signatures	Object[]		signature and initial elements
texts	Object[]		text and enumeration elements
checks	Object[]		checkbox elements
attachments	Object[]		attachment elements
radiobuttons	Object[]		radiobutton elements

public DocumentViewParams: Object source

Document view payload

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
token	string		your auth token

public DocumentViewResponse: Object source

Document view response of specific document

Properties:

Name	Type	Attribute	Description
id	string		id of specific document
user_id	string		id of user that uploaded document
document_name	string		name of document
page_count	string		amount of pages in the document
created	string		timestamp document was created
updated	string		timestamp document was updated
original_filename	string		original filename with document format (.pdf, .doc, etc...)
origin_document_id	string	nullable: true	an id of original document (if document is a copy)
owner	string		email of document owner
template	boolean		is document a template or not
thumbnail	DocumentThumbnails		thumbnail urls with different sizes (small, medium, large)
signatures	Object[]		signature signed elements
texts	Object[]		text and enumeration filled elements
checks	Object[]		checkbox checked elements
tags	Object[]		field types document contains
fields	Object[]		all document fillable fields
requests	Object[]		requests for signing document
roles	Object[]		document signer roles
field_invites	Object[]		sent invites data
version_time	number		document updated timestamp
enumeration_options	Object[]		dropdown options
attachments	Object[]		attachments in document
routing_details	Object[]		signing steps routing details
integrations	Object[]		document integrations
hyperlinks	Object[]		document hyperlinks
radiobuttons	Object[]		checked radiobuttons after document was signed
document_group_template_info	Object[]		document group template's data
document_group_info	Object[]		document group's data
originator_organization_settings	Object[]		specific organization settings for document
field_validators	Object[]		validation rules for fields (date fields, payment fields etc.)
settings	Object		specific document settings
parent_id	string		id of document folder
originator_logo	string		logo url
pages	Object[]		list of document pages with page sources and page size.

public EmbeddedCancelInvitePayload: Object source

Delete embedded invites for a document payload

Properties:

Name	Type	Attribute	Description
token	string		Access token.
document_id	string		ID of the requested document.

public EmbeddedCancelInviteResponse: Object source

Generate a link for the embedded invite response data

Properties:

Name	Type	Attribute	Description
status	string		Returns success when all parameters are correct

public EmbeddedCreateInvitesPayload: Object source

Create embedded signing invites payload

Properties:

Name	Type	Attribute	Description
token	string		Access token.
document_id	string		ID of the requested document.
invites	EmbeddedSigningInvite[]		Array of invites

public EmbeddedCreateInvitesResponse: Object source

Create embedded signing invites response data

Properties:

Name	Type	Attribute	Description
data	EmbeddedInvite[]		Array sending of invites

public EmbeddedGenerateLinkPayload: Object source

Generate embedded invite link payload

Properties:

Name	Type	Attribute	Description
token	string		Access token.
document_id	string		ID of the requested document.
field_invite_unique_id	string		ID of the signature invite you'd like to embed.
link_expiration	number		In how many minutes the link expires, ranges from 15 to 45 minutes or null.
auth_method	string		Signer authentication method.

public EmbeddedGenerateLinkResponse: Object source

Generate a link for the embedded invite response data

Properties:

Name	Type	Attribute	Description
data	EmbeddedGeneratedLink		Response data

public EmbeddedGeneratedLink: Object source

Response EmbeddedGeneratedLink

Properties:

Name	Type	Attribute	Description
link	string		Returns a link for embedded invite

public EmbeddedInvite: Object source

Response EmbeddedInvite

Properties:

Name	Type	Attribute	Description
id	string		ID of the sending invite
email	string		Signer's email address
role_id	number		Signer's role ID
order	number		Order of signing
status	string		Status of the invite

public EmbeddedSigningInvite: Object source

Create embedded signing invite payload

Properties:

Name	Type	Attribute	Description
email	string		Signer's email address
role_id	number		Signer's role ID
order	number		Order of signing. Cannot be 0
auth_method	string		Signer authentication method. One of (password, email, mfa, social, biometric, other, none)

public EnumerationField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (enumeration)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
enumeration_options	Array<number\|string>		choice options of enumerable field
prefilled_text	string \| number	optional	prefilled field value
label	string	optional	field label
custom_defined_option	boolean	optional default: false	if 'true' user can change values, if 'false' user can only read

public Features: Object source

Api client features

Properties:

Name	Type	Attribute	Description
user	User		user related methods
oauth2	OAuth2		authentication related methods
document	Document		document related methods
template	Template		template related methods
link	Link		link related methods
documentGroup	DocumentGroup		document group related methods
documentGroupTemplate	DocumentGroupTemplate		document group template related methods
embedded	Embedded		embedded signing related methods

public FormulaTree: Object source

Properties:

Name	Type	Attribute	Description
operator	string		arithmetic operator's token
left	FormulaTreeBranch \| FormulaTreeBranchTerminator		left branch of formula tree
right	FormulaTreeBranch \| FormulaTreeBranchTerminator		right branch of formula tree

public FormulaTreeBranch: Object source

Properties:

Name	Type	Attribute	Description
term	FormulaTree		a part of formula parsed into tree

public FormulaTreeBranchTerminator: Object source

Properties:

Name	Type	Attribute	Description
term	string		name of field which will participate in calculation formula

public InitParams: Object source

Api client initialization params

Properties:

Name	Type	Attribute	Description
credentials	string		base64 encoded basic API credentials
production	boolean	optional default: true	production/eval API flag. If false uses eval

public InitialsField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (initials)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
label	string	optional	field label

public RadioButton: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
value	string		value of radio button
checked	string		radio button check status
created	number		redio button creation timestamp

public RadioButtonField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (radiobutton)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
radio	RadioButton[]		array of radio buttons
prefilled_text	string \| number	optional	prefilled field value
label	string	optional	field label

public SignatureField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (signature)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
label	string	optional	field label

public SignerSettings: Object source

Document invite signer settings

Properties:

Name	Type	Attribute	Description
email	string		signer's email
role	string		role name
role_id	string	optional	role unique id (can be discovered in document details)
order	number		role signing order
reassign	string		allow reassign signer
decline_by_signature	string		signer can decline invite
reminder	number		remind via email in days
expiration_days	number		expiration of invite in days
subject	string	optional	specify subject of email
message	string	optional	specify body of email

public SigningLinkCreateParams: Object source

Create signing link payload

Properties:

Name	Type	Attribute	Description
document_id	string		id of specific document
token	string		your auth token

public SigningLinkCreateResponse: Object source

Create signing link response data

Properties:

Name	Type	Attribute	Description
url	string		invite url with user authorization
url_no_signup	string		invite url without user authorization

public TemplateBulkInviteParams: Object source

Send Template Bulk Invite payload

Properties:

Name	Type	Attribute	Description
id	string		an ID of specific Template
token	string		your auth token
data	TemplateBulkInviteSettings		Template Bulk Invite settings

public TemplateBulkInviteResponse: Object source

Send Template Bulk Invite response data

Properties:

Name	Type	Attribute	Description
status	string		status of sending bulk invites (e.g. "job queued")

public TemplateBulkInviteSettings: Object source

Template Bulk Invite settings

Properties:

Name	Type	Attribute	Description
file	string		path to .csv file with roles and their emails. Max file size should be <= 1 Megabyte
folder_id	string		an ID of folder where signed documents will be saved
client_timestamp	number	optional	client timestamp in seconds
document_name	string	optional	setup prefix for each document name
subject	string	optional	custom email subject
email_message	string	optional	custom email message

public TemplateCreateOptions: Object source

Document invite optional settings

Properties:

Name	Type	Attribute	Description
removeOriginalDocument	boolean	optional default: false	if true original document will be removed

public TemplateCreateParams: Object source

Create template payload

Properties:

Name	Type	Attribute	Description
document_id	string		an id of original document
document_name	string		a name of new template
options	TemplateCreateOptions		create template optional settings
token	string		your auth token

public TemplateCreateResponse: Object source

Create template response data

Properties:

Name	Type	Attribute	Description
id	string		an id of created template

public TemplateDuplicateParams: Object source

Copy template payload

Properties:

Name	Type	Attribute	Description
id	string		an id of original template
name	string		a name of new document
token	string		your auth token

public TemplateDuplicateResponse: Object source

Copy template response data

Properties:

Name	Type	Attribute	Description
id	string		an id of created document
name	string		a name of created document

public TemplateGetRoutingDetailsParams: Object source

Get Template Routing Details payload

Properties:

Name	Type	Attribute	Description
id	string		an ID of specific Template
token	string		your auth token

public TemplateGetRoutingDetailsResponse: Object source

Get Template Routing Details response data

Properties:

Name	Type	Attribute	Description
routing_details	TemplateRoutingDetailsItem[]		array with routing details
cc	string[]		CC emails
cc_step	TemplateRoutingDetailsCCStep[]		array of CC`s steps
invite_link_instructions	string		invite link instructions

public TemplateInviteParams: DocumentInviteParams source

Create invite with template payload

public TemplateInviteResponse: DocumentInviteResponse source

Create invite with template response data

public TemplateRemoveParams: DocumentRemoveParams source

Remove template payload

public TemplateRemoveResponse: DocumentRemoveResponse source

Remove template response data

public TemplateRoutingDetailsCCStep: Object source

Template Routing Details CC step info

Properties:

Name	Type	Attribute	Description
email	string		email of cc step
step	number		step order number
name	string		name of cc step

public TemplateRoutingDetailsItem: Object source

Template Routing Details item data

Properties:

Name	Type	Attribute	Description
default_email	string		default email for routing detail
inviter_role	boolean		always `false`
name	string		signer role (actor) name
role_id	string		signer role (actor) unique ID
signing_order	number		order number of signing step

public TemplateUpdateRoutingDetailsItem: Object source

Template Update Routing Details item data

Properties:

Name	Type	Attribute	Description
default_email	string		default email for routing detail
inviter_role	boolean		always `false`
name	string		signer role (actor) name
role_id	string		signer role (actor) unique ID
signing_order	number		order number of signing step
decline_by_signature	boolean		decline by signature flag

public TemplateUpdateRoutingDetailsParams: Object source

Update Template Routing Details payload

Properties:

Name	Type	Attribute	Description
id	string		an ID of specific Template
token	string		your auth token
data	TemplateUpdateRoutingDetailsSettings		update Template Routing Details settings

public TemplateUpdateRoutingDetailsResponse: Object source

Update Template Routing Details response data

Properties:

Name	Type	Attribute	Description
id	string		unique ID of template routing details
document_id	string		unique ID of Template
data	TemplateUpdateRoutingDetailsItem[]		array with routing details
cc	string[]		CC emails
cc_step	TemplateRoutingDetailsCCStep[]		array of CC steps
invite_link_instructions	string		invite signing instructions

public TemplateUpdateRoutingDetailsSettings: Object source

Update Template Routing Details settings

Properties:

Name	Type	Attribute	Description
template_data	TemplateUpdateRoutingDetailsItem[]		array with routing details
cc	string[]		CC emails
cc_step	TemplateRoutingDetailsCCStep[]		array of CC steps
invite_link_instructions	string	optional	invite signing instructions

public TemplateUpdateSigningRoleParams: Object source

Update Signing Role payload

Properties:

Name	Type	Attribute	Description
id	string		an ID of Actor (role)
token	string		your auth token
signing_order	number		signing order number

public TemplateUpdateSigningRoleResponse: Object source

Update Signing Role response data

Properties:

Name	Type	Attribute	Description
id	string		unique ID of Actor
document_id	string		unique ID of Template
signing_order	number		signing order number

public TextField: Object source

Properties:

Name	Type	Attribute	Description
page_number	number		page number of document
type	string		type of field (text)
name	string		unique name of the field
role	string		role name
required	boolean		required field
height	number		height of the field
width	number		width of the field
x	number		X coordinate of the field
y	number		Y coordinate of the field
prefilled_text	string \| number	optional	prefilled field value
validator_id	string	optional	field value validator ID
label	string	optional	field label

public UserCreateParams: Object source

Create user payload

Properties:

Name	Type	Attribute	Description
email	string		email of new user
password	string		password for new user
first_name	string	optional	first name of new user
last_name	string	optional	last name of new user
number	string	optional	phone number of new user
options	CreateUserOptions	optional	create user optional settings

public UserCreateResponse: Object source

Create user response data

Properties:

Name	Type	Attribute	Description
id	string		user unique id
verified	number		user is verified or not
email	string		user email

public UserGetParams: Object source

Get user payload

Properties:

Name	Type	Attribute	Description
token	string		your auth token

public UserGetResponse: Object source

Retrieve user response data

Properties:

Name	Type	Attribute	Description
id	string		user unique id
first_name	string		first name
last_name	string		last name
active	number		user is active or not
created	string		user creation timestamp
emails	string[]		user emails
primary_email	string		user primary email
subscriptions	Object[]		user subscriptions data
cloud_export_account_details	Object	nullable: true	cloud export account details data
is_logged_in	boolean		user is logged in or not
billing_period	{start_date: string, end_date: string, start_timestamp: number, end_timestamp: number}		user billing period data
companies	Object[]		companies where user is a member of
registration_source	string	nullable: true	resource where user was registered
teams	Object[]		teams where user is a member of
settings	Object		user specific settings
organization_settings	Object[]		organization specific settings where user is a member of
merchant_accounts	Object[]		merchant accounts data

public UserVerifyEmailParams: Object source

Verify user email payload

Properties:

Name	Type	Attribute	Description
email	string		email to verify

public UserVerifyEmailResponse: Object source

Verify user email response data

Properties:

Name	Type	Attribute	Description
status	string		status of verification email sending, e.g. 'success'