v5 Error Codes

Owned by Former user (Deleted)
Apr 27, 2022
2 min read

Here you find the list of eSAW API error codes and error codes coming from the SIGNificant Server Platform (to be exact the Workstep Controller). These might help you to fix an issue with the your integration.

An error returns and error (the code) and a message, why it failed.

Error Sample

Here you see a faulty uploadTemporarySspFile response, where the file name was empty in the request. The system returns you the baseResult as failed, the error code (ERR0002) and a textual descripton (errorMsg) why it failed.

<baseResult>failed</baseResult>
  <errorInfo>
    <error>ERR0002</error>
    <errorMsg>ERR0002: Parameter FileName is empty</errorMsg>
    <supportId>756094</supportId>
  </errorInfo>

Messages starting with “ERR00xx” are returned errors of eSAW itself. If an error occoured in the SIGNificant Server Platform (Workstep Controller) it has an additional error code with “ERROR-xxxxx”, which identifies the SSP error. Below you find the error codes for eSAW and WSC (known by eSAW).

Here you find an response of an faulty SendEnvelope request, where the workstep configuration was invalid. The error is first a eSAW error (invalid workstep) and then a SSP/WSC error with details, why the workstep configuration was invalid:

<baseResult>failed</baseResult>
<errorInfo>
	<error>ERR0012</error>
	<errorMsg>ERR0012: Invalid workstep configuration: 
		<error>ERROR-12484</error>: 
		<errorMsg>Some configuration is missing for signature field with id '93cce567-ae5c-4e98-ac99-9f56ac034250', either provide a complete set for sig object or reference an existing field</errorMsg>
	</errorMsg>
	<supportId>441400</supportId>
</errorInfo>

eSignAnyWhere API Errors

Error codes starting with “ERR0xxx” are messages, which are coming from eSAW directly. Errors with “ERROR-” are errors from the SIGNificant Server Platform, which is reponsible for the workstep and the workstep configuration (see below).

ErrorError Code
GeneralERR0001
EmptyParameterERR0002
MissingUserERR0003
WrongUserTypeERR0004
PdfConversionFailedERR0005
HasDuplicateFormFieldNamesERR0006
MissingEnvelopeERR0007
MissingFileERR0008
AuthorizationFailedERR0009
EnvelopeActionNotAllowedForUserERR0010
InvalidParameterFormatERR0011
InvalidWorkstepConfigurationERR0012
EnvelopeActionNotAllowedForEnvelopeStateERR0013
NotAllowedByLicenseERR0014
FileIsNoEnvelopeCompletedDocumentERR0015
WorkstepIdMappingErrorERR0016
IncompleteTemplateERR0017
RecipientActionNotAllowedForRecipientStateERR0018
AlreadyExistingUserERR0019
FieldMarkupStringErrorERR0020
ElementNotWithinPageBoundsERR0021
UnsupportedMimeTypeERR0022
ContentDispositionMissingOrIncompleteERR0023
ActionForRecipientOnlyAllowedOnBulkLevelERR0024
ActionForRecipientNotAllowedForBulksERR0025
MissingFirstNameFieldERR0026
MissingLastNameFieldERR0027
MissingEmailFieldERR0028
MissingPasswordFieldERR0029
CountryFieldInvalidValueERR0030
LanguageInvalidValueERR0031
DuplicateEmailERR0032
InvalidInputERR0033
InvalidEmailAddressERR0034
DeniedByUserSettingERR0035
MissingConfigurationERR0036
DuplicateOrganizationNameERR0037
InvalidTimezoneERR0038
MissingTimezoneERR0039
TemplateHasNoDocumentsERR0040
MissingDisposableConfigurationERR0041
EnvelopeActionNotAllowedForRecipientERR0042

eSAW Errors from SIGNificant Server Platform (Workstep Controller)

Errors starting with “ERROR-” are returned from the SIGNificant Server Platform (to be exact the Workstep Controller component), which is handling the workstep and the workstep configuration. If you get this error, the mistake happend in the workstep configuration.

