Public
Documentation Settings
Preparing
Double Column
cURL - cURL
DottedSign API
Introduction
Schemas
Groups
SignTasks
Templates
Oauth
PublicForms
FileMissions
Members

DottedSign API

DottedSign API

Schemas

Parameters

Request Header Parameters

NameTypeRequiredDescription
AcceptCsvstringXAccept json or csv.
AcceptZipstringXAccept json or zip.
AuthorizationstringOOAuth2 Bearer token.
CodestringXJWT code for quick sign authentication, same as the code in response of the Get the share link API.
OptionalAuthorizationstringXOAuth2 Bearer token.

Request Query Parameters

NameTypeRequiredDescription
pageintegerXPage number.
per_pageintegerXNumber of items per page.
order_bystringXOrder by.
has_orderbooleanXSigners should sign sequentially or not.
field_keystringXField key. Required if field_value is provided.
field_valuestringXField value. Required if field_key is provided.
file_namestringXTask name.
metadata_keystringXMetadata key. Required if metadata_value is provided.
metadata_valuestringXMetadata value. Required if metadata_key is provided.
signerstringXSigner's email or name.
sort_typestringXSort type.

Requests

CredentialRequest

NameTypeRequiredDescription
client_idStringOClient ID.
client_secretStringOClient secret.
grant_typeStringOOAuth Grant type.
enum: client_credentials, authorization_code and refresh_token.
scopeStringXOAuth Scope (separated by a space). See API scopes for more details. Used when grant_type is client_credentials.
codeStringXAuthorization code. Used when grant_type is authorization_code.
redirect_uriStringXRedirect URI. Used when grant_type is authorization_code.
refresh_tokenStringXRefresh token. Used when grant_type is refresh_token.

DummyStageRequest

NameTypeRequiredDescription
roleStringORole.
emailStringXEmail.
max-length: 250.
stage_typeStringXStage type (Recipient type).
enum: sign and edit.
attachment_settingsArrayXSee StageRequestAttachmentSetting for more details.
custom_message_settingObjectXSee StageRequestCustomMessageSetting for more details.
field_settingsArrayXField settings. Required if stage_type is sign.
See FieldSettingRequest for more details.
field_setting_groupsArrayXSee FieldSettingGroupRequest for more details.
review_stagesArrayXSee ReviewStageRequest for more details.
stage_settingObjectXSee StageSettingRequest for more details.
verify_methodsArrayXSee VerifyMethodRequest for more details.

FieldSettingGroupRequest

NameTypeRequiredDescription
field_group_typeStringOField group type.
enum: checkbox and radio.
field_group_object_idStringOField group object ID. Only used for mapping field settings to field group.
optionsObjectXField group options.
See FieldSettingGroupRequest_Options for more details.

FieldSettingGroupRequest_Options

NameTypeRequiredDescription
forceBooleanXForce to fill or not.
read_onlyBooleanXRead only or not.

FieldSettingRequest

NameTypeRequiredDescription
field_typeStringOField type.
enum: signature, textfield, datefield, checkbox, radio, image and link.
field_group_object_idStringXField group object ID. Required if field type is checkbox or radio.
For radio fields, there must be a minimum of two field_settings sharing the same field_group_object_id.
For both checkbox and radio types, the field_group_object_id can encompass up to 50 field_settings.
pageIntegerOPage number. Starts from 0.
coordArrayOField coordinates, consisting of 4 numbers. These numbers represent the left-x, bottom-y, right-x, and top-y coordinates, respectively.
optionsObjectXSee FieldSettingRequestOptions for more details.
search_keyStringXSearch key.

FieldSettingRequestOptions

NameTypeRequiredDescription
defaultString or Boolean or IntegerXDefault value.
Default "" for textfield; null for signature, datefield and link; false for checkbox and radio.
Available field_types include signature, textfield, datefield, checkbox, radio, and link.
forceBooleanXForce to fill or not.
Default true for signature, textfield, datefield, image, and link.
Available field_types include signature, textfield, datefield, link, and image.
default_typeStringXDefault value type for signature.
Available field_types include signature.

enum: seal and signature.
read_onlyBooleanXRead only or not.
Available field_types include textfield, datefield, and link.
is_multi_lineBooleanXMulti-line or not.
Available field_types include textfield.
placeholderStringXPlaceholder.
Available field_types include signature, textfield, datefield, link, and image.
font_sizeIntegerXFont size.
Available field_types include textfield, datefield, and link.

min: 8, max: 34.
font_size_fixedBooleanXFont size fixed or not.
Available field_types include textfield, datefield, and link.
alignmentStringXAlignment.
Available field_types include textfield, datefield, and link. Default left

enum: left, center and right.
alignment_fixedBooleanXAlignment fixed or not.
Available field_types include textfield, datefield, and link.
lengthIntegerXLength.
Available field_types include textfield.

min: 1, max: 500.
validationStringXValidation type.
Available field_types include textfield.

enum: email, numbers, letters and regex.
validation_regexStringXValidation regex. Required if validation is regex.
Available field_types include textfield.
date_formatStringXDate format.
Available field_types include datefield.

enum: yyyy-mm-dd, yyyy/mm/dd, dd/mm/yyyy and mm-dd-yyyy.
date_settingStringXDate setting.
Available field_types include datefield.

enum: current_only, future_enable, past_enable and no_limit.
zoneIntegerXTime zone.
Available field_types include datefield.

min: -12, max: 14.

FieldSettingRequestQuickCreate

NameTypeRequiredDescription
search_keyStringOSearch key.
optionsObjectOSee FieldSettingRequestQuickCreateOptions for more details.

FieldSettingRequestQuickCreateOptions

NameTypeRequiredDescription
defaultString or Boolean or IntegerXDefault value.
Default "" for textfield; null for signature, datefield and link; false for checkbox and radio.
Available field_types include signature, textfield, datefield, checkbox, radio, and link.
zoneIntegerXTime zone.
Available field_types include datefield.

min: -12, max: 14.

FileMissionRequestCreate

NameTypeRequiredDescription
file_objectsArrayOSee FileMissionRequestCreate_FileObjects for more details.

FileMissionRequestCreate_FileObjects

NameTypeRequiredDescription
file_nameStringOFile name.

FileMissionRequestRenew

NameTypeRequiredDescription
file_mission_idIntegerOFile mission ID.
file_objectsArrayOSee FileMissionRequestRenew_FileObjects for more details.

FileMissionRequestRenew_FileObjects

NameTypeRequiredDescription
file_object_idStringXFile object ID.
file_nameStringOFile name.
page_countIntegerXPage count.
checksumStringXChecksum.

GroupRequest

NameTypeRequiredDescription
nameStringXGroup name.
email_sender_ruleStringXDisplay rule for email sender.
enum: default, custom_name, sender_email and sender_name.
email_custom_nameStringXCustom name for email signers. Required if email_sender_rule is provided.
base64_icon_fileStringXBase64 string of icon file.

MemberRequest

NameTypeRequiredDescription
nameStringXMember name.
langStringXMember language.
enum: de, en, es, it, ja, fa, ko, zh-CN and zh-TW.
base64_icon_fileStringXBase64 string of icon file.

PublicFormRequest

