Developer Center

Envelope Delivery Failed

Parameter

Type

Description

event

string

The webhook notification's event type is fixed toENVELOPE_DELIVERY_FAILED

eventPayload

object

Webhook event payload

 

envelopeId

string

Envelope ID

 

envelopeStatus

int

Envelope Status:

1-In Progress

 

envelopeStartTime

string

Time of Envelope Creation

 

expireTime

string

The Expiration Time of Envelope

 

signerList

array

Delivery failed signer's information

 

 

businessId

string

Developer customized business number, length limit 500.

 

 

userEmail

string

Signer’s email address

 

 

phoneNumber

map

Signer's phone number

 

 

 

countryCode

string

The International Code of the country region

 

 

 

number

string

Notification phone number

 

 

userName

string

Signer's Name

 

 

signOrder

int

Signer's Sign Order

 

 

signerStatus

int

Signer Status:

9-delivery failed

 

 

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.

 

ccList

array

Delivery failed CC's information

 

 

userEmail

string

CC's Email Address

 

 

userName

string

The name of the CC recipient.

 

 

ccStatus

int

CC Status:

1-delivery failed