Last updated on
8 Jul 2026
Below is a comprehensive list of v5 REST API events.
| Event Type | Description |
| CREATED | When an agreement or Draft is created |
| AGREEMENT_MODIFIED | Agreement modified by the sender [modify the document in flight] |
| USER_ACK_AGREEMENT_MODIFIED | When the signer acknowledges modification before signing |
| SIGNED | The agreement is signed through a written signature process |
| ESIGNED | When an agreement is signed with an electronic signature |
| DIGSIGNED | When an agreement is signed with a digital signature |
| APPROVED | When an agreement is approved |
| ACCEPTED | When an agreement is accepted |
| DELIVERED | When an agreement is delivered |
| FORM_FILLED | When an agreement is filled |
| OFFLINE_SYNC | When an agreement is signed offline using a mobile device |
| UPLOADED_BY_SENDER | When a signed agreement is uploaded by the sender using an e-signature workflow |
| FAXED_BY_SENDER | When a signed agreement is uploaded by the sender using a fax workflow |
| SIGNATURE_REQUESTED | When an agreement is sent to a recipient for signature |
| APPROVAL_REQUESTED | When an agreement is sent to a recipient for approval |
| ACKNOWLEDGEMENT_REQUESTED | When an agreement is sent to a recipient for acknowledgment |
| FORM_FILLING_REQUESTED | When an agreement is sent to a recipient for form filling |
| ACCEPTANCE_REQUESTED | When an agreement is sent to a recipient for acceptance |
| RECALLED | When an agreement is canceled by the sender |
| REJECTED | When an agreement is rejected by a recipient |
| EXPIRED | When some custom expiry time/date is set by the sender and the agreement passes that time/date |
| EXPIRED_AUTOMATICALLY | When an agreement is expired automatically |
| SHARED | When agreement has been shared by a participant |
| EMAIL_VIEWED | When a recipient view's the Please Sign mail |
| EMAIL_BOUNCED | When an email is bounced from the recipient's mail server |
| AUTO_CANCELLED_CONVERSION_PROBLEM | When agreement conversion failed due to which agreement is auto-canceled |
| PASSWORD_AUTHENTICATION_FAILED | When password authentication fails |
| KBA_AUTHENTICATION_FAILED | When KBA authentication fails |
| KBA_AUTHENTICATED | When KBA authentication passes |
| WEB_IDENTITY_AUTHENTICATED | When Web Identity authentication passes |
| WEB_IDENTITY_SPECIFIED | When Web Identity authentication is requested |
| WIDGET_ENABLED | When a Web Form is enabled from a disabled status |
| WIDGET_DISABLED | When a Web Form is disabled from an enabled status |
| DELEGATED | When an agreement is delegated by the recipient |
| AUTO_DELEGATED | When an agreement is delegated due to auto delegation |
| REPLACED_SIGNER | When an agreement recipient is replaced by the sender |
| VAULTED | When agreement has vaulting enabled and a callback is sent to the vault provided to perform vaulting |
| DOCUMENTS_DELETED | When a data governance policy is enabled and the documents of an agreement are deleted |
| DRAFT_MODIFIED | An agreement in Draft status has been modified |
| ACCESS_CODE_GENERATED | When an access code is generated for granting access to the esign page for a recipient. |
| ACCESS_CODE_CONSUMED | Each time signer submits ACCESS_CODE_GENERATED, an ACCESS_CODE_CONSUMED event is recorded. |
| ACTION_AUTO_DELEGATED | See AUTO_DELEGATED ("action" prefix added here to indicate that the message should be role-based.) |
| ACTION_COMPLETED | This is the generic case that does not meet the conditions of any of the special cases: ACTION_COMPLETED_OFFLINE_HOSTED, ACTION_COMPLETED_OFFLINE, ACTION_COMPLETED_HOSTED, ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN, ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED, ACTION_COMPLETED_WIDGET_VERIFIED |
| ACTION_COMPLETED_HOSTED | Online hosted |
| ACTION_COMPLETED_OFFLINE | Generic offline signature case |
| ACTION_COMPLETED_OFFLINE_HOSTED | Esigned offline with an API HOST |
| ACTION_COMPLETED_WIDGET_VERIFIED | Signer completed normal email verification. Only when the Web Form signer is the first participant. Subsequent signers trigger the ESIGNED event. |
| ACTION_COMPLETED_WIDGET_VERIFIED_API_TOKEN | This is AFTER a Web From is esigned and the user verified their signature via API token |
| ACTION_COMPLETED_WIDGET_VERIFICATION_WAIVED | This happens when senders do not require email verification for their widgets |
| ACTION_DELEGATED | See DELEGATED, "action" prefix added here to indicate that the message should be role-based. |
| ACTION_REPLACED_SIGNER | The signer was replaced by the sender. |
| ACTION_REQUESTED | The old role-specific events have been flattened into one event (ACKNOWLEDGMENT_REQUESTED, ACCEPTANCE_REQUESTED, APPROVAL_REQUESTED, FORM_FILLING_REQUESTED, SIGNATURE_REQUESTED). This was done because we don't need or want role-specific events. The client can get that from the participation, and it would vastly increase the number of variations of "COMPLETED" above. To match that, these "...REQUESTED" events were flattened to match. |
| CREATED_FROM_WIDGET | When a user uses a Web Form, the agreement is created when it is signed |
| CREATED_OFFLINE | When an agreement or Draft is created offline |
| CREATED_VIA_UPLOAD | See CREATED. This is the "deliver document" feature in acrobat/reader. ("Agreement uploaded by") |
| CREATED_VIA_ACROBAT | See CREATED. This is the Acrobat "Send for signature" feature when used from Acrobat (embedded send page). ("Agreement uploaded from Acrobat by") |
| CREATED_VIA_READER | See CREATED. This is the Reader "Send for signature" feature when used from Acrobat (embedded send page). ("Agreement uploaded from Reader by") |
| ACTIVATED | The %s is activated by |
| DIGITAL_SIGN_UIDAI_SIGNER_CONSENT | UIDAI user consent event |
| DEACTIVATED | The %s is deactivated by |
| DOWNLOADED | Document downloaded by |
| FAXIN_RECEIVED | The faxed in signature has been received. |
| MODIFIED | Agreements in a Draft state can have these event types: CREATED, MODIFIED, CANCELLED, FINALIZED, DELETED but only CREATED and MODIFIED are returned. FINALIZED is returned as MODIFIED, and DELETED is suppressed. |
| OTHER | In the future, statuses other than those above may be added to the EchoSign application. For backward compatibility reasons, existing API clients will receive status OTHER. You may need to update your client application to the latest version of the API to receive the new statuses in those cases. |
| PAID | Paid by |
| PRESIGNED | The agreement has been signed by |
| RECALLED_MAX_SIGNING_KBA_ATTEMPTS | Auto canceled due to KBA attempts exceeded. This used to be the "MAX_SIGNING_KBA_ATTEMPTS_EXCEEDED" event. |
| RECALLED_MAX_SIGNING_PASSWORD_ATTEMPTS | Auto canceled due to password attempts exceeded. This used to be the "MAX_SIGNING_PASSWORD_ATTEMPTS_EXCEEDED" event. |
| RECALLED_MAX_SIGNING_PHONE_ATTEMPTS | Auto canceled due to phone attempts exceeded. This used to be the "MAX_SIGNING_PHONE_ATTEMPTS_EXCEEDED" event. |
| SENDER_CREATED_NEW_REVISION | A new revision of the document has been created. |
| SIGNING_URL_REQUESTED | The signing URL has been requested by |
| READY_TO_VAULT | The agreement is ready to vault |
| WRITTEN_DOWNLOAD | The agreement was downloaded for signature by |
| WRITTEN_SIGNED | The agreement has been manually signed by |
A list of status for agreements is below:
Status |
Description |
OUT_FOR_SIGNATURE |
When the agreement sent out for signature |
SIGNED |
When an agreement is signed |
APPROVED |
When an agreement is approved |
ABORTED |
Canceled or deleted agreement |
EXPIRED |
When an agreement is expired |
ARCHIVED |
When an agreement is Archived |
PREFILL |
When an agreement is in prefill state and sender has to prefill some fields |
AUTHORING |
When an agreement is in the Authoring state |
WAITING_FOR_VERIFICATION |
When an agreement is created from a Web Form, and the Web From signer has not yet verified their email |
OUT_FOR_APPROVAL |
When an agreement is out for approval |
DELIVERED |
When an agreement is acknowledged by a certified recipient |
ACCEPTED |
When an agreement is accepted by an acceptor |
FORM_FILLED |
When an agreement is filled by a form-filler |
OUT_FOR_DELIVERY |
When an agreement is out for acknowledgment |
OUT_FOR_ACCEPTANCE |
When an agreement is out for acceptance |
OUT_FOR_FORM_FILLING |
When an agreement is out for form filling |
