Versions Compared

Key

  • This line was added.
  • This line was removed.
  • Formatting was changed.

...

Section

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.

...

Section

Error Sample

Here you see a faulty uploadTemporarySspFile file/upload response, where the no file name was empty in the requestattached. The system returns you the baseResult as failedErrorId, the error code (ERR0002) and a textual descripton (errorMsg) why it failedmessage and the TraceId.


Code Block
languagexmljava
themeEclipse
<baseResult>failed</baseResult>{
  <errorInfo>
    <error>ERR0002</error>"ErrorId": "ERR0097",
    <errorMsg>ERR0002"Message": Parameter FileName is empty</errorMsg>"ERR0097 - File must not be empty.",
    <supportId>756094</supportId>
  </errorInfo>"TraceId": "f35aad06-1234-1234-1234-daedd619ed29"
}


Section

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:

Code Block
languagexml
themeEclipse
<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>


Section

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 responsible for the workstep and the workstep configuration (see below).


Section


Error
ErrorId
Error Code
Name
General
Comment

ERR0001

EmptyParameter
General

ERR0002

MissingUser
EmptyParameter
ERR0003

ERR0005

WrongUserTypeERR0004
PdfConversionFailed
ERR0005

ERR0008

HasDuplicateFormFieldNames
MissingFile
ERR0006

ERR0007

MissingEnvelope
ERR0007MissingFileERR0008AuthorizationFailedERR0009
EnvelopeActionNotAllowedForUser

ERR0010

InvalidParameterFormat
NotAllowedForUser

ERR0011

InvalidWorkstepConfiguration
InvalidParameterFormat

ERR0012

EnvelopeActionNotAllowedForEnvelopeState
InvalidWorkstepConfiguration

ERR0013

NotAllowedByLicense
EnvelopeActionNotAllowedForEnvelopeState

ERR0014

FileIsNoEnvelopeCompletedDocumentERR0015WorkstepIdMappingErrorERR0016IncompleteTemplateERR0017RecipientActionNotAllowedForRecipientState
NotAllowedByLicense

ERR0018

AlreadyExistingUserERR0019
ActivityActionNotAllowedForActivityState
FieldMarkupStringError

ERR0020

ElementNotWithinPageBounds
AdvancedDocumentTagError

ERR0021

UnsupportedMimeType
ElementNotWithinPageBounds
ERR0022

ERR0023

ContentDispositionMissingOrIncomplete
ERR0023ActionForRecipientOnlyAllowedOnBulkLevelActionForRecipientNotAllowedForBulks
ERR0024

ERR0025

MissingFirstNameFieldERR0026MissingLastNameFieldERR0027MissingEmailFieldERR0028MissingPasswordFieldERR0029CountryFieldInvalidValueERR0030LanguageInvalidValueERR0031DuplicateEmailERR0032InvalidInputERR0033InvalidEmailAddressERR0034DeniedByUserSettingERR0035MissingConfigurationERR0036DuplicateOrganizationNameERR0037InvalidTimezoneERR0038MissingTimezoneERR0039TemplateHasNoDocumentsERR0040MissingDisposableConfigurationERR0041EnvelopeActionNotAllowedForRecipientERR0042
Section

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.

ActionForActivityNotAllowedForBulks

ERR0041

MissingDisposableConfiguration

ERR0053

RejectedByFileContentValidationError

ERR0055

MaxFileSizeExceededError

ERR0056

MissingSwisscomOnDemandCertConfigurationError

ERR0059

MissingSwedishBankIdCertConfigurationError

ERR0061

EnvelopeNotLocked

ERR0063

InvalidEnvelopeApiVersion

ERR0065

ActionForActivityNotAllowedForBulkChild

ERR0067

UploadFileFailed

ERR0068

DeleteFileFailed

ERR0081

PermissionsMissing

ERR0090

GenericFilteringError

ERR0091

IncompatibleFilterUsed

ERR0092

InStatusSinceDaysFilterWithoutStatusFilterError

ERR0093

ForceAuthenticationMissing

ERR0095

InvalidRecipientType

ERR0096

Pkcs7NeedsAtLeastOneSignature

ERR0097

ContentEmpty

ERR0098

FieldDefinitionForUserDefinedElementMissing

ERR0110

InvalidTeamNoValidUserFoundForTeamMember

ERR0111

InvalidTeamHasNoHeadUser

ERR0112

MultipleUsedTeamName

ERR0113

MultipleUserOccurrenceInSameTeam

ERR0152

ProviderDisabled

ERR0153

ProviderNotFound

ERR0161

AmbiguousExpirationParametersSent

ERR0162

NoExpirationParametersSent

ERR0163

EnvelopeValidityTooLow

ERR0164

EnvelopeValidityTooHigh

ERR0170

InvalidExpiration

ERR0171

FirstReminderDayAmountTooLow

ERR0172

FirstReminderDayAmountTooHigh

ERR0173

RecurrentReminderDayAmountTooLow

ERR0174

RecurrentReminderDayAmountTooHigh

ERR0175

BeforeExpirationReminderDayAmountTooLow

ERR0176

BeforeExpirationReminderDayAmountTooHigh

ERR0200

NotAllowedForOrganizationThe method/action cannot be done due to organization specific configuration which disallows the operation. Typically, an administrator of the organization has to change some configuration for the entire organization, to allow the action.

Example: 
"ERR0200 - Custom Agreements are not allowed for Organization"
in this case, an administrator can allow sending the agreement by changing the Agreements Configuration.

ERR0210

OAuthIdentificationWithAuth

ERR0211

IdentificationWithAuth

ERR0212

OAuthIdentificationUpdateFieldMismatch

ERR0250

DraftNotAvailable

ERR0251

DraftActivityNotAvailable

ERR0255

BulkParentNotAvailable

ERR0256

NoEnvelopeBulkChildInExpectedState

ERR0258

EnvelopeActivityNotAvailable

ERR0260

TemplateNotAvailable

ERR0300

DraftNotReadyForSending

ERR0310

DuplicateEmailInParallel

ERR0406

DraftCanNotContainMoreThanOneBulk

ERR0407

DraftWithParallelAndBulkNotAllowed



ERROR-99368

Section

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 happened in the workstep configuration.
For a detail overview of all error codes please see SIGNificant Server Platform - Release Notes (e.g. SSP 22.50.0.34 - WSC Error Codes) - restricted access.

Section
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
WscReadingTaskDefinitionAlreadyExists


Section

Customization Error Codes

Errors codes of the customization interface.


Section


NameError Code
GeneralERR0001
CustomizationFileFormatErrorERR0002
VariableErrorERR0003
MissingFileErrorERR0004