Workstep Controller ErrorError Code
WscWorkstepDoesNotExistERROR-12461
WscDocMissingERROR-12462
WscSaveDocNotAllowedByPolicyERROR-12463
WscPrepareSignNotAllowedByPolicyERROR-12465
WscAddPrepareSigFieldNotAllowedByPolicyERROR-12466
WscInvalidSignatureConfigProvidedERROR-12467
WscSigningNotAllowedByPolicyERROR-12468
WscAddSigFieldNotAllowedByPolicyERROR-12469
WscFinishWorkstepNotAllowedByPolicyERROR-12470
WscActionNotAllowedERROR-12471
WscFinalizeSignatureNotPossibleERROR-12472
WscSigningNotPossibleERROR-12473
WscSigFieldNotConfiguredForWorkstepERROR-12474
WscSigFieldWithIdMissingERROR-12477
WscRejectNotAllowedByPolicyERROR-12478
WscMissingXmlContentERROR-12479
WscDocumentIdEmptyERROR-12480
WscDocumentMissingERROR-12481
WscUndoNotPossibleERROR-12482
WscWorkstepAlreadyFinishedERROR-12483
WscInvalidConfigurationProvidedERROR-12484
WscPageMissingForSignatureERROR-12485
WscSignaturePositionOutsideOfPageERROR-12486
WscSigFieldTaskDisabledERROR-12487
WscRequiredParameterNotSetForSignatureERROR-12488
WscParameterMustNotBePresentERROR-12594
WscSignaturePropertyNotSetERROR-12597
WscPositionDoesNotFitConfigurationERROR-12598
WscAddFreeHandAnnotationNotAllowedByPolicyERROR-12600
WscAddTypewriterAnnotationNotAllowedByPolicyERROR-12601
WscBiometricDataMissingERROR-12871
WscInvalidSigTypeForFieldWithBioAuthenticationERROR-12872
WscCertificateIsExpiredERROR-13344
WscWorkstepIdIsEmptyERROR-13404
WscFormFieldDoesNotExistERROR-13411
WscRequiredReadonlyFormFieldNotAllowedERROR-13414
WscFormsGroupNotConfigedInWorkstepERROR-13415
WscFormFieldNotDefinedInGroupERROR-13417
WscRadioButtonNotDefinedInGroupERROR-13418
WscItemNotContainedERROR-13539
WscRadioButtonPropertiesNotEqualERROR-13540
WscArgumentNullERROR-13542
WscFileTypeNotSupportedERROR-13543
WscInvalidDocCompareResultERROR-13544
WscDocTypeNotAcceptedERROR-13545
WscDocUnknownERROR-13546
WscAddAttachmentsNotInGivenConfigurationERROR-13547
WscInvalidPasswordProvidedERROR-13549
WscConfirmReadNotAllowedByPolicyERROR-13550
WscPageOfReadingTaskMissingERROR-13551
WscReadingTaskPositionOutsideOfPageERROR-13552
WscSignatureWithIdAlreadyExistingERROR-13599
WscDuplicateTaskIdERROR-13601
WscSignaturePluginConfigMultipleDefinedERROR-13602
WscMissingSignaturePluginConfigurationERROR-13603
WscSignatureFieldSpecIdUndefinedERROR-13604
WscFileIdIsEmptyERROR-13606
WscAppendAdHocAttachmentNotAllowedByPolicyERROR-13609
WscCouldNotRestoreOriginalWscConfigERROR-13629
WscAddPrepareStampingFieldNotAllowedByPolicyERROR-13647
WscInvalidPositioningForLocalCertificateERROR-13648
WscNoCapturingMethodForLocalCertificateAllowedERROR-13649
WscReferencedPageIsMissingERROR-14000
WscPositionOutsideOfPageERROR-14010
WscNonExistingDocRefNumberSpecifiedERROR-14020
WscOnlyOneDocRefNumberAllowedForActionERROR-14021
WscImageResolutionTooLowERROR-14030
WscImageResolutionTooHighERROR-14031
WscImageColorDepthInvalidERROR-14032
WscAuthenticationNeededERROR-14100
WscInvalidProviderSpecifiedERROR-14102
WscProviderConfigurationErrorERROR-14103
WscTransactionInformationNeededForAuthenticationERROR-14105
WscAuthenticationProviderClientErrorERROR-14107
WscPrepareAuthenticationMissingNecessaryDataERROR-14109
WscPrepareAuthenticationHashAlgorithmNotSupportedERROR-14110
WscPreparedDataNotAvailableERROR-14111
WscPrepareAuthenticationHashAlgorithmNotDefinedERROR-14112
WscPrepareAuthenticationCertificateNotDefinedERROR-14113
WscSignatureDoesNotMatchCertificateERROR-14114
WscPreparedDataExpiredERROR-14115
WscRequestPrepareAuthenticationInformationMissingNecessaryDataERROR-14116
WscPrepareAuthenticationInvalidDataERROR-14117
WscAuditTrailNotEnabledERROR-14200
WscAddPictureAnnotationNotAllowedByPolicyERROR-17000
WscInplausibleWorkstepConfigurationERROR-17001
WscPdfFormsGroupNotInSameDocumentERROR-17100
WscWorkstepNotAccessibleERROR-18000
WscRequiredTaskDoesNotContainRequiredFieldsERROR-20003
WscPictureAnnotationTaskDefinitionAlreadyExistsERROR-20687
WscDuplicateSigIdERROR-24200
WscEnablePolicyAndValidityChecksErrorERROR-25856
WscPredefinedTypewriterAnnotationConfigurationDefinitionAlreadyExistsERROR-28280
WscTransactionCodeConfigurationIncompleteERROR-28731
WscTransactionCodeConfigurationMissingERROR-28732
WscTransactionCodeMissingInformationERROR-28733
WscReferencedTaskHasInvalidTypeERROR-34971
WscServerVersionIsWrongERROR-35238
WscAppendingFileToWorkstepNotAllowedERROR-51145
WscDifferentDocRefNumberDefinedInTaskAndTaskConfigurationERROR-53163
WscSigFieldDefinitionAlreadyExistsERROR-60854
WscReferencedFontSettingsDefinitionAlreadyExistsERROR-67106
WscAppendingTasksToWorkstepNotAllowedERROR-75653
WscColorizePdfFormsNotAllowedERROR-75654
WscTaskSequenceViolatedERROR-75655
WscAppendingCompletedTasksToWorkstepNotAllowedERROR-75656
WscReferencedTaskIsMissingERROR-84655
WscCertificateIsRevokedERROR-90568
WscFormsGroupDefinitionAlreadyExistsERROR-90720
WscDocumentCannotBeDisabledERROR-91536
WscDocumentCannotBeEnabledERROR-95109
WscReadingTaskDefinitionAlreadyExistsERROR-99368

Customization Error Codes

Errors codes of the customization interface.

NameError Code
GeneralERR0001
CustomizationFileFormatErrorERR0002
VariableErrorERR0003
MissingFileErrorERR0004