When using the Android SDK, your application should handle errors thrown by the eSignature REST API or errors that the SDK itself generates. To do so you need to use a try/catch clause in your application and specifically catch exceptions of type DSEnvelopeException and handle them in your code.
How to detect Android SDK errors
Add the following method to handle exceptions thrown by either the eSignature REST API or by the Android SDK:
void onError(DSEnvelopeException exception)
Inside the method onError, inspect the values of:
exception.errorCodeexception.errorMsg
These values will determine the reason for the error and help your application handle it correctly. Your code can either look for the numeric value or the constant that represents this value (recommended).
Error codes and associated messages
The following table lists all of the error codes and associated messages. The list is presented in order based on the error code number and error code constant. In many cases additional information is added to the message string.
| Error code | Error code constant | Error message |
|---|---|---|
| 1 | ENVELOPE_TEMPLATE_CONVERSION_FAILED_DB_ERROR | Failed to convert template to envelope |
| 2 | ENVELOPE_TEMPLATE_CONVERSION_FAILED_NULL_TEMPLATE | Null template - cannot convert |
| 3 | ENVELOPE_DB_ENVELOPE_NULL | Envelope not found in the DB |
| 4 | ENVELOPE_DB_ENVELOPE_RECIPIENTS_NULL | No recipients are found in the DB for this envelope |
| 4 | ENVELOPE_DB_ENVELOPE_RECIPIENTS_NULL | Envelope does not have recipients |
| 6 | ENVELOPE_DB_ENVELOPE_TAB_LIST_ITEMS_NULL | DB Envelope tab list items are null |
| 7 | ENVELOPE_DB_ENVELOPE_DAO_NULL | Envelope’s data access object not found in the DB |
| 8 | ENVELOPE_DB_ENVELOPE_RECIPIENT_DAO_NULL | Envelope Recipient’s data access object not found in the DB |
| 9 | ENVELOPE_DB_ENVELOPE_TAB_DAO_NULL | Envelope Tab’s data access object not found in the DB |
| 10 | ENVELOPE_DB_ENVELOPE_TAB_LIST_ITEM_DAO_NULL | DB Envelope Tab List Item Dao is null |
| 11 | ENVELOPE_DB_ENVELOPE_DOCUMENT_DAO_NULL | Envelope Document’s data access object not found |
| 12 | ENVELOPE_DB_ENVELOPE_DOCUMENTS_NULL | No documents are found in the DB for this envelope |
| 13 | ENVELOPE_DB_ENVELOPE_CUSTOM_FIELDS_DAO_NULL | Envelope CustomField’s data access object not found in the DB |
| 15 | ENVELOPE_GET_CACHED_ENVELOPE_NULL | No cached envelope found |
| 16 | ENVELOPE_GET_CACHED_ENVELOPE_ERROR | Error occurred while fetching the envelope from DB |
| 17 | ENVELOPE_CACHE_ENVELOPE_ERROR | Failed to cache envelope |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | FieldId, name, and value are required for textCustomFields |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | CustomField’s name must not exceed 49 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | CustomField’s value must not exceed 100 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Document name must be less than 1000 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | DocumentId, name, and uri are required |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Unable to copy document file |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Envelope name must be less than 950 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Email blurb must be less than 10000 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Email subject must be less than 1000 characters in length |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | At least one document is required to create an envelope |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Duplicate recipients are not allowed in same routing order |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Duplicate document Ids are not allowed |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Invalid Text CustomField |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Invalid List CustomField |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | File is not a valid, parseable, password-free PDF |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | A valid envelopeName is required and it cannot be null or blank |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Duplicate recipient Ids are not allowed |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Unsupported tabs found on recipient |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Invalid email address. Sample format account@company.com |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | At least one Tab is needed for each non carbon copy recipient |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | No Tabs are allowed for recipient of type Carbon Copy |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | recipientId must be an integer > 1 |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | signerEmail must be an valid email address |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | hostEmail must be an valid email address |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | signerName must be provided |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Tab recipientId must match recipient’s Id |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | xPosition must be greater than zero |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | yPosition must be greater than zero |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | height must be greater than zero |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | width must be greater than zero |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | pageNumber must be greater than zero |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | documentId must be specified |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | recipientId must be specified |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Tab type must be specified |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Tab pageNumber must be specified |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | List items must be specified for List tabs |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | List items must contain specified default value |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Group name must be specified for RadioGroup tabs |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | File not found at specified URI |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Unknown exception in loading document |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Your document must contain less than 2000 pages |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Invalid URI format |
| 19 | ENVELOPE_CREATE_ENVELOPE_ERROR | Error in Document Uri |
| 20 | ENVELOPE_UPDATE_ENVELOPE_RECIPIENT_ERROR | Failed to update recipient |
| 21 | ENVELOPE_UPDATE_ENVELOPE_ERROR | Failed to update envelope |
| 22 | ENVELOPE_DELETE_ENVELOPE_ERROR | Unable to delete envelope from DB |
| 23 | DB_ERROR | Error in accessing DB |
| 24 | ENVELOPE_SYNC_ERROR | Unable to update the DB with envelope sync status |
| 24 | ENVELOPE_SYNC_ERROR | Unable to sync offline signed envelope. Envelope is in neither Sync Pending nor Sync Failed status |
| 24 | ENVELOPE_SYNC_ERROR | Unable to sync offline signed envelope |
| 25 | NETWORK_CONNECTION_ERROR | Unable to sync offline signed envelope due to no Network Connection |
| 26 | ENVELOPE_GET_ENVELOPE_IDS_ERROR | Error in accessing DB for syncStatus |
| 26 | ENVELOPE_GET_ENVELOPE_IDS_ERROR | Error in getting envelopeId’s from DB for syncStatus |
| 28 | ENVELOPES_SYNC_ALL_IN_PROGRESS_ERROR | Unable to start sync all call. Another Sync all call is in Progress |
| 29 | NO_ENVELOPES_TO_SYNC_ERROR | There are no pending envelopes to sync |
| 30 | ENVELOPE_REPLACE_ENVELOPE_ERROR | Failed to replace envelope |
| 31 | ENVELOPE_DOCUMENT_DOWNLOAD_ERROR | Envelope is not a Completed Envelope |
| 31 | ENVELOPE_DOCUMENT_DOWNLOAD_ERROR | Error in Downloading Document |
| 31 | ENVELOPE_DOCUMENT_DOWNLOAD_ERROR | Invalid document type |
| 31 | ENVELOPE_DOCUMENT_DOWNLOAD_ERROR | CacheDirPath is null |
| 39 | SLOW_NETWORK_CONNECTION_ERROR | Unable to sync offline signed envelope due to slow network connection |
| 40 | LOW_NETWORK_SIGNAL_ERROR | Unable to sync offline signed envelope due to low network signal |
| 105 | TELEMETRY_EVENT_CACHE_EVENT_ERROR | Telemetry not enabled |
| 700 | ENVELOPE_OFFLINE_SIGNING_DOCUMENT_DOWNLOAD_ERROR | No documents are found in the envelope for Offline Signing |
| 700 | ENVELOPE_OFFLINE_SIGNING_DOCUMENT_DOWNLOAD_ERROR | There is no data in the document |
| 700 | ENVELOPE_OFFLINE_SIGNING_DOCUMENT_DOWNLOAD_ERROR | Error in downloading envelope document |
| 701 | ENVELOPE_OFFLINE_SIGNING_ENVELOPE_NOT_ELIGIBLE | User Account does not allow offline usage |
| 701 | ENVELOPE_OFFLINE_SIGNING_ENVELOPE_NOT_ELIGIBLE | User Account In Session is not enabled for Offline Signing |
| 701 | ENVELOPE_OFFLINE_SIGNING_ENVELOPE_NOT_ELIGIBLE | Envelope is not allowed for Offline Signing |
| 701 | ENVELOPE_OFFLINE_SIGNING_ENVELOPE_NOT_ELIGIBLE | Envelope with Supplemental Docs is not allowed for Offline Signing |
| 703 | ENVELOPE_OFFLINE_SIGNING_RECIPIENT_CD_DOWNLOAD_ERROR | Error while downloading recipient consumer disclosure |
| 704 | ENVELOPE_OFFLINE_SIGNING_ENVELOPE_IS_DOWNLOADING | Envelope is Downloading |
| 705 | ENVELOPE_OFFLINE_USER_NOT_AUTHENTICATED | Session has expired. Please log in again |