References

summary
public	F init(params: InitParams): Features SignNow API client initialization
public	T ApiError: Object Api error object
public	T ApiErrorResponse: ApiError[] \| ApiError \| Error \| string Api error response
public	T Features: Object Api client features
public	T InitParams: Object Api client initialization params

document

summary
public	C Document Document methods
public	T AttachmentField: Object
public	T CalculatedField: Object
public	T CancelFreeformInviteParams: Object Cancel freeform invite payload
public	T CancelFreeformInviteResponse: Object Cancel freeform invite response data
public	T CheckField: Object
public	T DocumentCreateParams: Object Create document payload
public	T DocumentCreateResponse: Object Create document response data
public	T DocumentDownloadOptions: Object Download document optional settings
public	T DocumentDownloadParams: Object Document download payload
public	T DocumentDownloadResponse: Buffer Document binary data
public	T DocumentEvent: Object Document action log item
public	T DocumentFieldExtractParams: Object Upload document with field extract payload
public	T DocumentFieldExtractResponse: Object Upload document with field extract response data
public	T DocumentFieldInviteCancelParams: Object Cancel document field invite payload
public	T DocumentFieldInviteCancelResponse: Object Cancel document field invite response data
public	T DocumentFieldInviteResponse: Object Create document field invite response data
public	T DocumentFields: Object
public	T DocumentFreeformInviteResponse: Object Create document free form invite response data
public	T DocumentHistoryParams: Object Document history payload
public	T DocumentHistoryResponse: DocumentEvent[] Document history response data
public	T DocumentInviteOptions: Object Document invite optional settings
public	T DocumentInviteParams: Object Create document invite payload
public	T DocumentInviteResponse: DocumentFieldInviteResponse \| DocumentFreeformInviteResponse Create document invite response data
public	T DocumentInviteSettings: Object Document invite settings
public	T DocumentListItem: Object Document list response item
public	T DocumentListParams: Object Payload to receive user's document list
public	T DocumentListResponse: DocumentListItem[] User's Document list response
public	T DocumentMergeOptions: Object Merge documents optional settings
public	T DocumentMergeParams: Object Merge documents payload
public	T DocumentMergeResponse: Object Merge documents response data
public	T DocumentRemoveOptions: Object Document remove optional settings
public	T DocumentRemoveParams: Object Remove document payload
public	T DocumentRemoveResponse: Object Remove document response data
public	T DocumentShareParams: Object Document share payload
public	T DocumentShareResponse: Object Document share response data
public	T DocumentSignersOptions: Object Get Document Signers optional settings
public	T DocumentSignersParams: Object Get Document Signers payload
public	T DocumentSignersResponse: Object Get Document Signers response data
public	T DocumentThumbnails: Object Document thumbnail urls with different sizes (small, medium, large)
public	T DocumentUpdateParams: Object Update document payload
public	T DocumentUpdateResponse: Object Update document response data
public	T DocumentViewParams: Object Document view payload
public	T DocumentViewResponse: Object Document view response of specific document
public	T EnumerationField: Object
public	T FormulaTree: Object
public	T FormulaTreeBranch: Object
public	T FormulaTreeBranchTerminator: Object
public	T InitialsField: Object
public	T RadioButton: Object
public	T RadioButtonField: Object
public	T SignatureField: Object
public	T SignerSettings: Object Document invite signer settings
public	T TextField: Object

document-group

summary
public	C DocumentGroup Document Group methods
public	T DocumentGroupCancelInviteParams: Object Cancel Document Group Invite payload
public	T DocumentGroupCancelInviteResponse: Object Cancel Document Group Invite response data
public	T DocumentGroupCreateParams: Object Create document group payload
public	T DocumentGroupCreateResponse: Object Create document group response data
public	T DocumentGroupDownloadParams: Object Document Group download payload
public	T DocumentGroupDownloadResponse: Buffer Document Group binary data
public	T DocumentGroupInviteAction: Object Document Group invite action configurations
public	T DocumentGroupInviteAuthenticationPassword: Object Document Group signer's authentication with password config
public	T DocumentGroupInviteAuthenticationPhoneCall: Object Document Group signer's authentication with phone call config
public	T DocumentGroupInviteAuthenticationPhoneSMS: Object Document Group signer's authentication with phone SMS config
public	T DocumentGroupInviteCompletionEmailConfig: Object Document Group invite completion email configuration
public	T DocumentGroupInviteEmail: Object Document Group invite email configurations
public	T DocumentGroupInviteParams: Object Create Document Group invite payload
public	T DocumentGroupInviteResponse: Object Create Document Group invite response data
public	T DocumentGroupInviteSettings: Object Document Group invite settings
public	T DocumentGroupInviteStep: Object Document Group invite step configurations
public	T DocumentGroupItem: Object Details of single Document in group
public	T DocumentGroupViewParams: Object Document Group view payload
public	T DocumentGroupViewResponse: Object Document Group view response data