NameTypeRequiredDescription
form_nameStringXForm name.
max-length: 255.
descriptionStringXForm description.
max-length: 500.
goal_numIntegerXThe number of task required to complete the form. If -1, then the form is not limited by the number of tasks.
end_atIntegerXForm ended up timestamp.
signer_infosArrayXForm stage signers info. The number of stages should be equal to the number of the used template.
See PublicFormRequestSignerInfo for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

PublicFormRequestCreate

NameTypeRequiredDescription
template_idIntegerOTemplate ID.
form_nameStringOForm name.
max-length: 255.
descriptionStringXForm description.
max-length: 500.
goal_numIntegerXThe number of task required to complete the form. If -1, then the form is not limited by the number of tasks.
end_atIntegerXForm ended up timestamp.
signer_infosArrayOForm stage signers info. The number of stages should be equal to the number of the used template.
See PublicFormRequestSignerInfo for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

PublicFormRequestID

NameTypeRequiredDescription
form_idIntegerOForm ID.

PublicFormRequestSignerInfo

NameTypeRequiredDescription
signer_typeStringOSpecifies the type of signer in the form stage:
- form_signer: an unspecified user who only needs to provide basic information like name or email when signing
- normal_signer: a designated user

The first signer in the sequence must be a form_signer, and all normal_signers must follow after all form_signers.

enum: form_signer and normal_signer.
nameStringXForm stage signer name. Required if signer_type is normal_signer.
emailStringXForm stage signer email. Required if signer_type is normal_signer.
max-length: 250.
phoneStringXForm stage signer phone (area code + number). Required if signer_type is normal_signer, and the used template requires SMS OTP.
requisiteObjectXSee PublicFormSignerInfoRequisite for more details.

PublicFormRequestUpdateStatus

NameTypeRequiredDescription
form_idIntegerOForm ID.
statusStringOForm status.
enum: publish and unpublish.

ReviewStageRequest

NameTypeRequiredDescription
base_stage_sequenceIntegerOBase stage sequence. If reviewer is owner, then 0; otherwise signer's stage sequence (start from 1).

SignStageRequest

NameTypeRequiredDescription
nameStringOName.
emailStringOEmail.
max-length: 250.
stage_typeStringXStage type (Recipient type).
enum: sign and edit.
attachment_settingsArrayXSee StageRequestAttachmentSetting for more details.
custom_message_settingObjectXSee StageRequestCustomMessageSetting for more details.
field_settingsArrayXField settings. Required if stage_type is sign.
See FieldSettingRequest for more details.
field_setting_groupsArrayXSee FieldSettingGroupRequest for more details.
review_stagesArrayXSee ReviewStageRequest for more details.
stage_settingObjectXSee StageSettingRequest for more details.
verify_methodsArrayXSee VerifyMethodRequest for more details.

SignTaskRequestChangeSigner

NameTypeRequiredDescription
task_idIntegerOTask ID.
stage_idIntegerOStage ID.
reasonStringXThe reason to change signer.
new_signerObjectXSee SignTaskRequestChangeSigner_NewSigner for more details.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign.
See SignTaskRequestChangeSigner_VerifyInfo for more details.

SignTaskRequestChangeSigner_NewSigner

NameTypeRequiredDescription
emailStringOEmail.
nameStringXName.
phoneStringXPhone (area code + number).

SignTaskRequestChangeSigner_VerifyInfo

NameTypeRequiredDescription
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignTaskRequestConfirm

NameTypeRequiredDescription
task_idIntegerOTask ID.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign. See Read a Task with OTP Verification for more details about the verification process.
See SignTaskRequestConfirm_VerifyInfo for more details.

SignTaskRequestConfirm_VerifyInfo

NameTypeRequiredDescription
uuidStringXVerify method UUID.
verify_dataStringXOTP code.
identity_verify_tokenStringXIdentity verify token.
account_protect_tokenStringXAccount protect token.
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignTaskRequestCreate

