Envelope Cancel

Parameter

Type

Description

event

string

The webhook notification's event type is fixed to ENVELOPE_CANCEL

eventPayload

object

Webhook event payload

envelopeId

string

Envelope ID

envelopeStatus

int

Envelope Status:

5-Canceled

envelopeStartTime

timestamp

Envelope start time

expireTime

timestamp

Envelope expiration time

signerList

array

List of signers

businessId

string

A custom identifier assigned by the developer for internal tracking or reference. length limit 500.

userEmail

string

Signer’s email address

phoneNumber

object

Signer's phone number

countryCode

string

86-China

852-Hong Kong, China

853- Macau, China

66- Thailand

number

string

Notification phone number

userName

string

Signer's Name

userType

int

Indicates the type of signing party.

1-Individual

2- Organization

organizationName

string

The name of the signing organization. Only required when signerType = 2 (Organization).

signOrder

int

Signer's Sign Order

signerStatus

int

Signer Status:

0-Pending

1-In Progress

2-Signed

authModes

string

Verification method, default is 0.

0-Do not verify

1-Access code

2-iAM Smart

3-SMS OTP

4-ID Verification

accessCode

string

Code used to verify the signer’s identity before accessing the document.

cancelInfo

object

Envelope cancellation Information

reason

string

Envelope cancellation reason