11. Error Code Descriptions
The following list describes all the error codes in more detail. The codes may contain one or more placeholders which will be discussed in each section.
11.1 Actor
Actor.NotFound:'actorId'
The given actor identifier could not be found in the database.
Actor.TypeInvalid:'FieldValue'
The Actor Type can only contain one of three possible values: "Approver", “Signer” or “Receiver”.
Actor.RedirectTypeInvalid
The RedirectType can only have one of the following values: “AfterCompletion”, “AfterDelay” or “Immediately”.
Actor.RedirectTypeNotAllowed
No RedirectUrl was defined.
11.2 CommitmentType
CommitmentType.NotAllowed
See section 5.4.13. The possible Commitment Types are limited to the ones described in this section.
CommitmentType.ShouldBeSameForActor
All the CommitmentTypes should be the same for all signingtype objects inside an actor object.
11.3 Document
Document.InvalidTargetFileType:'supported types'
The requested document type cannot be used for conversion, either because it is unsupported in eSignatures or because it has been disabled through configuration.
The placeholder includes the (comma-separated) list of supported types or configured types (which of the two is returned can be seen by the HTTP error code in which it is returned: HTTP 400 Bad Request indicates the requested type is unsupported).
Document.InvalidSourceFileType:'supported types'
The input document cannot be added because it was detected as a kind of document format which is either unsupported or disabled through configuration.
The placeholder includes the (comma-separated) list of supported types or configured types.
Document.PasswordProtected:'type of document'
The uploaded document is password protected, types of documents are pdf, word.
Document.NotFoundInStore:'document id'
The document with id 'document id' could not be found in the document store.
Document.NameInvalidLength:'document name length'
The name of the given document was longer than 150 characters.
Document.UnsupportedLanguage:'Given language'
The given document language is not supported.
11.4 Location
Location.NotFound:'FieldValue'
The provided location(s) could not be matched to one of the locations provided in the previous step: Add document to package.
11.5 MandatedSigner
MandatedSigner.BirthDateMissing
See section 5.4.12: when the Mandated Signer Validation type is NameAndBirthday and the provided signing type is either BeId, ManualBeId or itsme, the Stakholder’s BirthDate must be provided in the Request.
MandatedSigner.MandatedSignerIdMissing
See section 5.4.12: when the Mandated Signer Validation type is MatchId and the provided signing type is either BeId, ManualBeId or BeLawyer, a MandatedSignerId must be provided in the Request.
11.6 Package
Package.NotFound:'package id'
The package with id 'package id' could not be found.
Package.ApiVersionMismatch
The specified package was created with and old version of the api and cannot be used in the newest version of the api.
Package.InvalidStatus:'status' The operation on the specified package could not be performed because the package has an invalid status of 'status'.
Package.ApiVersionMismatch
The operation on the specified package could not be performed because the package has an invalid Api Version.
Package.ContainsNoDocuments:'packageId'
Package with id ['package id'] contains no documents
Package.ContainsDocumentWithNoSigners:'packageId'
Package with id ['package id'] contains a document with id ['document id'] with no signers
11.7 Pagination
Pagination.MaxQuantity.OutOfBounds
The requested number of items that would be returned falls out of the bounds of the defined range.
11.8 Pdf
Pdf.UploadDoesNotComplyToSpec
Uploaded or converted document doesn’t comply to the pdf specification.
11.9 PdfErrorHandling
PdfErrorHandling.InvalidType:'Given type'
Invalid value for pdf error handling method.
11.10 PhoneNumber
PhoneNumber.Invalid: 'phonenumber'
The provided phone number is not a valid mobile phone number.
11.11 Request
Request.RequiredFieldIsMissing:'FieldName'
The request could not be completed because a required parameter is missing.
The placeholder includes the name of the missing field. E.g. FirstName, EmailAddress, Actors, etc.
11.12 SignaturePolicy
SignaturePolicy.NotFound
See section 5.4.13. The available Signature Policies will have to be configured in a Mapping Table in advance. Mapping will be done based on the Oid of the Signature Policy.
SignaturePolicy.ShouldBeSameForActor
All the SignaturePolicyId's should be the same for all signingtype objects inside an actor object.
11.13 SigningField
SigningField.LabelNotUnique
Labels of signing field locations need to be unique. Note that using markers without passing a custom label will use that marker id as a label and that label will be included in the validation.
SigningField.MarkerAndCoordinatesCannotBeMixed
See section 5.2.7.1: a signing field location cannot specify both coordinates and a marker or field id.
SigningField.MarkerNotUnique
Markers must be unique within a single PDF and each marker can only be used once.
SigningField.InvalidHeightCoordinate
Signing field height needs to be larger than 70 points.
SigningField.InvalidWidthCoordinate
Signing field width needs to be larger than 112 points.
SigningField.InvalidHeightMarker:'markerOrFieldId'
The given marker id contains a height which is smaller than 70 points.
SigningField.InvalidWidthMarker:'markerOrFieldId'
The given marker id contains a width which is smaller than 112 points.
SigningField.MarkerOrFieldIdNotFound:#SignatureAgent
The marker or field id for the given signature agent was not found or did not confirm to requirements. Consequently, the signing field was not created.
See section 10.2 Signing location with id reference for more information on how to use markers.
SigningField.InvalidPage
One of the signing fields to be placed on a document uses coordinates, but the specified pagenumber exceeds the number of pages in the document. The page number must be between 1 and the maximum number of pages of the document (inclusive), or when counting from the end of the document it needs to be between -1 and –(maximum number of pages) (inclusive). When a 0 or a value outside the range gets passed then this error will be returned.
11.14 SigningType
SigningType.Invalid:'FieldValue'
The passed in signing type parameter is not a valid signing type.
11.15 Stakeholder
Stakeholder.UnsupportedLanguage:'language'
The provided language is not supported. The message might contain the currently supported values.
Stakeholder.BirthDayInFuture:'fieldValue'
The provided date cannot be a valid birthday because it is in the future.
Stakeholder.EmailAddressInvalid:'fieldValue'
The provided email address is invalid.
Stakeholder.UnsupportedStakeholderType
The provided stakeholder type is not supported. The supported values are: Person, PersonGroup and ContactGroup.
11.16 User
User.NotFound:'email address'
The user with the defined email address could not be found.
11.17 Audit Proofs
AuditProof.Disabled
Audit proof is disabled in the Configuration Index.
AuditProof.NotAvailableForPackageCorrelationId
No audit proof available for the given package correlationId.
AuditProof.NotAvailableForDocumentCorrelationId
No audit proof available for the given document correlationId.
AuditProof.InvalidStatus
Package has an invalid status.
AuditProof.NoAuditProofsForPackageAvailable
No audit proofs are available for this package.
AuditProof.NoAuditProofsForDocumentAvailable
No audit proofs are available for this document.