NameTypeRequiredDescription
template_idIntegerXTemplate ID. Required if task is created from template.
base64_fileStringXBase64 string of PDF file. Required if task is created from file.
file_mission_idIntegerXFile mission ID returned from the Create a file mission API. Required if task is created from multiple files.
file_nameStringOFile name.
*File name should match the pattern `^(?!.["*:<>?/\
has_orderBooleanXSigners should sign sequentially or not.
watermark_idIntegerXWatermark ID.
Currently, this only supports the use of watermark_id that have been used in a template.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
startBooleanXStart the task after creation or not.
stagesArrayOSee SignStageRequest for more details.
task_settingObjectXSee TaskSettingRequest for more details.

SignTaskRequestID

NameTypeRequiredDescription
task_idIntegerOTask ID.

SignTaskRequestQuickCreate

NameTypeRequiredDescription
file_nameStringOFile name.
*File name should match the pattern `^(?!.["*:<>?/\
template_idIntegerOTemplate ID. Required if task is created from template.
task_settingObjectXSee TaskSettingRequest for more details.
stagesArrayOSee SignTaskRequestQuickCreate_Stages for more details.
startBooleanXStart the task after creation or not.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

SignTaskRequestQuickCreate_Stages

NameTypeRequiredDescription
emailStringOEmail.
nameStringOName.
custom_message_settingObjectXSee StageRequestCustomMessageSetting for more details.
field_settingsArrayXSee FieldSettingRequestQuickCreate for more details.
stage_settingObjectXSee StageSettingRequest for more details.
verify_methodsArrayXSee VerifyMethodRequest for more details.

SignTaskRequestReview

NameTypeRequiredDescription
task_idIntegerOTask ID.
review_messageStringXReview reject message.
review_fieldsArrayOSee SignTaskRequestReview_ReviewFields for more details.
review_attachmentsArrayXSee SignTaskRequestReview_ReviewAttachments for more details.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign. See Read a Task with OTP Verification for more details about the verification process.
See SignTaskRequestReview_VerifyInfo for more details.

SignTaskRequestReview_ReviewAttachments

NameTypeRequiredDescription
attachment_idStringOAttachment ID.
acceptedBooleanOAttachment review result.

SignTaskRequestReview_ReviewFields

NameTypeRequiredDescription
field_object_idStringOField object ID returned from the Read a task API.
acceptedBooleanOField review result.

SignTaskRequestReview_VerifyInfo

NameTypeRequiredDescription
uuidStringXVerify method UUID.
verify_dataStringXOTP code.
identity_verify_tokenStringXIdentity verify token.
account_protect_tokenStringXAccount protect token.
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignTaskRequestSaveTemplate

NameTypeRequiredDescription
task_idIntegerOTask ID.
file_nameStringXFile name.
*File name should match the pattern `^(?!.["*:<>?/\

SignTaskRequestSign

NameTypeRequiredDescription
task_idIntegerOTask ID.
sign_infosArrayXSee SignTaskRequestSign_SignInfos for more details.
attachment_infosArrayXSee SignTaskRequestSign_AttachmentInfos for more details.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign. See Read a Task with OTP Verification for more details about the verification process.
See SignTaskRequestSign_VerifyInfo for more details.

SignTaskRequestSign_AttachmentInfos

NameTypeRequiredDescription
attachment_idStringOAttachment ID.
attachment_typeStringOAttachment type.

SignTaskRequestSign_SignInfos

NameTypeRequiredDescription
field_object_idStringOField object ID returned from the Read a task API.
field_typeStringOField type.
field_valueString or Boolean or IntegerXField value.
Integer if field_type is signature or image; Boolean if field_type is checkbox or radio; String if field_type is text_field or date_field.
field_value_typeStringXField value type, including signature and seal. Required if field_type is signature.

SignTaskRequestSign_VerifyInfo

NameTypeRequiredDescription
uuidStringXVerify method UUID.
verify_dataStringXOTP code.
identity_verify_tokenStringXIdentity verify token.
account_protect_tokenStringXAccount protect token.
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignTaskRequestUpdate

NameTypeRequiredDescription
file_mission_idIntegerXFile mission ID returned from the Create a file mission or Renew a file mission API.
task_idIntegerOTask ID.
file_nameStringXFile name.
*File name should match the pattern `^(?!.["*:<>?/\
has_orderBooleanXSigners should sign sequentially or not.
watermark_idIntegerXWatermark ID.
Currently, this only supports the use of watermark_id that have been used in a template.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
startBooleanXStart the task after creation or not.
stagesArrayXSee SignStageRequest for more details.
task_settingObjectXSee TaskSettingRequest for more details.

SignTaskRequestUpdateSettings

NameTypeRequiredDescription
task_idIntegerOTask ID.
stagesArrayXSee SignTaskRequestUpdateSettings_Stages for more details.
task_settingObjectXSee TaskSettingRequest for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.

SignTaskRequestUpdateSettings_Stages

NameTypeRequiredDescription
stage_idIntegerXStage ID.
custom_message_settingObjectXSee StageRequestCustomMessageSettingCompletedViewable for more details.
stage_settingObjectXSee StageSettingRequest for more details.
verify_methodsArrayXSee VerifyMethodRequest for more details.

SignTaskRequestUploadImages

NameTypeRequiredDescription
rawStringXRaw image in base64.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign.
See SignTaskRequestUploadImages_VerifyInfo for more details.

SignTaskRequestUploadImages_VerifyInfo

NameTypeRequiredDescription
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignatureRequestCreate

NameTypeRequiredDescription
categoryStringXSpecifies the category of the signature:
- initial: the first signature in the Handwriting section on the Settings > Signature page or the Handwriting tab in the signature modal when signing
- signature: the second signature in the same section or tab as initial
- stamp: the stamp in the Image section on the Settings > Signature page or the Image tab in the signature modal when signing

Each user can create at most one initial and one signature category respectively. Default is signature.

enum: initial, signature and stamp.
rawStringORaw signature image in base64.
verify_infoObjectXVerify information for identity verification, account protection, and quick sign.
See SignatureRequestCreate_VerifyInfo for more details.

SignatureRequestCreate_VerifyInfo

NameTypeRequiredDescription
verify_tokenStringXVerify token returned from the Consent to quick sign API. Required if authentication is via JWT Code.

SignatureRequestID

NameTypeRequiredDescription
signature_idIntegerOSignature ID.

SourceSettingRequestCcInfo

NameTypeRequiredDescription
emailStringOCC email.
max-length: 250.
nameStringOCC name.
viewable_source_filesArrayXFiles that can be viewed by the CC recipient. Using file_object_ids returned when creating the file mission.

SourceSettingRequestReferenceSetting

NameTypeRequiredDescription
file_nameStringOReference name.
reference_idStringOReference ID.
reference_typeStringOReference file type.

StageRequestAttachmentSetting

NameTypeRequiredDescription
attachment_idStringOAttachment ID (will be replaced after task is created). Should be unique in the task.
file_nameStringOAttachment name.
forceBooleanXSigner must upload attachment or not.
viewable_in_processingBooleanXAttachment is viewable by other signers or not, will be effective along with viewable_in_processing in StageSettingRequest. The signer who is also the owner will be true.

StageRequestCustomMessageSetting

NameTypeRequiredDescription
viewable_in_processingBooleanXCustom message is viewable by other signers or not when task is processing.
viewable_in_completedBooleanXCustom message is viewable by other signers or not when task is completed.

StageRequestCustomMessageSettingCompletedViewable

NameTypeRequiredDescription
viewable_in_completedBooleanXCustom message is viewable by other signers or not when task is completed.

StageSettingRequest

NameTypeRequiredDescription
forward_enableBooleanXAvailable to change signer.
For signer who is also the task owner, this option must be and defaults to true; otherwise, it defaults to false
decline_enableBooleanXAvailable to decline the task.
For signer who is also the task owner, this option must be and defaults to false; otherwise, it defaults to true
viewable_in_processingBooleanXAvailable to view attachments when task is processing.
viewable_in_completedBooleanXAvailable to view attachments when task is completed.
viewable_source_filesArrayXFiles that can be viewed by the recipient. Using file_object_ids returned when creating the file mission.
informableBooleanXInform the signer through email or not when task is updated.
reviewed_skip_confirmBooleanXDo not need to confirm when signer's stage is reviewed.

TaskSettingRequest

NameTypeRequiredDescription
deadlineIntegerXDeadline in timestamp.
forget_remindBooleanXRemind the signer or not when task is waiting for signing.
expire_remindBooleanXRemind the signer or not when task is going to be expired.
remind_days_before_expireIntegerXDays before expire to remind the signer.
enum: 1, 2 and 3.
cc_infosArrayXSee SourceSettingRequestCcInfo for more details.
messageStringXMessage to the signer when task is processing.
max-length: 500.
completed_messageStringXMessage to the signer when task is completed.
max-length: 500.
reference_settingsArrayXReference information viewable to signers when task is processing.
Currently, this only supports the use of references that have been predefined in a template.

See SourceSettingRequestReferenceSetting for more details.
completed_reference_settingsArrayXReference information viewable to signers when task is completed.
Currently, this only supports the use of references that have been predefined in a template.

See SourceSettingRequestReferenceSetting for more details.
receiver_langStringXLanguage displayed for the signer, only effective if signer has not set his preferred language.
enum: de, en, es, it, ja, fa, ko, zh-CN and zh-TW.
owner_informableBooleanXInform the owner through email or not when task is updated.

TemplateRequestCreate

NameTypeRequiredDescription
base64_fileStringXBase64 string of PDF file. Required if task is created from file.
file_mission_idIntegerXFile mission ID returned from the Create a file mission API. Required if task is created from multiple files.
file_nameStringOFile name.
*File name should match the pattern `^(?!.["*:<>?/\
has_orderBooleanXSigners should sign sequentially or not.
watermark_idIntegerXWatermark ID.
Currently, this only supports the use of watermark_id that have been used in a template.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
stagesArrayOSee DummyStageRequest for more details.
template_settingObjectXSee TemplateSettingRequest for more details.

TemplateRequestDuplicate

NameTypeRequiredDescription
template_idIntegerOTemplate ID.
file_nameStringXFile name.
*File name should match the pattern `^(?!.["*:<>?/\

TemplateRequestID

NameTypeRequiredDescription
template_idIntegerOTemplate ID.

TemplateRequestUpdate

NameTypeRequiredDescription
file_mission_idIntegerXFile mission ID returned from the Create a file mission or Renew a file mission API.
template_idIntegerOTemplate ID.
file_nameStringXFile name.
*File name should match the pattern `^(?!.["*:<>?/\
has_orderBooleanXSigners should sign sequentially or not.
watermark_idIntegerXWatermark ID.
Currently, this only supports the use of watermark_id that have been used in a template.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
stagesArrayXSee DummyStageRequest for more details.
template_settingObjectXSee TemplateSettingRequest for more details.

TemplateSettingRequest

NameTypeRequiredDescription
deadlineIntegerXDeadline in timestamp.
forget_remindBooleanXRemind the signer or not when task is waiting for signing.
expire_remindBooleanXRemind the signer or not when task is going to be expired.
remind_days_before_expireIntegerXDays before expire to remind the signer.
enum: 1, 2 and 3.
cc_infosArrayXSee SourceSettingRequestCcInfo for more details.
messageStringXMessage to the signer when task is processing.
max-length: 500.
completed_messageStringXMessage to the signer when task is completed.
max-length: 500.
reference_settingsArrayXReference information viewable to signers when task is processing.
Currently, this only supports the use of references that have been predefined in a template.

See SourceSettingRequestReferenceSetting for more details.
completed_reference_settingsArrayXReference information viewable to signers when task is completed.
Currently, this only supports the use of references that have been predefined in a template.

See SourceSettingRequestReferenceSetting for more details.
receiver_langStringXLanguage displayed for the signer, only effective if signer has not set his preferred language.
enum: de, en, es, it, ja, fa, ko, zh-CN and zh-TW.
owner_informableBooleanXInform the owner through email or not when task is updated.

VerifyMethodRequest

NameTypeRequiredDescription
verify_typeStringOVerify type.
Available verify types depend on the user's pricing plan or group's settings.

enum: email and sms.
verify_sourceStringXVerify source (area code + number). Required if verify_type is sms.
occasionStringXVerify occasion.
enum: sign and read.

Responses

Basic

NameTypeNullableDescription
dataObjectXData.

BasicError

NameTypeNullableDescription
error_codeIntegerXError code.
error_messageStringXError message.
error_keyStringXError key.

CredentialToken

NameTypeNullableDescription
access_tokenStringXAccess token.
refresh_tokenStringXRefresh token.
token_typeStringXToken type.
expires_inIntegerXToken expiration time in seconds.
scopeStringXToken scopes.
created_atIntegerXToken creation timestamp.

DummyStage

NameTypeNullableDescription
stage_idIntegerXStage ID.
roleStringXSigner's role.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.

DummyStageAdvanced

NameTypeNullableDescription
stage_idIntegerXStage ID.
roleStringXSigner's role.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.
stage_settingObjectXSee StageSetting for more details.
custom_message_settingObjectXSee StageCustomMessageSetting for more details.

DummyStageFull

NameTypeNullableDescription
stage_idIntegerXStage ID.
roleStringXSigner's role.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.
stage_settingObjectXSee StageSetting for more details.
custom_message_settingObjectXSee StageCustomMessageSetting for more details.
attachment_settingsArrayXSee StageAttachmentSetting for more details.
field_settingsArrayXSee FieldSetting for more details.
field_setting_groupsArrayXSee FieldSettingGroup for more details.
review_stagesArrayXSee ReviewStage for more details.
verify_methodsArrayXSee VerifyMethod for more details.

FieldSetting

NameTypeNullableDescription
field_typeStringXField type.
enum: signature, textfield, datefield, checkbox and radio.
field_valueString or Boolean or IntegerOField value.
field_value_typeStringOField value type.
enum: signature, guest_signature and seal.
field_object_idStringXField object ID.
field_group_object_idStringOField group object ID.
Used for checkbox and radio.
pageIntegerXPage number. Starts from 0.
coordArrayXField coordinates, consisting of 4 numbers. These numbers represent the left-x, bottom-y, right-x, and top-y coordinates, respectively.
optionsObjectXField options.
See FieldSetting_Options for more details.

FieldSettingGroup

NameTypeNullableDescription
field_group_typeStringXField group type.
enum: checkbox and radio.
field_group_object_idStringXField group object ID.
optionsObjectXSee FieldSettingGroup_Options for more details.

FieldSettingGroup_Options

NameTypeNullableDescription
forceBooleanXForce to fill or not.
read_onlyBooleanXRead only or not.

FieldSetting_Options

NameTypeNullableDescription
forceBooleanXForce to fill or not.
Used for signature, textfield, datefield, link, and image.
defaultStringODefault value.
Used for textfield, signature, datefield, and link.
default_typeStringODefault value type.
Used for signature.

enum: seal and signature.
read_onlyBooleanXRead only or not.
Used for textfield, datefield, checkbox, radio, and link.
is_multi_lineBooleanXMulti-line or not.
Used for textfield.
placeholderStringXPlaceholder.
Used for signature, textfield, datefield, link, and image.
font_sizeIntegerXFont size.
Used for textfield, datefield, link.

min: 8, max: 34.
font_size_fixedBooleanXFont size fixed or not.
Used for textfield, datefield, and link.
alignmentStringXAlignment.
Used for textfield, datefield, and link.

enum: left, center and right.
alignment_fixedBooleanXAlignment fixed or not.
Used for textfield, datefield, and link.
lengthIntegerXLength.
Used for textfield.
validationStringXValidation type.
Used for textfield.

enum: email, numbers, letters and regex.
validation_regexStringXValidation regex.
Used for textfield when validation is regex.
date_formatStringXDate format.
Used for datefield.

enum: yyyy-mm-dd, yyyy/mm/dd, dd/mm/yyyy and mm-dd-yyyy.
date_settingStringXDate setting.
Used for datefield.

enum: current_only, current_future, current_past and all.
zoneIntegerXTime zone.
Used for datefield.

min: -12, max: 12.

FileMission

NameTypeNullableDescription
file_mission_idIntegerXFile mission ID.
statusStringXFile mission status.
enum: file_uploading, processing, completed, failed and deleted.
upload_linkObjectXLink for uploading files that have not yet been uploaded. This key will be deprecated in the future; please use the 'files' key instead.
See FileMission_UploadLink for more details.
filesArrayXSee FileMission_Files for more details.

FileMissionData

NameTypeNullableDescription
dataObjectXSee FileMission for more details.

FileMissionInfo

NameTypeNullableDescription
file_mission_idIntegerXFile mission ID.
statusStringXFile mission status.
enum: file_uploading, processing, completed, failed and deleted.

FileMission_Files

NameTypeNullableDescription
file_object_idIntegerXFile object ID.
file_nameStringXFile name without extension.
page_countIntegerXPage count.
checksumStringXChecksum.
upload_linkStringXUpload link of the file.

FileMission_UploadLink

NameTypeNullableDescription
filesArrayXSee FileMission_UploadLink_Files for more details.

FileMission_UploadLink_Files

NameTypeNullableDescription
file_object_idIntegerXFile object ID.
file_nameStringXFile name without extension.
upload_linkStringXUpload link of the file.

Group

NameTypeNullableDescription
group_idIntegerXGroup ID.
nameStringXGroup name.
statusStringXGroup status.
enum: active, expired and archived.
email_sender_ruleStringXDisplay rule for email sender.
enum: default, custom_name, sender_email and sender_name.
email_custom_nameStringXCustom name for email sender. Required if email_sender_rule is provided.
icon_urlObjectXSee Group_IconUrl for more details.
decline_optionsArrayXSee Group_DeclineOptions for more details.

GroupData

NameTypeNullableDescription
dataObjectXSee Group for more details.

GroupID

NameTypeNullableDescription
dataObjectXSee GroupID_Data for more details.

GroupID_Data

NameTypeNullableDescription
group_idIntegerXGroup ID.

GroupPermission

NameTypeNullableDescription
view_usersBooleanXCan view group members.
manage_usersBooleanXCan manage group members.
manage_permissionBooleanXCan manage group permissions.
manage_subgroupsBooleanXCan manage subgroups.
view_team_tasksBooleanXCan view team tasks.
view_team_tasks_scopesArrayXScopes of team tasks.
download_processing_task_self_senderBooleanXCan download files of processing tasks sent by self.
download_processing_task_group_senderBooleanXCan download files of processing tasks sent by group members.
download_processing_task_self_signerBooleanXCan download files of processing tasks signed by self.
download_processing_task_group_signerBooleanXCan download files of processing tasks signed by group members.
download_completed_task_self_senderBooleanXCan download files of completed tasks sent by self.
download_completed_task_group_senderBooleanXCan download files of completed tasks sent by group members.
download_completed_task_self_signerBooleanXCan download files of completed tasks signed by self.
download_completed_task_group_signerBooleanXCan download files of completed tasks signed by group members.
download_sign_and_send_self_taskBooleanXCan download files of self-sign tasks sent by self.
download_sign_and_send_group_taskBooleanXCan download files of self-sign tasks sent by group members.
download_audit_trail_self_senderBooleanXCan download audit trail of tasks sent by self.
download_audit_trail_group_senderBooleanXCan download audit trail of tasks sent by group members.
download_audit_trail_self_signerBooleanXCan download audit trail of tasks signed by self.
download_audit_trail_group_signerBooleanXCan download audit trail of tasks signed by group members.
delete_processing_task_self_senderBooleanXCan delete processing tasks sent by self.
delete_sign_and_send_self_taskBooleanXCan delete self-sign tasks sent by self.
archive_group_other_taskBooleanXCan archive tasks sent by group members.
void_processing_task_self_senderBooleanXCan void processing tasks sent by self.
void_processing_task_group_senderBooleanXCan void processing tasks sent by group members.
manage_company_nameBooleanXCan manage company name.
manage_company_logoBooleanXCan manage company logo.
manage_email_display_nameBooleanXCan manage email display name.
manage_decline_optionsBooleanXCan manage group's decline options.
share_templateBooleanXCan share templates.
transfer_templateBooleanXCan transfer templates.
share_combinationBooleanXCan share signer groups.
bulk_sendBooleanXCan bulk send tasks.
allow_kioskBooleanXCan use front desk signing.
report_accessBooleanXCan access reports.
task_exportBooleanXCan export tasks to third-party services.
discard_terminate_task_self_senderBooleanXCan discard terminated tasks sent by self.
discard_terminate_task_group_senderBooleanXCan discard terminated tasks sent by group members.
discard_completed_task_self_senderBooleanXCan discard completed tasks sent by self.
discard_completed_task_group_senderBooleanXCan discard completed tasks sent by group members.

Group_DeclineOptions

NameTypeNullableDescription
decline_option_idIntegerXDecline option ID.
statusStringXDecline option status.
enum: active and inactive.
system_reservedBooleanXIf decline option is reserved by system.
contentStringXDecline option content.

Group_IconUrl

NameTypeNullableDescription
100StringXIcon URL with 100px width.
280StringXIcon URL with 280px width.

Member

NameTypeNullableDescription
member_idIntegerXMember ID.
nameStringXMember name.
emailStringXMember email.
preferenceObjectXSee MemberPreference for more details.
group_idIntegerXGroup ID.
group_permissionObjectXSee GroupPermission for more details.
group_rolesArrayX
group_statusStringXGroup subscription status.
icon_infoObjectXSee Member_IconInfo for more details.
langStringXMember language.
limitationObjectXSee Member_Limitation for more details.
tagsArrayX
group_tagsArrayX

MemberData

NameTypeNullableDescription
dataObjectXSee Member for more details.

MemberID

NameTypeNullableDescription
dataObjectXSee MemberID_Data for more details.

MemberID_Data

NameTypeNullableDescription
member_idIntegerXMember ID.

MemberLimitation

NameTypeNullableDescription
sign_taskIntegerXSign task usage limitation per month.
sign_stageIntegerXSign stage usage limitation per sign task.
attachmentIntegerXAttachment usage limitation per sign stage.
public_formIntegerXPublic form usage limitation.
otpObjectXSee MemberLimitation_Otp for more details.

MemberLimitation_Otp

NameTypeNullableDescription
smsIntegerXSMS OTP usage limitation.

MemberPreference

NameTypeNullableDescription
date_formatStringXDate format.
forget_remindBooleanXEnable automatic reminders if the signer has not signed after 2 days and 6 days.
expire_remindBooleanXEnable automatic reminders a few days before the task expires.
remind_days_before_expireIntegerXRepresent days before the task expires to trigger automatic reminders.
otp_via_emailBooleanXEnhance account security through email OTP.
otp_via_phoneBooleanXEnhance account security through SMS OTP.
need_upchainBooleanXUpload signed tasks to blockchain.
receiver_langStringXThe language of the relevant emails received by recipients.
enum: de, en, es, it, ja, fa, ko, zh-CN and zh-TW.
signature_timestampBooleanXDisplay the time of the signature.
time_zoneStringXThe name in TZ database. ex. Asia/Taipei.

Member_IconInfo

NameTypeNullableDescription
icon_urlObjectXSee Member_IconInfo_IconUrl for more details.

Member_IconInfo_IconUrl

NameTypeNullableDescription
100StringXIcon URL with 100px width.
280StringXIcon URL with 280px width.

Member_Limitation

NameTypeNullableDescription
limitationObjectXSee MemberLimitation for more details.
planStringXMember subscription plan.

PublicForm

NameTypeNullableDescription
form_idIntegerXForm ID.
uuidStringXForm UUID.
form_nameStringXForm name.
descriptionStringOForm description.
statusStringXForm status.
enum: publish, unpublish and terminated.
template_nameStringXForm template name.
share_linkStringXForm public link.
It shows when status is publish.
signer_infosArrayXSee PublicFormSignerInfoFull for more details.
search_keysArrayXForm completed task's search keys.
sent_numIntegerXThe number of sent tasks in the form.
finish_numIntegerXThe number of finished tasks in the form.
goal_numIntegerOThe number of task required to complete the form. If -1, then the form is not limited by the number of tasks.
reach_limitBooleanXForm reaches goal_num or end_at .
created_atIntegerXForm creation timestamp.
end_atIntegerOForm ended up timestamp.

PublicFormData

NameTypeNullableDescription
dataObjectXSee PublicForm for more details.

PublicFormID

NameTypeNullableDescription
dataObjectXSee PublicFormID_Data for more details.

PublicFormID_Data

NameTypeNullableDescription
form_idIntegerXForm ID.

PublicFormList

NameTypeNullableDescription
dataObjectXSee PublicFormList_Data for more details.

PublicFormList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
templatesArrayXSee PublicForm for more details.

PublicFormSignerInfoFull

NameTypeNullableDescription
signer_typeStringXSpecifies the type of signer in the form stage:
- form_signer: an unspecified user who only needs to provide basic information like name or email when signing
- normal_signer: a designated user

The first signer in the sequence must be a form_signer, and all normal_signers must follow after all form_signers.

enum: form_signer and normal_signer.
nameStringXForm stage signer name. Required if signer_type is normal_signer.
emailStringXForm stage signer email. Required if signer_type is normal_signer.
max-length: 250.
phoneStringXForm stage signer phone (area code + number). Required if signer_type is normal_signer, and the used template requires SMS OTP.
requisiteObjectXSee PublicFormSignerInfoRequisite for more details.
roleStringXForm stage signer role.

PublicFormSignerInfoRequisite

NameTypeNullableDescription
nameStringXSigner should provide his name or not.
enum: required and optional.
emailStringXSigner should provide his email or not.
enum: required.

ReviewStage

NameTypeNullableDescription
review_stage_idIntegerXReview stage ID.
stage_idIntegerOStage ID.
stage_typeStringOStage type.
enum: SignStage and DummyStage.
base_stage_idIntegerOSigner's stage ID.
base_stage_typeStringOSigner's stage type.
enum: SignStage and DummyStage.
sequenceIntegerXReview sequence.
statusStringXReview status.
enum: initial, reviewing and reviewed.
nameStringXReviewer's name.
emailStringXReviewer's email.
reviewed_by_ownerBooleanXReviewed by owner or not.

Seal

NameTypeNullableDescription
dataObjectXSee Seal_Data for more details.
rawStringXRaw seal image in base64.
serial_numberStringXSeal serial number.
nameStringXSeal name.
statusStringXSeal status.
created_atIntegerXSeal creation timestamp.
updated_atIntegerXSeal last modification timestamp.
grant_settingsArrayXSee Seal_GrantSettings for more details.

SealID

NameTypeNullableDescription
dataObjectXSee SealID_Data for more details.

SealID_Data

NameTypeNullableDescription
seal_idIntegerXSeal ID.

SealList

NameTypeNullableDescription
dataObjectXSee SealList_Data for more details.

SealList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
sealsArrayXSee Seal for more details.

Seal_Data

NameTypeNullableDescription
seal_idIntegerXSeal ID.

Seal_GrantSettings

NameTypeNullableDescription
permissionObjectXSee Seal_GrantSettings_Permission for more details.
grantee_emailStringXGrantee email.

Seal_GrantSettings_Permission

NameTypeNullableDescription
useBooleanXUse permission.

SignEvent

NameTypeNullableDescription
action_nameStringXEvent action name.
enum: created, declined, sent, signed and voided.
roleStringXRole.
clientStringXClient.
enum: android, ios, open_api and web.
user_agentStringXUser agent.
ip_addressStringXIP address.
app_versionStringXApp version, exists if client is app.
created_atIntegerXEvent creation timestamp.

SignEventList

NameTypeNullableDescription
dataObjectXSee SignEventList_Data for more details.

SignEventList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
eventsArrayXSee SignEvent for more details.

SignStage

NameTypeNullableDescription
stage_idIntegerXStage ID.
nameStringXSigner's name.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.

SignStageAdvanced

NameTypeNullableDescription
stage_idIntegerXStage ID.
nameStringXSigner's name.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.
stage_settingObjectXSee StageSetting for more details.
custom_message_settingObjectXSee StageCustomMessageSetting for more details.

SignStageFull

NameTypeNullableDescription
stage_idIntegerXStage ID.
nameStringXSigner's name.
emailStringXActor's email.
stage_typeStringXStage type.
enum: sign, edit and form_sign.
sequenceIntegerXStage sequence, which starts from 1.
statusStringXStage status.
enum: initial, processing, signed, done, modifying, reviewed, declined and canceled.
stage_settingObjectXSee StageSetting for more details.
custom_message_settingObjectXSee StageCustomMessageSetting for more details.
attachment_settingsArrayXSee StageAttachmentSetting for more details.
field_settingsArrayXSee FieldSetting for more details.
field_setting_groupsArrayXSee FieldSettingGroup for more details.
review_stagesArrayXSee ReviewStage for more details.
verify_methodsArrayXSee VerifyMethod for more details.

SignTask

NameTypeNullableDescription
task_idIntegerXTask ID.
file_nameStringXFile name.
sign_typeStringXSign type.
enum: sign_and_send, create_and_invite, kiosk, guest_signing and form.
has_orderBooleanXSigners should sign sequentially or not.
statusStringXTask status.
enum: draft, waiting, completed, declined, expired, voided and deleted.
last_modified_by_ownerBooleanXLast modification by owner or not.
owned_by_meBooleanXTask is owned by me or not.
access_infoObjectXSee SignTaskAccessInfo for more details.
current_stage_infosArrayXCurrent stages' info.
See SignTask_CurrentStageInfos for more details.
detailsArrayXStage details, including owner's and stages' information.
* For all tasks, first schema is SignTaskOwner.
* For type of sign_and_send, guest_signing or kiosk tasks, see DummyStage schema.
* For type of create_and_invite or form tasks, see SignStage schema.

See SignTaskOwner, DummyStage and SignStage for more details.
task_settingObjectXSee SignTaskSetting for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
created_atIntegerXTask creation timestamp.
last_modified_atIntegerXTask last modification timestamp.

SignTaskAccessInfo

NameTypeNullableDescription
viewBooleanXMember can view the task or not.
signBooleanXMember can sign the task or not.
reviewBooleanXMember can review the task or not.
declineBooleanXMember can decline the task or not.
confirmBooleanXMember can confirm the task or not.
updateBooleanXMember can update the draft task or not.
forwardBooleanXMember can forward the task or not.
forward_requestBooleanXMember can send forward request to the owner or not.
preview_attachmentsBooleanXMember can preview the attachments or not.
downloadBooleanXMember can download the task or not.
download_audit_trailBooleanXMember can download the audit trail or not.
download_attachmentsBooleanXMember can download the attachments or not.
download_source_filesBooleanXMember can download the source files or not.
voidBooleanXMember can void the task or not.
deleteBooleanXMember can delete the task or not.
restoreBooleanXMember can restore the task or not.
share_sign_linkBooleanXMember can share the sign link or not.
archiveBooleanXMember can archive the task or not.
dearchiveBooleanXMember can dearchive the task or not.
save_templateBooleanXMember can save as a template or not.
resendBooleanXMember can resend the task or not.
editBooleanXMember can edit the waiting task or not.

SignTaskAttachedFile

NameTypeNullableDescription
idIntegerXAttached file ID.
rawStringXAttached file base64 data.

SignTaskData

NameTypeNullableDescription
dataObjectXSee SignTaskFull for more details.

SignTaskFull

NameTypeNullableDescription
task_idIntegerXTask ID.
file_nameStringXFile name.
sign_typeStringXSign type.
enum: sign_and_send, create_and_invite, kiosk, guest_signing and form.
has_orderBooleanXSigners should sign sequentially or not.
statusStringXTask status.
enum: draft, waiting, completed, declined, expired, voided and deleted.
last_modified_by_ownerBooleanXLast modification by owner or not.
owned_by_meBooleanXTask is owned by me or not.
access_infoObjectXSee SignTaskAccessInfo for more details.
current_stage_infosArrayXCurrent stages' info.
See SignTaskFull_CurrentStageInfos for more details.
detailsArrayXStage details, including owner's and stages' information.
* For all tasks, first schema is SignTaskOwner.
* For type of sign_and_send, guest_signing or kiosk tasks, see DummyStageAdvanced schema.
* For type of create_and_invite or form tasks, see SignStageAdvanced schema.

See SignTaskOwner, DummyStageAdvanced and SignStageAdvanced for more details.
task_settingObjectXSee SignTaskSetting for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
created_atIntegerXTask creation timestamp.
last_modified_atIntegerXTask last modification timestamp.
file_mission_infoObjectXSee FileMissionInfo for more details.
read_onlyBooleanXTask is read only or not.
thumbnailObjectXSee SignTaskThumbnail for more details.
watermark_infoObjectXSee WatermarkInfo for more details.

SignTaskFull_CurrentStageInfos

NameTypeNullableDescription
stage_idIntegerXStage ID.
emailStringXSigner's email.
nameStringXSigner's name.

SignTaskID

NameTypeNullableDescription
dataObjectXSee SignTaskID_Data for more details.

SignTaskID_Data

NameTypeNullableDescription
task_idIntegerXTask ID.

SignTaskImageInfo

NameTypeNullableDescription
imagesArrayXSee SignTaskAttachedFile for more details.

SignTaskList

NameTypeNullableDescription
dataObjectXSee SignTaskList_Data for more details.

SignTaskList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
tasksArrayXSee SignTask for more details.

SignTaskOwner

NameTypeNullableDescription
nameStringXOwner's name.
sequenceIntegerXOwner's sequence, which is 0.
emailStringXOwner's email.
statusStringXOwner's status.
enum: created, sent and voided.

SignTaskRead

NameTypeNullableDescription
task_idIntegerXTask ID.
file_nameStringXFile name.
sign_typeStringXSign type.
enum: sign_and_send, create_and_invite, kiosk, guest_signing and form.
has_orderBooleanXSigners should sign sequentially or not.
statusStringXTask status.
enum: draft, waiting, completed, declined, expired, voided and deleted.
last_modified_by_ownerBooleanXLast modification by owner or not.
owned_by_meBooleanXTask is owned by me or not.
access_infoObjectXSee SignTaskAccessInfo for more details.
current_stage_infosArrayXCurrent stages' info.
See SignTaskRead_CurrentStageInfos for more details.
detailsArrayXStage details, including owner's and stages' information.
* For all tasks, first schema is SignTaskOwner.
* For type of sign_and_send, guest_signing or kiosk tasks, see DummyStageFull schema.
* For type of create_and_invite or form tasks, see SignStageFull schema.

See SignTaskOwner, DummyStageFull and SignStageFull for more details.
task_settingObjectXSee SignTaskSetting for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
created_atIntegerXTask creation timestamp.
last_modified_atIntegerXTask last modification timestamp.
file_mission_infoObjectXSee FileMissionInfo for more details.
read_onlyBooleanXTask is read only or not.
thumbnailObjectXSee SignTaskThumbnail for more details.
watermark_infoObjectXSee WatermarkInfo for more details.
viewable_attachmentsArrayXViewable attachments for the reader on the sign task.
See SignTaskViewableAttachments for more details.
image_infoObjectXSee SignTaskImageInfo for more details.
review_infoObjectXSee SignTaskReviewInfo for more details.
signature_infoObjectXSee SignTaskSignatureInfo for more details.
verify_infoObjectXSee SignTaskVerifyInfo for more details.

SignTaskReadData

NameTypeNullableDescription
dataObjectXSee SignTaskRead for more details.

SignTaskRead_CurrentStageInfos

NameTypeNullableDescription
stage_idIntegerXStage ID.
emailStringXSigner's email.
nameStringXSigner's name.

SignTaskReviewInfo

NameTypeNullableDescription
review_attachmentsArrayXFor reviewer, the attachments need to reivew.
review_fieldsArrayXFor reviewer, the fields need to review.
reviewed_stage_idIntegerXFor reviewer, reviewed stage ID.
last_review_resultObjectXFor signer who's rejected, last review result
See SignTaskReviewInfo_LastReviewResult for more details.

SignTaskReviewInfo_LastReviewResult

NameTypeNullableDescription
review_attachmentsArrayXSee SignTaskReviewInfo_LastReviewResult_ReviewAttachments for more details.
review_fieldsArrayXSee SignTaskReviewInfo_LastReviewResult_ReviewFields for more details.
review_messageStringXReview rejected message.
reviewed_atIntegerXReviewed timestamp.
reviewer_infoObjectXReviewer infomation.
See SignTaskReviewInfo_LastReviewResult_ReviewerInfo for more details.

SignTaskReviewInfo_LastReviewResult_ReviewAttachments

NameTypeNullableDescription
acceptedBooleanXAttachment review result.
attachment_idStringXAttachment ID.

SignTaskReviewInfo_LastReviewResult_ReviewFields

NameTypeNullableDescription
acceptedBooleanXField review result.
field_object_idStringXField object ID.

SignTaskReviewInfo_LastReviewResult_ReviewerInfo

NameTypeNullableDescription
emailStringXReviewer email.
nameStringXReviewer name.

SignTaskSetting

NameTypeNullableDescription
deadlineIntegerODeadline in timestamp. Used for SignTask only.
forget_remindBooleanXRemind the signer or not when task is waiting for signing.
expire_remindBooleanORemind the signer or not when task is going to be expired. Used for SignTask only.
remind_days_before_expireIntegerODays before expire to remind the signer. Used for SignTask only.
expires_in_daysIntegerODays before expire. Used for SignTask only.
cc_infosArrayXSee SourceSettingCcInfo for more details.
messageStringOMessage to the signer when task is processing.
completed_messageStringOMessage to the signer when task is completed.
reference_settingsArrayXReference information viewable to signers when task is processing.
See SourceSettingReferenceSetting for more details.
completed_reference_settingsArrayXReference information viewable to signers when task is completed.
See SourceSettingReferenceSetting for more details.
receiver_langStringXLanguage displayed for the signer, only effective if signer has not set his preferred language.
owner_informableBooleanXInform the owner through email or not when task is updated.

SignTaskSignatureInfo

NameTypeNullableDescription
signaturesObjectXSee SignTaskAttachedFile for more details.
guest_signaturesObjectXSee SignTaskAttachedFile for more details.
sealsObjectXSee SignTaskAttachedFile for more details.

SignTaskThumbnail

NameTypeNullableDescription
originalObjectXSee Thumbnail for more details.
completedObjectXSee Thumbnail for more details.

SignTaskVerifyInfo

NameTypeNullableDescription
identity_verify_tokenStringXIdentity verify token for reading.

SignTaskViewableAttachments

NameTypeNullableDescription
stage_idIntegerXStage ID.
signer_nameStringXSigner name.
signer_emailStringXSigner email.
file_idIntegerXFile ID.
file_nameStringXFile name.
attachment_idStringXAttachment ID.
reviewableBooleanXReviewable. It exists when stage type is ReviewStage.

SignTask_CurrentStageInfos

NameTypeNullableDescription
stage_idIntegerXStage ID.
emailStringXSigner's email.
nameStringXSigner's name.

Signature

NameTypeNullableDescription
dataObjectXSee Signature_Data for more details.
rawStringXRaw signature image in base64.
file_typeStringXFile type.
categoryStringXCategory.
created_atIntegerXSignature creation timestamp.

SignatureID

NameTypeNullableDescription
dataObjectXSee SignatureID_Data for more details.

SignatureID_Data

NameTypeNullableDescription
signature_idIntegerXSignature ID.

SignatureList

NameTypeNullableDescription
dataObjectXSee SignatureList_Data for more details.

SignatureList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
signaturesArrayXSee Signature for more details.

Signature_Data

NameTypeNullableDescription
signature_idIntegerXSignature ID.

SourceSettingCcInfo

NameTypeNullableDescription
emailStringXCC Email.
nameStringXCC Name.

SourceSettingReferenceSetting

NameTypeNullableDescription
file_nameStringXReference name.
reference_idStringXReference ID.
reference_typeStringXReference file type.

StageAttachmentSetting

NameTypeNullableDescription
attachment_idStringXAttachment ID.
file_nameStringXAttachment name.
forceBooleanXSigner must upload attachment or not.
viewable_in_processingBooleanXAttachment is viewable by other signers or not, will be effective along with viewable_in_processing in StageSetting.

StageCustomMessageSetting

NameTypeNullableDescription
viewable_in_processingBooleanXCustom message is viewable by other signers or not when task is processing.
viewable_in_completedBooleanXCustom message is viewable by other signers or not when task is completed.

StageSetting

NameTypeNullableDescription
forward_enableBooleanXAvailable to change signer.
For signer who is also the task owner, this option is always true.
decline_enableBooleanXAvailable to decline the task.
For signer who is also the task owner, this option is always false.
viewable_in_processingBooleanXAvailable to view attachments when task is processing.
For signer who is also the task owner, this option is always true.
viewable_in_completedBooleanXAvailable to view attachments when task is completed.
For signer who is also the task owner, this option is always true.

viewable_source_filesArrayXFiles that can be viewed by the recipient.
informableBooleanXInform the signer through email or not when task is updated.
reviewed_skip_confirmBooleanXDo not need to confirm when signer's stage is reviewed.

Template

NameTypeNullableDescription
template_idIntegerXTemplate ID.
file_nameStringXTemplate name.
has_orderBooleanXSigners should sign sequentially or not.
statusStringXTemplate status.
enum: active and deleted.
access_infoObjectXSee TemplateAccessInfo for more details.
detailsArrayXStage details.
See DummyStage for more details.
template_settingObjectXSee TemplateSetting for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
created_atIntegerXTemplate creation timestamp.
last_modified_atIntegerXTemplate last modification timestamp.

TemplateAccessInfo

NameTypeNullableDescription
viewBooleanXMember can view the template or not.
updateBooleanXMember can update the template or not.
deleteBooleanXMember can delete the template or not.
group_shareBooleanXMember can share the template to the group or not.
kiosk_settingBooleanXMember can update the kiosk setting or not.
duplicateBooleanXMember can duplicate the template or not.
transferBooleanXMember can transfer the template or not.

TemplateData

NameTypeNullableDescription
dataObjectXSee TemplateFull for more details.

TemplateDownloadLink

NameTypeNullableDescription
rawStringXDownload link of raw file.
originalStringXDownload link of original file.
fullStringXDownload link of full file.

TemplateFull

NameTypeNullableDescription
template_idIntegerXTemplate ID.
file_nameStringXTemplate name.
has_orderBooleanXSigners should sign sequentially or not.
statusStringXTemplate status.
enum: active and deleted.
access_infoObjectXSee TemplateAccessInfo for more details.
detailsArrayXStage details.
See DummyStageFull for more details.
template_settingObjectXSee TemplateSetting for more details.
metadataObjectXMetadata. Maximum 10 key-value pairs, where each key length must be less than or equal to 40 characters and each value length must be less than or equal to 100 characters.
created_atIntegerXTemplate creation timestamp.
last_modified_atIntegerXTemplate last modification timestamp.
download_linkObjectXSee TemplateDownloadLink for more details.
file_mission_infoObjectXSee FileMissionInfo for more details.
share_settingObjectXSee TemplateShareSetting for more details.
thumbnailObjectXSee TemplateThumbnail for more details.
watermark_infoObjectXSee WatermarkInfo for more details.

TemplateID

NameTypeNullableDescription
dataObjectXSee TemplateID_Data for more details.

TemplateID_Data

NameTypeNullableDescription
template_idIntegerXTemplate ID.

TemplateList

NameTypeNullableDescription
dataObjectXSee TemplateList_Data for more details.

TemplateList_Data

NameTypeNullableDescription
total_countIntegerXTotal count of items.
current_pageIntegerXCurrent page number.
total_pagesIntegerXTotal page count.
templatesArrayXSee Template for more details.

TemplateSetting

NameTypeNullableDescription
deadlineIntegerODeadline in timestamp. Used for SignTask only.
forget_remindBooleanXRemind the signer or not when task is waiting for signing.
expire_remindBooleanORemind the signer or not when task is going to be expired. Used for SignTask only.
remind_days_before_expireIntegerODays before expire to remind the signer. Used for SignTask only.
expires_in_daysIntegerODays before expire. Used for SignTask only.
cc_infosArrayXSee SourceSettingCcInfo for more details.
messageStringOMessage to the signer when task is processing.
completed_messageStringOMessage to the signer when task is completed.
reference_settingsArrayXReference information viewable to signers when task is processing.
See SourceSettingReferenceSetting for more details.
completed_reference_settingsArrayXReference information viewable to signers when task is completed.
See SourceSettingReferenceSetting for more details.
receiver_langStringXLanguage displayed for the signer, only effective if signer has not set his preferred language.
owner_informableBooleanXInform the owner through email or not when task is updated.

TemplateShareSetting

NameTypeNullableDescription
read_onlyBooleanXRead only or not.
group_permissionObjectXPermission for all roles, including custom roles.
See TemplateShareSetting_GroupPermission for more details.
shared_by_meBooleanXShared by me or not.
shared_by_othersBooleanXShared by others or not.

TemplateShareSetting_GroupPermission

NameTypeNullableDescription
adminBooleanXGroup admin has permission or not.
managerBooleanXGroup manager has permission or not.
memberBooleanXGroup member has permission or not.

TemplateThumbnail

NameTypeNullableDescription
originalObjectXSee Thumbnail for more details.

Thumbnail

NameTypeNullableDescription
cover_50StringXThumbnail url with 50px width.
cover_175StringXThumbnail url with 175px width.
cover_275StringXThumbnail url with 275px width.

VerifyMethod

NameTypeNullableDescription
uuidStringXUUID.
sequenceIntegerXVerify sequence.
verify_typeStringXverify type.
enum: email and sms.
verify_sourceStringXverify source.
occasionStringXverify occasion.
enum: sign and read.

WatermarkInfo

NameTypeNullableDescription
watermark_idIntegerXWatermark ID.
nameStringXWatermark name.
statusStringXWatermark status.
enum: active and deactivated.