document-group-template

summary
public	C DocumentGroupTemplate Document Group Template methods
public	T DocumentGroupTemplateCreateParams: Object Create Document Group Template payload
public	T DocumentGroupTemplateCreateResponse: Object Create Document Group Template response data
public	T DocumentGroupTemplateInviteAction: Object Document Group Template invite action congfigurations
public	T DocumentGroupTemplateInviteEmail: Object Document Group Template invite email congfigurations
public	T DocumentGroupTemplateInviteParams: Object Create Document Group Template invite payload
public	T DocumentGroupTemplateInviteResponse: DocumentGroupInviteResponse Create Document Group Template invite response data
public	T DocumentGroupTemplateInviteStep: Object Document Group Template invite step congfigurations
public	T DocumentGroupTemplateItem: Object Details of single template in group
public	T DocumentGroupTemplateRoutingDetails: Object Document Group Template invite congfigurations
public	T DocumentGroupTemplateViewParams: Object Document Group Template view payload
public	T DocumentGroupTemplateViewResponse: Object Document Group Template view response

embedded

summary
public	C Embedded Embedded methods
public	T EmbeddedCancelInvitePayload: Object Delete embedded invites for a document payload
public	T EmbeddedCancelInviteResponse: Object Generate a link for the embedded invite response data
public	T EmbeddedCreateInvitesPayload: Object Create embedded signing invites payload
public	T EmbeddedCreateInvitesResponse: Object Create embedded signing invites response data
public	T EmbeddedGenerateLinkPayload: Object Generate embedded invite link payload
public	T EmbeddedGenerateLinkResponse: Object Generate a link for the embedded invite response data
public	T EmbeddedGeneratedLink: Object Response EmbeddedGeneratedLink
public	T EmbeddedInvite: Object Response EmbeddedInvite
public	T EmbeddedSigningInvite: Object Create embedded signing invite payload

link

summary
public	C Link Link methods
public	T SigningLinkCreateParams: Object Create signing link payload
public	T SigningLinkCreateResponse: Object Create signing link response data

oauth2

summary
public	C OAuth2 OAuth2 methods
public	T AccessTokenGetParams: Object Request access token payload
public	T AccessTokenGetResponse: Object Request access token response data
public	T AccessTokenRefreshParams: Object Refresh access token payload
public	T AccessTokenRefreshResponse: Object Refresh access token response data
public	T AccessTokenVerifyParams: Object Verify access token payload
public	T AccessTokenVerifyResponse: Object Verify access token response data

template

summary
public	C Template Template methods
public	T TemplateBulkInviteParams: Object Send Template Bulk Invite payload
public	T TemplateBulkInviteResponse: Object Send Template Bulk Invite response data
public	T TemplateBulkInviteSettings: Object Template Bulk Invite settings
public	T TemplateCreateOptions: Object Document invite optional settings
public	T TemplateCreateParams: Object Create template payload
public	T TemplateCreateResponse: Object Create template response data
public	T TemplateDuplicateParams: Object Copy template payload
public	T TemplateDuplicateResponse: Object Copy template response data
public	T TemplateGetRoutingDetailsParams: Object Get Template Routing Details payload
public	T TemplateGetRoutingDetailsResponse: Object Get Template Routing Details response data
public	T TemplateInviteParams: DocumentInviteParams Create invite with template payload
public	T TemplateInviteResponse: DocumentInviteResponse Create invite with template response data
public	T TemplateRemoveParams: DocumentRemoveParams Remove template payload
public	T TemplateRemoveResponse: DocumentRemoveResponse Remove template response data
public	T TemplateRoutingDetailsCCStep: Object Template Routing Details CC step info
public	T TemplateRoutingDetailsItem: Object Template Routing Details item data
public	T TemplateUpdateRoutingDetailsItem: Object Template Update Routing Details item data
public	T TemplateUpdateRoutingDetailsParams: Object Update Template Routing Details payload
public	T TemplateUpdateRoutingDetailsResponse: Object Update Template Routing Details response data
public	T TemplateUpdateRoutingDetailsSettings: Object Update Template Routing Details settings
public	T TemplateUpdateSigningRoleParams: Object Update Signing Role payload
public	T TemplateUpdateSigningRoleResponse: Object Update Signing Role response data

user

summary
public	C User User methods
public	T CreateUserOptions: Object Create User optional settings
public	T UserCreateParams: Object Create user payload
public	T UserCreateResponse: Object Create user response data
public	T UserGetParams: Object Get user payload
public	T UserGetResponse: Object Retrieve user response data
public	T UserVerifyEmailParams: Object Verify user email payload
public	T UserVerifyEmailResponse: Object Verify user email response data

Directories

document

document-group

document-group-template