{"info":{"_postman_id":"385ce8f5-4172-42b8-a328-2fc2908cd24f","name":"Nitro Sign Enterprise Verified- Public API","schema":"https://schema.getpostman.com/json/collection/v2.0.0/collection.json","toc":[],"description":"","owner":"9006462","collectionId":"385ce8f5-4172-42b8-a328-2fc2908cd24f","publishedId":"VUqoRKBE","public":true,"customColor":{"top-bar":"FFFFFF","right-sidebar":"303030","highlight":"EF5B25"},"publishDate":"2024-07-04T10:56:32.000Z"},"item":[{"name":"v7.6 - Documentation","item":[{"name":"Configuration","item":[{"name":"Gets all contact groups","id":"e7741044-31e0-4d9c-bd2e-aeea416b79f9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get ContactGroups

\n

Description

\n

This call retrieves all the contact groups, and their code, that are currently created in the eSignatures WebPortal.

\n

The ContactGroup code can be entered as a request parameter when doing a Create Package call. Any member of the requested contact group will be able to sign the package for the entire group.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/contactgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of contact groupsArray of objects
NameName of the contact groupString
CodeUnique id of the contact groupString
MaxQuantityMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe contact groups list gets returned successfully.
400 Bad requestA request parameter was invalid.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["contactGroups"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"b49d7be1-d8b1-4841-b6eb-268771147c2c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"05e262ce-b886-42fa-ac37-5cd85a8952ec","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n },\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n }\n]"},{"id":"3ee1e20f-e707-41a3-8986-67128a6d2d60","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e7741044-31e0-4d9c-bd2e-aeea416b79f9"},{"name":"Retrieves all document groups to which packages can be assigned","id":"5a991c1e-f8ac-48a1-be8e-d95e2e8829b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/documentGroups","description":"

Get DocumentGroups

\n

Description

\n

Some requests need to identify a Document Group in which a document is to be used. This request allows to list the names of document groups and most importantly their associated codes.

\n

There is always at least one document group: “My Documents” (the name could be different) with Code “00001”. This group is special because the documents in this group are only visible to the eSignatures Portal user who uploaded the document (in case of an upload made through the API from this document it will be the user whose email was given as Initiator).

\n

Please note that the Code field is a string. Its value may look numeric but its leading zeroes are part of the value.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/documentgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentGroupsList of all document groupsArray of objects
NameName or description of the document groupString
CodeA unique value identifying each document groupString
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document groups gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["documentGroups"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"8731378e-eb52-416b-9a4d-33c16ad94ae3","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"DocumentGroups\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ]\n}"},{"id":"2855759c-cd3d-4f6b-827f-09797882667d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5a991c1e-f8ac-48a1-be8e-d95e2e8829b7"},{"name":"Retrieves all languages that are enabled in the application","id":"8a8e3f9e-1120-4fa5-8ee2-efca6b185d19","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/languages","description":"

Get Enabled Languages

\n

Description

\n

This call retrieves the list of languages that have been enabled in the eSignatures Configuration Index and are thus available in the eSignatures Portal.

\n

This call is useful for integrators who need to know which languages are currently enabled in a given eSignatures installation.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/languages

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EnabledLanguagesList of enabled languagesArray of objects
DisplayNameDisplayName of the language as defined in the Config Index.String
NativeNameNativeName of the language as defined in the Config Index. The NativeName is the name of the language in its actual language. E.g. français for French.String
IsoCultureCodeISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe EnabledLanguages list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["languages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a156d055-95db-4c75-a9f8-09a7fe468bbe","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"EnabledLanguages\": [\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n },\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n }\n ]\n}"},{"id":"9f731736-48b0-4f18-b389-23741e5095e3","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8a8e3f9e-1120-4fa5-8ee2-efca6b185d19"},{"name":"Retrieves all themes that can be assigned to a packages","id":"42c5d120-c0e2-4f25-994e-c8985c94b985","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get Themes

\n

Description

\n

This call retrieves all the Themes, and their code, that are currently created in the Configuration Index.

\n

The theme code can be entered as a request parameter when doing a Create Package call. The packages in question will then have the requested theming.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/themes

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of themesArray of objects
NameName of the themeString
CodeUnique id of the themeString
MaxQuantityMaximum number of recordsInt
TotalTotal number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe themes list gets returned successfully.
400 Bad requestA request parameter was invalid
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["themes"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"13167165-29bd-46da-9c14-6982b36183eb","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"8f607ecf-d94b-455c-85b0-1508e748387a","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"694f33a4-4413-4abb-8e07-50c7386676c0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"42c5d120-c0e2-4f25-994e-c8985c94b985"},{"name":"Retrieves the version of the WebSigner application","id":"d30ffc1a-25a5-4ac0-ad77-bd347bd7622e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/version","description":"

Get Version

\n

Description

\n

This call checks the version and build number of eSignatures.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/version

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ProductVersionNumber of the versionString
FileVersionNumber of the file (build)String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe version and build number get returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["version"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a1281a72-9a6c-44e7-8038-89940c51b78d","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ProductVersion\": \"\",\n \"FileVersion\": \"\"\n}"},{"id":"ee36eb5c-12f7-4072-9434-80a6134471f8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d30ffc1a-25a5-4ac0-ad77-bd347bd7622e"}],"id":"1ae9e879-11d6-4aa6-9214-cc80d1da8b40","description":"

Retrieving information about the configuration

\n","_postman_id":"1ae9e879-11d6-4aa6-9214-cc80d1da8b40","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Packages","item":[{"name":"Gets all packages","id":"0980bbfa-a8ae-4f97-8856-599ae93d4d37","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","description":"

Get packages

\n

Description

\n

This call retrieves all packages that currently exist within eSignatures, and their current status.

\n

Packages are always sorted on creationDate. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.Integer
PageSizeMaximum number of records in the response Default value is 20.Integer
CreatedBeforeGets only the packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the packages created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
DocumentGroupCodeGets items that have given documentGroupCode. An admin may configure document groups in eSignatures to which users can upload their documents. The documentGroupCode is the identifier of the document group to which the package has been uploaded.String
InitiatorGets only the packages created by the specified initiator email address.String
PackageNameGets packages that have the specified name as package name.String
ExternalReferenceGets packages with the specified value as external package reference. Note this only applies for external package references, not external document/field references.String
SortDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. Default value is 20.Integer
TotalTotal number of items.Integer
ItemsThe packages that are retrieved.Obects
\n

The Response parameters per package are identical to the ones of the Create package call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

Select items that have given initiator email address

\n","type":"text/plain"},"key":"initiator","value":""},{"description":{"content":"

Select items that have given package name

\n","type":"text/plain"},"key":"packageName","value":""},{"description":{"content":"

Select items that have given external reference

\n","type":"text/plain"},"key":"externalReference","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"150ec7e0-2d11-4e4e-80e5-67f2f7bde32b","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Processing\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"document\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n },\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"InProgress\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Rejected\",\n \"Elements\": [\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"ProcessingFailed\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n }\n ]\n}"},{"id":"44eceb57-0e4f-4b7d-9b65-0fab9a73284a","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0980bbfa-a8ae-4f97-8856-599ae93d4d37"},{"name":"Creates a new package","id":"f2f431cf-c062-418d-b081-86a2bee910f5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"\",\r\n \"Initiator\": \"\",\r\n \"Status\": \"pending\",\r\n \"ExpiryDate\": \"\",\r\n \"DefaultLegalNotice\": {\r\n \"Name\": \"\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Name\": \"\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"PdfOptions\": {\r\n \"TargetFormat\": \"pdfa1a\"\r\n },\r\n \"Base64data\": \"\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n }\r\n ],\r\n \"Stakeholders\": [\r\n {\r\n \"Type\": \"person\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\",\r\n \"PhoneNumber\": \"\",\r\n \"AdditionalProperties\": {\r\n \"BeId\": \"\",\r\n \"BeLawyer\": \"\"\r\n },\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 0,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 0,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"Type\": \"group\",\r\n \"GroupName\": \"\",\r\n \"Members\": [\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n },\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n }\r\n ],\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 1,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 1,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"ThemeCode\": \"string\",\r\n \"CallBackUrl\": \"https://callback.test\",\r\n \"NotificationCallBackUrl\": \"https://notifications.test\",\r\n \"DefaultRedirectUrl\": \"\",\r\n \"F2fRedirectUrl\": \"\",\r\n \"IsUnsignedContentDownloadable\": true,\r\n \"IsReassignEnabled\": false,\r\n \"ExternalReference\": \"myFirstPackage\",\r\n \"ActionUrlExpirationPeriodInDays\": 7,\r\n \"ProofCorrelationId\": \"\",\r\n \"AddInitiatorAsReceiver\": false,\r\n \"MustBeArchived\": true,\r\n \"ArchiveAuditProofs\": false,\r\n \"ArchiveAuditTrail\": false,\r\n \"AutomaticReminder\": {\r\n \"IsSendAutomaticRemindersEnabled\": true,\r\n \"DaysBeforeFirstReminder\": 2,\r\n \"IsRepeatRemindersEnabled\": true,\r\n \"RepeatReminders\": 3\r\n },\r\n \"ExpirationReminder\": {\r\n \"IsSendExpirationRemindersEnabled\": true,\r\n \"DaysBeforeExpirationReminder\": 2\r\n },\r\n \"OtpAuthenticationSetting\": {\r\n \"IsSmsOtpAuthenticationEnabled\": false,\r\n \"IsMailOtpAuthenticationEnabled\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages","description":"

API 4: Create package

\n

Description

\n

The POST package call creates an empty package, to which documents can be added later on.

\n

In its simplest form, this method contains only two request parameters: the package name and the initiator, which is the user who will be sending the packages. Afterwards you can build on this method by adding additional resources. You can add documents, elements, stakeholders, actors, etc. by using their respective calls.

\n

You can also choose to define all parameters in a single POST package call, making it a so-called \"super call\".

\n

Size limitations

\n

Consider the following size limitations when creating packages.

\n
    \n

  • A package must not exceed 150 MB.

    \n
    • \n

  • A package must not contain more than 15 documents and each document must not exceed 30 MB.

    \n
    • \n

  • An .xml file must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.

    \n
    • \n

  • Large files might affect signing performance depending on the user's Internet connection.

    \n
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n

The parameters with an asterisk are mandatory. All others are optional.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the package. The name is displayed in the eSignatures WebPortal, and used as file name when you download the package as .zip file from the WebPortal. Note: do not add an extension to the Name value Important: Pay attention when choosing a package name. Don’t use forbidden file name characters such as slash (/), backslash (), question mark (?), percent (%), asterisk (*), colon (:), pipe (), quote (‘), double quote (\"), less than (<), greater than (>). Note however, that is list is not exhaustive. Don’t use characters that are HTML-sensitive such as ampersand (&) or apostrophe (‘). Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150
Initiator*The email address of the user who will send the package. The user must be a known user in the eSignatures WebPortal.String (email)
StatusThe status the package will be in when created. The possible values are: draft or pending. By default, a package is in draft after creation.String (enum)
DocumentGroupCodeThe documentGroupCode is the identifier of the document group to which the package must be uploaded. In a default configuration, an initiator uploads packages to their personal MyDocuments folder, which cannot be shared with others. To enable collaboration however, an eSignatures admin can configure multiple document groups to which different users may have access. This way, they can collaborate on one another's' documents. To upload packages to the MyDocuments folder, do not use this parameter, or specify value 00001. To upload packages to a specific document group, enter its documentGroupCode. Tip: to know which document groups have been configured in eSignatures, use the Get document groups call.String
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time. E.g. 2018-01-23T12:34:00.000ZString (date-time)
DocumentsDocuments in base64 encoded format that must be added to the package. The request parameters regarding documents are identical to those of the Add document call and are described here.Array of objects
StakeholdersStakeholders that must be added to the package. A stakeholder is an object that provides information about any person who is involved with the package. The request parameters regarding stakeholders are identical to those of the Create stakeholder call and are described here.Array of objects
DefaultLegalNoticeThe default legal notice that will be added to a signer when no legal notice is specified. See the section defaultLegalNotice below for more info.Object
ThemeCodeDefines which themeCode must be applied to the package. An eSignatures admin can rebrand the look and feel of the eSignatures WebPortal by creating and configuring new themes. Each theme has a themeCode to identify it. When this parameter is not used, the theme that has been configured on environment level in the Configuration Index, or on document group level if applicable will be applied.String
CallBackUrlThe Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place. See Callback URL details below.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URL. Since eSignatures by default uses one-time URLs, the link to sign a package only works once. As soon at is has been clicked, the link expires and a new signing link must be requested.String (url)
DefaultRedirectUrlDefault URL to which stakeholders will be redirected after completing their actions. Set on package submit, when actor has no RedirectUrl. New since eSignatures 7.0.String (url)
F2fRedirectUrlURL to which the end user is redirected after all fields have been signed or rejected face to face in the Document Portal. See the F2fRedirectUrl Details section below for more information.

Attention: Don't confuse the f2fRedirectUrl with the regular RedirectUrl. The f2fRedirectUrl only applies when signing face to face in the Document Portal. The redirect occurs after signing or rejecting. This field must be a valid absolute url.

Note: during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new url after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.		String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting. Enter ‘true’ if you want actors to be able to download the package before form filling/approving/signing. This way they can print it and read it on paper for instance. Enter ‘false’ to hide the download icon and prevent actors to be able to download packages from the WYSIWYS. When this parameter is not used, the value from the Config Index setting IsDownloadUnsignedFilesEnabled under Customization Settings is used.Boolean
IsReassignEnabledDetermines whether a stakeholder may reassign their action to another party. Enter ‘true’ if you want actors to be able to reassign the package. Enter ‘false’ to hide the reassign button and prevent actors to be able to reassign packages from the WYSIWYS. When no value is entered, this parameter takes it value from the Config Index setting IsReassignEnabled under Customization Settings.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String (GUID)
AddInitiatorAsReceiverThis parameter is available as of eSignatures 6.5.0. It determines whether the initiator is added by default as receiver of the package. This way, you no longer need to do this manually in a Create actor call.

This parameter allows to override the default environment level setting IsAddInitiatorAsReceiverEnabled set in the Configuration Index.
Note however that when that setting is set to true, it is unnecessary to pass the AddInitiatorAsReceiver parameter, since each initiator is then added as receiver by default.		Boolean
MustBeArchivedAvailable as of eSignatures 6.6.0, this parameter enables you to determine whether the package should be archived or not.
Note: The value will be ignored if archiving is not configured on an environment level in the Config Index.
When archiving is configured, it is unnecessary to pass the MustBeArchived parameter, since each package is then archived by default.		Boolean
ArchiveAuditProofsAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit proofs must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit proofs are disabled in the audit tools settings or in the archive settings.		Boolean
ArchiveAuditTrailAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit trail must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit trail is disabled in the audit tools settings or in the archive settings.		Boolean
TemplateCodeDefines which template will be used for the package. When using a template code the package will have all the information from the predefined template already implemented, You can still add or change information using additional api calls.
Note: When using a templateCode the only other mandated parameter is the \"Initiator\", the following are optional: \"name\", \"ExternalReference\" and \"ProofCorrelationId\" all others will be overwritten by the template itself.		String
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:

- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer). The minimum value: 1.
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer). The minimum value: 1.

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:

- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer). The minimum value: 1.

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that will be applied to the signer when no legal notice is specified.

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive*.

\n

*When using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

When defining a defaultLegalNotice, you can choose from two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LEGALNOTICE1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

The maximum length of the text value is 1000 characters (including fill-in values). When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable.

\n

Instant Package

\n

API v4 allows to mimic the 'Instant Package' functionality available within API v3. This is possible by combining all different objects within one call (not applicable when using a templateCode)

\n
    \n

  • Create Package

    \n
    • \n

  • Add document(s)

    \n
    • \n

  • Add element(s)

    \n
    • \n

  • Add stakeholder(s)

    \n
    • \n

  • Add actor(s)

    \n
    • \n

  • Add process

    \n
    • \n
\n

This does bring one additional concept to take into account when adding multiple documents, as you will need to define for which document you are adding the stakeholder(s) / actor(s). As at this point you have not yet received the documentId, the concept of documentIndex has been introduced on element level. The documentIndex is being used to identify the document for which the actor is being added, 0 being the first document in the call, 1 the second and so on.

\n

Response parameters

\n

The Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe package was created successfully.
400 Bad requestRequest validation failed. The package could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
409 ConflictThe package could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Package.InitiatorInvalid
400Url.Invalid
400Request.UnsupportedValue
400Document.UnsupportedLanguage
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400LegalNotice.NameAndTextUsedSimultaneously
401Authentication failed, username or password incorrect
404DocumentGroup.NotFoundWithCode
404Theme.NotFoundWithCode
404User.NotFound
404Actor.NotFound
404Stakeholder.NotFound
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
409Document.DataMissing
409SigningField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
409Package.UnassignedElements
\n

CallbackUrl Details

\n

The Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place.

\n

A callback happens in the following cases:

\n
    \n

  • A user has changed the status of the package created via API from Draft to Pending through the Document Portal.

    \n
    • \n

  • A user has clicked confirm in a Drag and drop editor window.

    \n
    • \n

  • A user has revoked the package through the Document Portal.

    \n
    • \n

  • One of the signers has completed all their signing fields.

    \n
    • \n

  • All signers signed the package.

    \n
    • \n

  • One of the signers has rejected the package.

    \n
    • \n

  • The approver approved the package.

    \n
    • \n

  • The form fillers completed the fields.

    \n
    • \n

  • The status of the package has been changed to Failed by the system.

    \n
    • \n
\n

Note: API requests explained in this document will never trigger a callback. A callback will happens only when an end user triggers an action in the eSignatures Portal or Signer application. Other triggers might be added in the future.

\n

The callback URL must contain a valid, absolute URL with no parameters.

\n

eSignatures 6.4.1 to current:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"Finished\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

As of eSignatures 6.0, the base URL CallbackURL only contains PackageId as parameter. The PackageStatus is passed in the application/json body. Prior to 6.0, the base URL contained both the packageId and the packageStatus - also notice the difference in casing. If you're upgrading from eSignatures 5.x and have an existing integration you don't want to break, make sure to select the legacy or both option under API Settings in the Config Index. That way, the PackageId and PackageStatus parameters are still appended to the base URL. The body uses parameters starting with a lower case, such as 'packageId', while the CallbackURL uses parameters that start with a capital letter, such as 'PackageId'.

\n

Until eSignatures 6.3.x:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"FullySigned\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

Important:

\n
    \n
  • If you are upgrading from eSignatures 5.x, and you want to append the PackageId and PackageStatus to the base URL, as was the standard behavior in eSignatures prior to version 6.0, make sure to select the legacy or both option under API Settings in the Config Index.
    • \n
\n

However that there is a difference in casing between the two eSignatures versions. As of version 6.0, camel casing in used. If your integration is case-sensitive, it will fail on the callback verification, since it expects the parameters \"PackageId\" and \"PackageStatus\" in the CallbackURL instead of \"packageId\" and \"packageStatus\". This casing issue has been solved in eSignatures 6.4.1.

\n
    \n
  • For performance and scalability purposes, a Callback timeout has been introduced and is set to 100 seconds. This way, if the driving application doesn’t respond to eSignatures’ callback, a timeout will be forced, and the rest of the flow will be finished as if the expected 200 OK message were received. If eSignatures were to wait indefinitely for a response to finish the package, its performance would drop drastically.
    • \n
\n

For this reason, it’s highly recommended that the client’s callback service is developed in such a way that it sends its response as soon as possible. Any other actions done by the callback service must not depend on the response being sent but should function asynchronously.

\n

In case a Callback error should occur, eSignatures by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See the Installation Documentation for more information.

\n

Notification Callback Details

\n

The Notification Callback parameter, if specified, will in certain cases override the usual behavior of sending out emails and triggers a remote service instead. The remote service must then retrieve information about the package and choose what to do.

\n

While the normal callback is called for major state changes, the notification callback can be called multiple times without any apparent change. For that reason, the callback includes information about the type of notification which was requested.

\n

The remote server is called only once per user action; there is no retry unless the end user requests a new notification.

\n

This callback system may at one point be superseded by a more generic extension mechanism for notifications. At that point only the more generic mechanism will receive improvements.

\n

eSignatures waits for this remote service to complete its job before returning control to the end user. Therefore the remote service needs to give a response within seconds.

\n

A callback consists of a POST request to the specified URL with content-type application/json. The following parameters are available in the JSON body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the packageString (GUID)
actorIdIdentifier of the actor for which the notification was triggeredString (GUID)
languageThe language which the end user was told to use (see the Language parameter in the Stakeholder object of the Set Process Information call).String
notificationTypeKeyWhich kind of notification was requestedString
\n

A callback may currently happen in the following cases:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
notificationTypeKeyUse Case
SendActionUrlThe single-use action (form filler, approver, signer) link has been used already and the end user requested a new link.
SendDownloadUrlThe single-use download link has been used already and the end user requested a new link.
\n

Since this list may grow in the future, the remote service will need to ignore other types without returning an error response.

\n

Other use cases will not send a callback until explicitly listed in the table above. The existing emails sent when a package is created, revoked, etc. will depend on the SuppressNotifications parameter which is separate from the NotificationCallbackUrl.

\n

In case a callback error should occur, eSignatures now by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See Installation Documentation of the latest released version for more information.

\n

F2FRedirectUrl Details

\n

The F2FRedirectUrl is used to redirect the end user after all fields have been signed or rejected face to face in the Document Portal.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create Package call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. PackageId)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.
    For consistency, the F2FRedirectUrl response parameter is also named PackageExternalReference.

    \n
    • \n
\n

The F2FRedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.

\n

For example, if the F2FRedirectUrl parameter contains the following redirect URL:

\n

https://myserver.example.org/rental/services/testredirect

\n

Then, the effective F2FRedirectUrl will be:

\n

https://myserver.example.org/rental/services/testredirect?PackageExternalReference=DemoReference&Status=SIGNED&SessionID=38bb590e-1eca-4c98-bf0c-bf1af2347000

\n

The end user can counterfeit the RedirectUrl because the redirection happens client-side.
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

During asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"72d8bedb-78ec-4844-82f3-ca0d660609a2","name":"Package was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Name\": \"example package\",\n \"Initiator\": {\n \"value\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5fcd81a5-f723-44d2-a79b-e46f3a61bc47","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"1515fe39-33fd-4a0e-b846-a9ee1ca80f47","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0c335759-7480-4dba-89cb-0e3052c5498b","name":"The package could not be created.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"947e6acb-b048-44cd-9d3d-015b3efe16d1"},{"name":"Gets a package by id","id":"92714d35-b5f0-4fbd-a396-02997e7a6168","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId","description":"

Get package by ID

\n

Description

\n

This call allows you to retrieve a package by its ID.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the package.String (GUID)
NameName of the package. Minimum length: 1 Maximum length: 150String
StatusStatus of the package.String (enum)
CreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00:00ZString (date-time)
ExpiryDateDate and time when the package will expire. Format is ISO 8601 date-time. E.g. 2020-01-25T13:00:00:00ZString (date-time)
InitiatorEmail address of the user who sent the package. This must be a known user of the WebPortal.String (email)
UnplacedElementsDetails of each of the elements that have not been placed or sized in a document. The unplaced element response parameters are the same as the element response parameters listed in the tables below, except that they do not have a location and dimension.Array of objects
DocumentsThe documents that were added to the package. The document response parameters are listed in the table below.Array of objects
StakeholdersThe stakeholders that were added tp the package. The stakeholder response parameters are listed in the table below.Array of objects
DefaultLegalNoticeDefault legal notice that has been added for the signer(s). The default legal notice response parameters are listed in the table below.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
DocumentGroupCodeIdentifier of the document group to which the package will be added.String
ThemeCodeIdentifier of the themeCode that has been applied to this package.String
CallBackUrlLink that will be called upon each status change. See CallbackUrl Detailsbelow for more info.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URLString (url)
F2fSigningUrlLink to the package which allows to start a face to face signing session.String (url)
PreviewUrlLink to access the preview for a pending package.String (url)
F2fRedirectUrlLink to which the end user is redirected when all fields have been signed, or when a field has been rejected. Attention: not to be confused with a \"regular\" redirectUrl.String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting.Boolean
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String
AddInitiatorAsReceiverWhether or not the initiator has been added as receiver of this package.
Note: This parameter is only returned for draft packages.		Boolean
WarningsWarning about the package, e.g., missing data. The warning response parameters are listed in the table below.Object
MustBeArchivedWhether or not the package will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditProofsWhether or not the audit proofs will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditTrailWhether or not the audit trail will be sent to the external archive when the package status is Finished.Boolean
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:
- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer).
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer).

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:
- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer).

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

Document response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. The element response parameters are listed in the tables below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Further information regarding documents is identical to those of the Add document call and is described here.

\n

Element response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document. The location response parameters are listed in the table below.Object
DimensionsDimensions of the element. The dimensions response parameters are listed in the table below.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field. The legal notice response parameters are listed in the table below.Object
MarkerType (as of 7.5.0)The type of marker of an unplaced element. Possible values: None, Text, PdfFormField. Note: Only viable for unplaced elements of a package.String (enum)
MarkerId (as of 7.5.0)A piece of text or PDF field identifier of the corresponding MarkerType. Note: Only viable for unplaced elements of a package.String (date)
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Further information regarding elements is identical to those in the Create element call and is described here .

\n

Stakeholder response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Further information regarding stakeholders is identical to those of the Create stakeholder call and is described here.

\n

Actor response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers. The result response parameters are listed in the table below.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
Links/MemberLinksThis parameter defines links for interacting with the package.String (url)
ActionUrlsThis parameter will lead to the download for a Receiver, for other actors it will lead to the WYSIWYS or the Preview.Array of objects
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByThe actor information see table belowObject
CompletedDateDate when the action was completed.String (date-time)
RejectReasonReason why a document was rejected.String
\n

CompletedBy

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

ActionUrls

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
UrlLinks to interact with the package.String (url)
TypeType of the ActionUrl.String
\n

Further information regarding actors is identical to those of the Create actor call and is described here.

\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that is applied to the signing field. A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive. However, when using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

There are two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Warning schema

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage is successfully retrieved.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId"],"host":[""],"query":[],"variable":[{"id":"b9489a97-4bed-4c51-9277-d6d9587aaf75","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7a4f362f-77be-46ad-83b1-cdfb7651f4e6","name":"Package was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Finished\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"InProgress\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n}"},{"id":"281f2079-8432-4dd6-8e1d-ec450a88bc93","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9d4f01dd-75ed-475b-b4b6-499e6839d90b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"92714d35-b5f0-4fbd-a396-02997e7a6168"},{"name":"Deletes a package by id","id":"481963df-66cf-4614-8d71-47e622fb279f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId?delayedDeletionTime=","description":"

Delete package by ID

\n

Description

\n

This call allows you to delete a package from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use the DELETE packages by ID call.

\n

Note: you can only delete a package that has status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package that must be deleted.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of this package will be deleted, once the package has been deleted. When this parameter is not sent, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictPackage could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId"],"host":[""],"query":[{"description":{"content":"

The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.

\n","type":"text/plain"},"key":"delayedDeletionTime","value":""}],"variable":[{"id":"6e1c09e0-6baa-4c69-93cc-c27fc762cdd9","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"8487ae96-9200-4459-aec9-9f821702b4c6","name":"Package was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"53ac672a-973b-4629-b265-c2d041cb3327","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"b77578ca-0cea-4781-bce1-f26693c5351f","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7ebc8782-8bf0-4322-b4c4-78a22e4adef6","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"6947a203-d7f5-4db0-8f1d-8f992b291ae9","name":"Package could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"481963df-66cf-4614-8d71-47e622fb279f"},{"name":"Gets a package's expiry date by","id":"688ff9ae-70d5-4881-8849-16ceee4403d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/expirydate","description":"

Get package expiry date

\n

Description

\n

This method allows you to retrieve the expiry date of a package.

\n

The only template parameter you need to use is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage expiry date was successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"5be91ff4-0258-4382-8160-f778ce2dee59","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1682977c-5be2-4d27-a02b-22921e99c42a","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"63002f0f-7224-4365-9fe5-585d808f2c7a","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b6540c98-8394-4c8a-bf08-1dc17beb617c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"688ff9ae-70d5-4881-8849-16ceee4403d9"},{"name":"Updates a package's expiry date","id":"eab3b640-99d3-408d-afb0-dea88c0b9011","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/expirydate","description":"

Update package expiry date

\n

Description

\n

This call allows you to update the expiry date of a package. This way, you can make a document that was expired available again.

\n

The only template parameter you need is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to update.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage expiry date was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"a28a1aa6-35a5-4ea4-9084-8b582c231ac0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"2d4898fa-7cca-4f1c-8670-621ebad0f249","name":"package's expiry date was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4b763423-05ef-49a2-8f26-74ddbbe6cd7b","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"6dd4a152-af93-4646-85f9-e9b65f52a31e","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fbc52948-1558-403a-9683-694a9c5b141a","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"753cfe5c-05e8-4704-97f2-f8af6eec0789","name":"Exiry date of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"eab3b640-99d3-408d-afb0-dea88c0b9011"},{"name":"Gets a package's status","id":"cd098e4a-35ab-44cc-9d12-d9a649b33b76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/status","description":"

Get package status

\n

Description

\n

This method allows you to retrieve the status of a package.

\n

The only template parameter you need to use is packageId.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusThe possible values are: DraftActionNeeded, Draft, Pending, InProgress, Ending, Finished, Rejected, Revoked, Expired, Failed, Processing, ProcessingFailed.String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStatus was successfully retrieved.
401 UnauthorizedThe caller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"id":"f29cba5a-78b5-42fa-8eeb-8c9ace20ddaf","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"a5655aa6-0c78-4ba6-acd9-983433c2585e","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"cd098e4a-35ab-44cc-9d12-d9a649b33b76"},{"name":"Updates a package's status","id":"605d1b93-bcc9-4854-853c-e2ffa2978be9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/status","description":"

Update package status

\n

Description

\n

This call allows you to update the status of a package.

\n

Possible combinations:

\n
    \n
  • Draft to pending
    • \n
  • Pending to revoked
    • \n
\n

Draft to pending

\n

When the package is ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the package visible to each of the stakeholders in their Signer Portal. \n 

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been form filled/approved/signed yet, or packages of which the signing has failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status \n 

\n

HTTP Method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Status

Status to which the package must be updated. The possible values are:

- pending
- revoked.

Please note: the status parameter is part of the URL and must be omitted from the body, because you only need the value in the body, such as “pending”, and not the parameter, such as “status”:”pending”, which is the case for all other calls.

String (enum)
\n

\n

Example

\n
\"pending\"\n\n

\n

Response parameters

\n

None.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage status was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
409 ConflictPackage status could not be updated.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"id":"c7d3204a-19aa-495b-b189-3a91ada396a3","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"0d375ba2-3e63-46f3-9129-09400d8089f9","name":"package's status was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"revoked\"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f6fa2ffc-5a7b-4385-8718-02881b49473a","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"01fbe675-17c3-4a0b-a278-ca4a6f1e6f40","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5bc80742-afdb-4643-bd5b-598b70fc8ed5","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"750ae014-d5ff-45c8-8265-280598f3b287","name":"Status of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"605d1b93-bcc9-4854-853c-e2ffa2978be9"},{"name":"Updates a package's documents order indices","id":"306f5e2f-f556-4ce0-95dc-549cfa667b05","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/orderindices","description":"

API v4: Reorder documents in a package

\n

This call updates the order of the documents in a Draft package.  \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/orderindices \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Documents

The documents from the draft package you want to change in order.

Child parameters:

- DocumentId (String (Guid)).
- OrderIndex (Integer). The order of the document

Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe order of the documents has been updated.
400 Bad RequestCould not update the order.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not FoundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Package.InvalidStatus
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents","orderindices"],"host":[""],"query":[],"variable":[{"id":"d263391a-022d-48ad-be87-6f022375136d","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"47e20b50-e1e2-4635-baae-d8bd8dcc179e","name":"Order indices were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a1591d74-b6e5-445b-ba7a-ea73ec7410cb","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"35faaa4f-7ca6-412b-8eae-69b1b6ff88d2","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f66d3ea8-4353-4e5c-bdd6-76c45cca88b2","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"306f5e2f-f556-4ce0-95dc-549cfa667b05"},{"name":"Gets a package's warnings","id":"2e95e56b-fb90-432a-8860-cb5796da100a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/warnings","description":"

Get package warnings

\n

Description

\n

This call retrieves all warnings there might be about a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/warnings \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose warnings you want to retrieve.String (GUID)
\n

Response parameters

\n

The response is a list of warnings.

\n

Warning schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","warnings"],"host":[""],"query":[],"variable":[{"id":"15ed1b74-578e-44d2-b2e3-5307d215d0e1","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"ff20a5d2-838a-4e1a-90f4-29734fd37fed","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n]"},{"id":"03f7882f-17f4-4755-803c-ca24b52e5cae","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6b6f6ade-6874-4775-9141-6b02dd938559","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2e95e56b-fb90-432a-8860-cb5796da100a"},{"name":"The actors in the current process step will be notified","id":"12d8a305-1ac8-4665-9ae9-b8d4cb04ab6f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/reminders","description":"

Send reminders

\n

Description

\n

The POST reminders call sends a reminder to the actors of the current process step.

\n

Company policy might require that a document is handled within a given timespan. Doing a POST reminders call looks up all actors within the current process step who haven't form filled/approved/signed their document and sends them an extra notification as a reminder.

\n

Note that only the next available form filler(s)/approver(s)/signer(s) in the workflow are notified. This means form fillers/approvers/signers waiting for someone else to form fill/approve/sign first in a serial workflow will not receive a notification. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/reminders \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must receive a reminderString (GUID)
\n

Response parameters

\n

Empty response body \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe reminders have been sent.
404 Not foundThe package with the given id could not be found.
409 ConflictThe package did not have status Pending.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","reminders"],"host":[""],"query":[],"variable":[{"id":"bd922185-fee9-4707-af03-c6e738c1e61b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"a4e8288d-4371-4582-b0e9-1d9f814a07f5","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c4ca64c4-3852-447d-8977-73de4452ac75","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"dc957646-c58b-445e-9e6c-9c315ca41147","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"0aaceda3-92ff-489d-8202-4c1cf4314bc7","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"12d8a305-1ac8-4665-9ae9-b8d4cb04ab6f"},{"name":"Approvers that are not finished yet will get the status Skipped","id":"b9b0539e-5d00-4737-8a31-78341b5e5d64","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipapprovers","description":"

API v4: Skip approvers

\n

A package that has been approved by at least one of multiple approvers can be sent to the signers by doing a Skip Approvers call. This call skips all approvers that haven’t approved yet and sets their status to “Skipped”, which results in the complete package being marked as “Pending”.

\n

This way, the package becomes available to the signers and it is no longer necessary to wait for all approvers to complete their task before anyone can sign.

\n

If the package was created with the SendNotifications parameter set to true, then all approvers will get a notification that the packages has been sent to the signers.

\n

Attention: when you skip approvers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipapprovers \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll approvers that hadn’t approved yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","skipapprovers"],"host":[""],"query":[],"variable":[{"id":"1dc92b55-8835-423a-86f4-3cad0ea6f58b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"f12624a3-f57f-4d44-b8d7-7e39da27a6d8","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bee7c422-9999-4301-a83d-d2eb5869ee2d","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e7d5dcf9-7a50-43d8-b40d-49aba5ba1df1","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"00fb8e6b-033c-4376-8375-36c5ddf1708b","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"b9b0539e-5d00-4737-8a31-78341b5e5d64"},{"name":"Signers that are not finished yet will get the status Skipped","id":"a680f084-ed9e-4c57-8d39-5acdc3fa8c70","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipsigners","description":"

API v4: Skip signers

\n

Description

\n

A package that has been signed by at least one party, but still has some unsigned fields, that must be signed by others can now be finished by doing a Skip Signers call. This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”.

\n

This way, the package becomes available for download and it is no longer necessary to wait for all parties to sign before everyone can download the document.

\n

If the package was created with the SendNotifications parameter set to true, then all signers will get a notification that they can download the ended package.

\n

Attention: when you skip signers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipsigners \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
packageIdUnique Identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll signers that hadn’t signed yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
409Package.NotSigned:{packageId}
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","skipsigners"],"host":[""],"query":[],"variable":[{"id":"d7f0297c-cbb8-47fc-b846-e5ba5da7d138","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"4c3f086e-6390-4d59-b015-6b96e4894831","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"43b39aef-e93a-4590-b446-de1162f60bab","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"57f817ba-6c78-4bff-b2a3-c281895a3946","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e47b38c4-9a5b-4ac7-93e0-549635c12ccf","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"a680f084-ed9e-4c57-8d39-5acdc3fa8c70"},{"name":"Creates template from given package","id":"3c3b9fdf-11b7-4206-aaae-bc0e68f4c2f8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/template","description":"

Create template

\n

Description

\n

This POST call saves a draft package as a template. Everything that defines the package, such as its documents and stakeholders, is saved as part of the template, enabling you to quickly create templates on the fly as part of an automated process through the API.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/template \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdThe unique identifier of the package that you want to save as a template.String (GUID)
\n

Request body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateNameThe name of the template, which must be unique in its document group.String (GUID)
\n

Response body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateCodeThe unique identifier created for the template.String (GUID)
\n

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","template"],"host":[""],"query":[],"variable":[{"id":"fcf0b93f-4921-4ba9-84d6-59d1d85e0a7f","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"475cc201-bdb4-4dac-aba0-6c54d6b26b26","name":"The template has been created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"TemplateCode\": \"\"\n}"},{"id":"5efbd5ae-6712-4102-9e31-d6405f16d65f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8e3401cb-db7d-4103-9ff5-80a9e4c5e4a0","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3c3b9fdf-11b7-4206-aaae-bc0e68f4c2f8"},{"name":"Used for downloading all documents in a certain package as a Zip file.","id":"3a800ba4-bdf5-4cbf-918b-24dd347cfb60","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/:packageId/download","description":"

Download package

\n

Description

\n

This call retrieves all documents of a specified package as a .zip file.

\n

Note that only finished and archived packages can be downloaded. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose documents you want to download as .zip file.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","download"],"host":[""],"query":[],"variable":[{"id":"996a5b35-9a0c-479e-b0d7-07f755ef65b0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"41c2b77a-461d-4b66-b398-9a9472c348d5","name":"The package's contents in a zip file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/zip"}],"cookie":[],"responseTime":null,"body":""},{"id":"227a7928-e0c1-4090-bdab-4eb73687d00d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9f4a228b-f415-415e-9b3c-4baa91e0860c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"6c24886b-95e2-4a8e-ae27-1dd4e60c7e23","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"3a800ba4-bdf5-4cbf-918b-24dd347cfb60"},{"name":"Get all Actors for the specified person EmailAddress","id":"d859e6d8-a7c7-4dbd-a061-66d9e8433383","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","description":"

API v4: Get actors for a user

\n

This call retrieves all actors for a specific user email address. 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/actors \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
emailAddress*The email address from the user you want to filter on.String
(email)
PageNumberThe page to retrieve. The default value is 0.Integer
PageSizeMaximum number of records in the response Default value is 20.Integer
CreatedBeforeGets only the actors created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the actors created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, and failed.		String (enum)
type

The type of actors you want to filter on. 

Values are: Signer, Receiver, Approver, FormFiller

String
(enum)
SortDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. The default value is 20.Integer
TotalTotal number of items.Integer
ItemsThe actors that are retrieved. See the child parameters of this parameter.array of
Objects
\n

Items

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActorIdUnique identifier of the actorString
(GUID)
StakeholderIdUnique identifier of the stakeholderString
(GUID)
StatusThe status of the actor.
Values: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped		String
(GUID)
PackageIdUnique identifier of the package the actor is part ofString
(GUID)
PackageNameThe name from the packageString
CreationDateReturns the date the actor was created. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, failed.		String (enum)
type

The type of the actor. 

Values are: Signer, Receiver, Approver, FormFiller.

String
(enum)
InitiatorThe email address of an initiator who created the package.String (email)
Documents

All the documents this actor is assigned to.

Child parameters:

- Id (String (GUID))
- Name (String)

Array of Objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","actors"],"host":[""],"query":[{"description":{"content":"

(Required) The email address of the person

\n","type":"text/plain"},"key":"emailAddress","value":""},{"description":{"content":"

The status of actors to retrieve

\n","type":"text/plain"},"key":"status","value":"Finished"},{"description":{"content":"

The type of actors to retrieve

\n","type":"text/plain"},"key":"type","value":"Approver"},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"632bfd38-d08f-4771-92da-acecce7ee0f3","name":"List of actors across packages for given person.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"InProgress\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Receiver\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Available\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n }\n]"},{"id":"435f3499-8865-4e04-9dee-d7e62fe7ee4d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"555c2d08-9eb7-4160-bcca-4f30526a1a15","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d859e6d8-a7c7-4dbd-a061-66d9e8433383"}],"id":"5b588f11-6525-4d5e-a667-8a8911369454","description":"

API v4: Packages

\n

What is a package?

\n

Packages lie at the core of eSignatures. A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

API calls for managing packages

\n

With API calls, you can do the following:

\n\n","_postman_id":"5b588f11-6525-4d5e-a667-8a8911369454","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Documents","item":[{"name":"Gets all documents of a package","id":"80f932a0-b0b0-47dc-ae0d-50d927d8aa92","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents?status=","description":"

API v4: Get documents

\n

Description

\n

This call retrieves all documents that currently exist within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/ \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose documents must be retrieved.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll documents are successfully retrieved.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""}],"variable":[{"id":"94cb399e-8902-4094-9f51-a56f2c456bfe","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"ce27e42e-b950-400b-b21d-3e92fb76459c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Ending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Pending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n]"},{"id":"a7177c93-2c3e-4217-854e-c071fdbd12de","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"80f932a0-b0b0-47dc-ae0d-50d927d8aa92"},{"name":"Adds a document to a package","id":"94f0a74c-ea92-4952-9730-dadb5d01c1c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n }, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=false","description":"

Add document to package synchronously

\n

Before you start | URL | HTTP method | MIME type | Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package. Once the status of a package is Draft, you can continue working on them. The asynchronous upload method offers extra parameters to keep existing signatures, form and signing fields. For more details, refer to API v4: Add document to package asynchronously.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n
 \n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
  • Parameters marked with an asterisk are required.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents \n 

\n

HTTP method

\n

POST \n 

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request parameters

\n

The parameters with an asterisk are mandatory.
​​​​​​​

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. See section 'PDF Error Handling' below for more info. Values:
-Ignore                    -DetectWarn
-DetectFail              -DetectFixWarn             -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. In the current version, an element can be a form field or signing field. The elements parameters are identical to those in the Create element call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail\n When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

​​​​​​​Before you start | URL | HTTP method ​​​​​​​| MIME type ​​​​​​​| Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"false"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"cdd595ef-50b3-4874-bbab-d58c63baa8d2","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"149b6698-e50e-4564-a14c-11ee3630fd2f","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"6d801f7f-94e2-466e-8354-88c6a3138ce9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"1e1a08fc-9085-4a88-8460-b74f605d7585","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fa700494-af35-47e5-bbdb-e9bf36f53d53","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"31ea0308-6d88-455c-a59e-07b69d858af1","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"94f0a74c-ea92-4952-9730-dadb5d01c1c2"},{"name":"Adds a document to a package asynchronously","id":"12cfae3a-ccb4-4932-a23d-384acb9f1c61","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n },\r\n \"KeepSignatures\": false, \r\n \"KeepSigningFields\": false,\r\n \"KeepFormFields\": false, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=true","description":"

API v4: Add document to package asynchronously

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package and, once the status of a package is Draft, you can continue working on it.

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents?async=true

\n

HTTP method

\n

POST

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request and query parameters

\n

Parameters marked with an asterisk are required.

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
async*To use the asynchronous upload method, you must set this parameter to true.String
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
KeepSignaturesThis parameter is available from version 7.4.0 onwards.

Determines whether to keep the existing signatures of the document. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.
Boolean
KeepSigningFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.		Boolean
KeepFormFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepFormFields is set to true, you cannot set KeepSignatures to true.
Boolean
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. For more details, see the section PDF error handling details.

Values:
-Ignore -DetectWarn
-DetectFail -DetectFixWarn -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n

This call doesn't return any response parameters. Use the Get package by ID call to see the status of your package. Once the status is Draft, you can continue working on the package. For more details, refer to API v4: Get package by ID.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request or due to conflicting actions.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.ConflictingActions
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail
    When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

Before you start | URL | HTTP method | MIME type | Request and query parameters | Response parameters ​​​| Response codes​​​​​​​ ​​​​​​​| Error codes ​​​​​​​| PDF error handling details​​​​​​​

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"true"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1aa9d8ab-d15b-40cd-96f2-6367610af1ce","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"1887544e-a80e-4ddd-8f2d-44a4da96861f","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"67dffb53-c7ef-4b4b-b645-f9bebf51d063","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"2060c692-06d0-4baf-95bc-232b4918e99d","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6bc89821-a4ef-4925-a852-4776ab319663","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"40100d6c-1db0-466a-bcca-c45e22a68864","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"12cfae3a-ccb4-4932-a23d-384acb9f1c61"},{"name":"Gets a document by id","id":"d591bf8c-5b82-4147-9d6e-83f0bde67a51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Get document by ID

\n

Description

\n

This call allows you to retrieve a document by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document you want to retrieve.String (GUID)
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
400 Bad requestRequest failed validation.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"057558b0-302f-4a07-acf8-c1744b001053","type":"any","value":"","key":"packageId"},{"id":"2f9be465-5903-43f3-a66d-ccb16d55248c","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"d8884183-f65e-4e1a-a259-052ea78c9786","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"98a21b45-4f3b-4df6-9b91-5f380d71dcf1","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e1120a29-695d-40b9-aa91-acc9d619c3be","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6374a580-71e4-40f0-9fb9-3efee6b9b58c","name":"Target package or document could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"d591bf8c-5b82-4147-9d6e-83f0bde67a51"},{"name":"Deletes a document by id","id":"c963b8af-5b70-40e7-93e2-4558a20110e1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Delete document by ID

\n

Description

\n

This call allows you to delete a specified document from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document that must be deleted.String (GUID)
PackageId*Unique identifier of the package to which the document belongsString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentDocument was successfully deleted.
404 Not foundTarget package or document could not be found.
409 ConflictDocument could not be deleted.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"e6e62e6d-47e9-4d14-b024-54ea79901a8a","type":"any","value":"","key":"packageId"},{"id":"4803c397-76bf-458f-9c05-57e502746d8b","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"88bc5487-7a48-4767-b90a-8d8c08c0dbff","name":"Document was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7c2cd588-360e-4c3e-89de-8328f16416a9","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"496aeb7c-083d-4bf7-bdcc-45c574d93c4c","name":"Target package or document with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"388f70e6-94fe-4c42-af1b-5209c9723f81","name":"Document could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c963b8af-5b70-40e7-93e2-4558a20110e1"},{"name":"Performs actions (keep/remove signatures, form fields, signing fields) on the not fully processed document.","id":"e41dc93e-b245-4e2d-a6a9-fd1686b359ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/actions","description":"

API v4: Perform actions on a not fully processed document

\n

Description

\n

Use this call to perform the following actions on a not fully processed document: keep and remove existing signatures, form and signing fields.

\n

For example, a document was uploaded via the Document Portal and it has existing signatures, form or signing fields. If you get the package containing this document by ID: \n 

\n
    \n
  • The IsActionNeeded parameter is set to true.
    • \n
  • Depending on the data that exists in the document, the following parameters are set to true: HasSigningFields, HasSignatures and HasFormFields.
    • \n
\n

You can use this API call to decide which data to keep so that the document is fully processed.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/actions \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package.String (GUID)
DocumentId*The unique identifier of the document.String (GUID)
\n

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
KeepSignaturesDetermines whether to keep the existing signatures of the document. The default value is false.Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.Boolean
KeepSigningFieldsIf it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.Boolean
KeepFormFields

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.

boolean
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No ContentDocument is put in Draft status
400 Bad requestBad request, Action could not be performed.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Document.ConflictingActions
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","actions"],"host":[""],"query":[],"variable":[{"id":"9a5bd2a9-d0ac-4031-bd76-cf0ef753fc29","type":"any","value":"","key":"packageId"},{"id":"4941f80f-6521-40f7-b814-3019d6f0dd3a","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"e9cf32c0-3335-4ac8-8c96-d90ea475f399","name":"Document is in Draft status, no action required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"15a35555-389f-485b-a938-27676fa426c9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d142dd97-5fd7-4388-8566-c179e843eb90","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"03b809c6-d4b2-4157-9f27-5d737f0bd721","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"832a3b97-6ade-4df8-98e4-44f57bd678dd","name":"Unable to perform actions on the document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e41dc93e-b245-4e2d-a6a9-fd1686b359ac"},{"name":"Download a signed document from a package.","id":"24e57a28-0aa0-4520-b102-b8483a0e5c03","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/download/:documentId","description":"

Download document

\n

Description

\n

This call downloads a specified document from a specified package as PDF or XML file.

\n

Note that you can only download documents from fully finished packages. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download/{documentId} \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package of which you want to download a document.String (GUID)
DocumentId*The unique identifier of the document you want to download.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document is successfully downloaded.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package /document could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"7820f9ba-4883-423d-91bd-1ec6bdad58e2","type":"any","value":"","key":"packageId"},{"id":"942d747e-f49e-4fb0-a55b-38e8fe5a15c9","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"54ca5a9b-1eef-497b-b7b1-b054588cc291","name":"The specified document in a pdf or xml file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"3938b0de-8118-4ad0-b324-992df04fa63a","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"37d532f0-9a6b-4c15-8b35-2277edcec4d8","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"7565a434-0988-4a80-ba39-fac1c87f5c6a","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"24e57a28-0aa0-4520-b102-b8483a0e5c03"},{"name":"Gets a document by its index within a package","id":"5e18d43c-2f56-44c8-bb40-801153fcc8b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:orderIndex","description":"

Get document by orderIndex

\n

Description

\n

This call allows you retrieve a document within a specified package based on its OrderIndex.

\n

The OrderIndex defines the order in which documents should be sorted within a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{orderIndex} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the target package.String (GUID)
OrderIndex*Order of the document within the package. Value must be positive.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":orderIndex"],"host":[""],"query":[],"variable":[{"id":"2299dc73-073b-41e3-8b82-acff55cf16d0","type":"any","value":"","key":"packageId"},{"id":"be9ca9b4-d441-43f7-be02-12f614449ffd","type":"any","value":"","key":"orderIndex"}]}},"response":[{"id":"dc4a1a80-856e-46e4-b3ac-eea7cf489a87","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"78f7268f-437e-443b-9053-be573fbf72e8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c2a216ff-035e-49dd-8544-83114be0c5af","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"5e18d43c-2f56-44c8-bb40-801153fcc8b8"}],"id":"6354708c-f03f-4476-9831-e50c4eb16608","description":"

API v4: Documents

\n

What is a document?

\n

A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder. Note that as of eSignatures 6.3, a document may also be marked as optional. In that case, the end user may choose not to sign it.

\n

A document may contain multiple elements. As of eSignatures 6.3, there are three types of elements: SigningField elements, CheckBoxField elements, TextBoxField elements and RadioGroup elements. \n 

\n

API calls for managing documents

\n\n","_postman_id":"6354708c-f03f-4476-9831-e50c4eb16608","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Elements","item":[{"name":"Gets the package elements editor url","id":"c17c0860-96f6-4de2-a75a-af130486f35e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","description":"

Get Package Elements Editor ActionUrl

\n

Description

\n

The GET element call retrieves a one-time ActionUrl that can be used by end-users to drag-n-drop (un)placed elements.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/elements/actionurl

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
RedirectUrlThe URL to call upon cancellation or confirmation.URL
LanguageThe Package Elements Editor language.String
IsIFrameShould the Package Elements Editor open in an IFrame.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlA one-time link that can be used by end-users to drag-n-drop (un)placed elements.URL
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe URL was created successfully.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","elements","actionurl"],"host":[""],"query":[{"description":{"content":"

Indicates whether the package elements editor opens in an iframe.

\n","type":"text/plain"},"key":"isIframe","value":""},{"description":{"content":"

The URL to call upon cancellation or confirmation.

\n","type":"text/plain"},"key":"redirectUrl","value":""},{"description":{"content":"

The package elements editor language.

\n","type":"text/plain"},"key":"language","value":""}],"variable":[{"id":"f89e4d8f-1c49-4b42-9872-29288d869ef8","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1d9a7ed0-8a8c-4b54-9c9c-d5ba4068a128","name":"The package elements editor url was created","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"a9b8973c-ab29-4e4a-8c88-b55c5184145e","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4eec44e9-472c-4b9d-aa3f-327abb054640","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4b6bf4fd-9d0c-4120-bba0-04526837ba30","name":"Target package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"2cb3d043-a771-4f35-b559-0434f736f675","name":"Unable to create action url","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c17c0860-96f6-4de2-a75a-af130486f35e"},{"name":"Gets a package's elements that are not placed yet","id":"c9516fe1-7e89-4459-bbb1-0beebfcd8b65","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements","description":"

Get unplaced elements

\n

Description

\n

This call retrieves all unplaced elements within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"30f475b3-a2a1-4cd8-beb3-2ce50ce9df7a","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"3dd8a43f-2ad1-43f6-930a-33eaa17e003c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"fa5e2f20-cd2d-47e0-96a1-a4206b1af360","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"61d26f13-3b82-4512-b08a-473ecbb117d0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c9516fe1-7e89-4459-bbb1-0beebfcd8b65"},{"name":"Creates unplaced elements for a package","id":"4d9d1a8c-a622-44dd-aa32-4f626fc8377a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/unplacedElements","description":"

Create unplaced element

\n

Description

\n

The POST element call adds an element to an existing package. This section covers the unplaced element parameters.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Extra parameters are needed depending on the type of unplaced element. More details can be found on the designated page, listed below.

\n\n

\n

Response parameters

\n

The response parameters depend on the element type, see the references above for details.

\n

Response codes

\n

The response codes depend on the element type, see the references above for details.

\n

Error codes

\n

The error codes depend on the element type, see the references above for details.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"331caa61-f053-4946-ab62-1a9191c257be","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"932e520d-35e3-4af4-aaf8-82dedc9b3b35","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"5adf22dd-4a22-4850-b6f6-f3c644387d22","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"9fdb8aab-7832-4f72-aaa0-43477c0cd77f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bde52e70-dd53-47b1-a8c0-38c03869256b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"0675795c-70ba-4b0a-8511-12f666ecbbee","name":"Unplaced elements could not be created for the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4d9d1a8c-a622-44dd-aa32-4f626fc8377a"},{"name":"Gets a package's unplaced element","id":"25b1b2bb-8267-412f-80a5-7de72bf6717e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Get unplaced elements by ID

\n

Description

\n

This call retrieves a specified unplaced element within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"d142081e-dc6a-4b34-a938-57d8ada8f7e7","type":"any","value":"","key":"packageId"},{"id":"a126ba19-66dc-4683-a291-d2ba6676007c","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"8176453a-578b-45ec-b108-367838b42f3e","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"d1375d18-b7e5-4b68-94e1-621d9d82d246","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e2248484-f92f-49f0-ac4e-e8d7d87fff55","name":"Target package or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"25b1b2bb-8267-412f-80a5-7de72bf6717e"},{"name":"Deletes a package's unplaced elements","id":"34e5e1e1-cae9-4f9e-8ec4-d6f880026bbd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Delete unplaced element by ID

\n

Description

\n

This call allows you to delete a specified unplaced element from a specified draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}//elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"6ecd33ce-9c27-4982-99bf-14e2b3a88e39","type":"any","value":"","key":"packageId"},{"id":"a523903a-8356-42f2-8c7e-371218df18af","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"ac1022c2-30c1-4815-9791-48420b467ff9","name":"UnplacedElement was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6be23917-8cbe-460f-bf82-44ea8b738e88","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8010dfa9-204f-46af-ad9b-9b5dbce49fda","name":"Target package or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"2c567ecc-6b5b-490e-9168-1087c157234a","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"34e5e1e1-cae9-4f9e-8ec4-d6f880026bbd"},{"name":"Gets the elements on a document","id":"1279cf0b-8455-4dd2-9e38-a5fe76cb177b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements","description":"

Get elements

\n

Description

\n

This call retrieves all elements within a specified document. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
DocumentId*Unique identifier of the document whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document id could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"0b800569-49b0-412c-b6f9-a7e7e7ba7362","type":"any","value":"","key":"packageId"},{"id":"3d52352b-f1d6-4652-8289-b740d39b8e4f","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"24bf0135-fd89-4878-a6cd-d58c2c374815","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"7688ab8f-e6b6-45ff-8c17-561e1bd0a1b0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b90d71a7-b802-477c-b852-9a870e350925","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"1279cf0b-8455-4dd2-9e38-a5fe76cb177b"},{"name":"Creates a new SigningField element on a document","id":"f3afd188-8fee-4923-8199-6b6c65146b2e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Type\": \"\",\r\n \"ExternalReference\": \"\",\r\n \"Location\": {\r\n \"Page\": \"\",\r\n \"Left\": \"\",\r\n \"Top\": \"\"\r\n },\r\n \"Dimensions\": {\r\n \"Width\": \"\",\r\n \"Height\": \"\"\r\n },\r\n \"signingMethods\": [\r\n {\r\n \"Name\": \"\",\r\n \"KeyPair\": \"\"\r\n },\r\n \"\"\r\n ],\r\n \"LegalNotice\": \"\"\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateSigningField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the SigningField element parameters.

\n

A SigningField element can be created in four different ways:

\n\n

Important: A single document must not contain more than 30 signing fields.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a SigningField element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case SigningField element.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SigningMethodsThe SigningMethods that may be used to sign this signing field. Note: When using a single SigningMethod, it must also be placed in an array.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

LegalNotice

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive.

\n

When defining a LegalNotice, you can choose from two LegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000.String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LegalNotice1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

Note: When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable. \n 

\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 70. Maximum value is 999999_._Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons, it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains the location and dimensions of the element. Pattern: #[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat DC for instance), and you want to convert those input fields into signing fields.

\n

Attention: For performance reasons, it's recommended to do this at document upload time. It may happen that after a document conversion the field with the given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Invisible Signing Fields

\n

When the SigningMethod parameter is set to server signing for all signers, it is possible to sign the document without adding a visible signing field. In this case, the PDF will be signed, and the signature can be checked but it will not be visible on the document.

\n

To leave the visible signing field out, the following parameters must be omitted:

\n
    \n
  • Location
    • \n
  • Dimensions
    • \n
  • FieldId
    • \n
  • Marker
    • \n
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
401Authentication failed, username or password incorrect
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409Element.FieldIdNotUnique
409Package.InvalidStatus
409Document.NotFoundInPackage
409SigningField.InvalidPage
409LegalNotice.NotFound
409SigningField.MarkerOrFieldIdNotFound
409SigningField.MultipleMarkersFound
409SigningField.MarkerAlreadySigned
409SigningField.InvalidWidthMarker
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"92bbac6c-92fb-4d4e-99a0-42d1b2f852ac","type":"any","value":"","key":"packageId"},{"id":"d6cd0d90-a1f6-4bd4-8c70-cf69d4086d11","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"12e79e22-235b-48d7-9b6d-7346688e2bf1","name":"New element was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created element","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"5538927a-a870-4146-a0ad-13a3e00fc6b3","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"b19b944e-d3c6-4d20-bf48-40c4c7c80fbc","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3deaf225-ca9b-4d45-87ed-f179e53c3bef","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"0026d6a7-14dd-4c33-a7b1-504bb8e569da","name":"element could not be added","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"f3afd188-8fee-4923-8199-6b6c65146b2e"},{"name":"Creates a new TextBoxField element on a document","id":"66a538d4-5ff1-4adc-9208-74823c023afe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"textBoxField\",\n \"Marker\": \"TXT01\",\n \"Name\": \"\",\n \"externalReference\": \"\",\n \"DefaultValue\": \"\",\n \"ToolTipLabel\": \"\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateTextBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the TextBoxField element parameters.

\n

A TextBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a TextBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a TextBoxField element.

\n

Important: The parameters Name, IsMultiline and CharLimit must only be used to create TextBoxField elements using element location and element dimensions. As of eSignatures 6.8.0, it is also possible to use these parameters when creating TextBoxField elements with markers. They must not be used when creating TextBoxField elements when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of TextBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case TextBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the TextFieldBox is mandatory or optional. When set to true, the text field is mandatory. The default value is false. Note: If you're sending a document that already contains a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDefault value prefilled in the TextBoxField. Note: If you're sending a document that already contains a prefilled form field and enter a DefaultValue parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the DefaultValue parameter must be null.String
IsMultiLineDetermines whether the TextBoxField has multiple lines. Default value is false. Wen set to true, the TextBoxField will be scrollable.Boolean
CharLimitDetermines the maximum number of characters that may be entered in the TextBoxField.Integer
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat Pro for instance), and when you want to show those input fields as textbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case TextBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the TextFieldBox is mandatory or optional.Boolean
DefaultValueDefault value prefilled in the TextBoxField.String
IsMultiLineWhether the TextBoxField has multiple lines.Boolean
CharLimitMaximum number of characters that may be entered in the TextBoxField.Integer
ValueValue of the completed TextBoxField.String
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n    \"type\": \"textBoxField\",\n    \"name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"100\",\n        \"top\": \"50\"\n    },\n    \"dimensions\": {\n        \"width\": \"150\",\n        \"height\": \"50\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"textboxfield\",\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"Value\": null,\n    \"Name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"Id\": \"54e6d471-17ad-44e0-9798-b27c04da13d4\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 50.0,\n        \"Left\": 100.0\n    },\n    \"Dimensions\": {\n        \"Width\": 150.0,\n        \"Height\": 50.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
400TextBoxField.InvalidCharLimit
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"9f81525a-ed7a-4188-9a88-50ca2ddcb009","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"bc3f5130-2a98-4fdb-8bb6-e17505581178","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4ce64c50-32c5-4528-834d-056f5eba5785","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"e7239720-ffe5-4ac3-b963-2d9156f49cab","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"652dc7fb-31f4-47a9-ad21-8db0432d7150","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"66a538d4-5ff1-4adc-9208-74823c023afe"},{"name":"Creates a new CheckBoxField element on a document","id":"77239a83-d181-4e2b-be0b-10881266bf45","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"checkBoxField\",\n \"Marker\": \"CHK01\",\n \"Name\": \"Checkbox1\",\n \"Type\": \"checkboxfield\",\n \"DefaultValue\": false,\n \"ToolTipLabel\": \"Check Me\",\n \"externalReference\": \"Checkbox1\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateCheckBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the CheckBoxField element parameters.

\n

A CheckBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a CheckBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a CheckBoxField element.

\n

Important: The Name parameter must only be used to create CheckBoxField elements using element location and element dimensions. It must not be used when creating CheckBoxField elements using markers, or when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of CheckBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case CheckBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the checkbox is mandatory or optional. When set to true, the checkbox is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDetermines whether the checkbox is checked or unchecked by default. When set to true, the checkbox is checked. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the DefaultValue parameter is set to false. Otherwise the original value will be overwritten.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used documents that already contain input fields (created in Adobe Acrobat Pro for instance), and you want to show those input fields as checkbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case CheckBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the checkbox is mandatory or optional.Boolean
DefaultValueWhether the checkbox is by default checked or unchecked.Boolean
CheckedThe value of the completed checkbox field.Boolean
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
 {\n    \"type\": \"checkBoxField\",\n    \"name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"DefaultValue\": false,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"300\",\n        \"top\": \"230\"\n    },\n    \"dimensions\": {\n        \"width\": \"12\",\n        \"height\": \"12\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"checkboxfield\",\n    \"DefaultValue\": false,\n    \"Checked\": false,\n    \"Name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"Id\": \"c4577ad0-fcca-43b3-bb39-465c6e0a27f5\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 230.0,\n        \"Left\": 300.0\n    },\n    \"Dimensions\": {\n        \"Width\": 12.0,\n        \"Height\": 12.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"94951d95-2121-4283-869a-b433661d054b","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"c4e0d6be-b8de-41ff-8dfd-0e1822aa1114","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"44a704e2-aaab-49b3-8f77-702a22c5ea05","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"fc77f0ee-9d81-4ec8-a835-d1907223ad1a","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"9918a28a-4e8a-4e81-9abf-75ff17b3fcde","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"77239a83-d181-4e2b-be0b-10881266bf45"},{"name":"Creates a new RadioGroup element on a document","id":"7e5bbc7f-11a0-42ae-b058-f96801060463","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"RadioGroup\",\n \"name\": \"\",\n \"Label\": \"\",\n \"Options\": [\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 233.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 293.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 263.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n }\n ],\n \"ToolTipLabel\": \"\",\n \"IsRequired\": true,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

Create RadioGroup element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the RadioGroup element parameters. A RadioGroup may contain multiple RadioGroup buttons.

\n

A RadioGroup element can be created in different ways: either the RadioGroup was already added to the document(s) you're sending, via an application such as Adobe Pro DC, or you create it using the eSignatures API.

\n

If the RadioGroup already exists, you must use the FieldId parameter

\n

If the RadioGroup is to be created through API, you need to add RadioGroupOptions to the RadioGroup. A RadioGroupOption represents a single radio button within a RadioGroup. RadioGroupOptions can be created by using specific dimensions and a specific location.

\n

Note that the different ways of creating a RadioGroup element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a RadioGroup element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case RadioGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document. Important: The Name parameter must not be used when specifying an existing RadioGroup (created in Adobe Pro DC for instance) by means of the FieldId parameter.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the RadioGroup is mandatory or optional. When set to true, the RadioGroup is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
\n

CreateRadioOption

\n

A RadioOption represents a single radio button within a RadioGroup.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name/choice of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedDetermines whether the radio button is selected by default.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

RadioGroup with field identifier

\n

The FieldId parameter must only be used if the documents you're sending already contain radio buttons (created in Adobe Pro DC for instance), and you want those radio buttons to be kept.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
Type*Type of element that was created. In this case RadioGroup.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the RadioGroup is mandatory or optional.Boolean
SelectedThe name of the selected RadioOption.String
OptionsThe RadioOptions (i.e. the different radio buttons within the group)Object
\n

RadioOption

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedWhether the radio button is selected.Boolean
LocationLocation of the radio button within the document.Object
DimensionsDimensions of the radio button.Object
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n\"type\": \"RadioGroup\",\n\"name\": \"Radio group\",\n\"Options\": [\n    {\n        \"Name\": \"one\",\n        \"ToolTipLabel\": \"RadioGroup one tooltip\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"ToolTipLabel\": \"RadioGroup two tooltip\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"three\",\n        \"ToolTipLabel\": \"RadioGroup three tooltip\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"documentIndex\": 0\n},\n\n

Example response

\n
{\n\"Type\": \"radiogroup\",\n\"Selected\": \"one\",\n\"Options\": [\n    {\n        \"Name\": \"three\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"one\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": true,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"Name\": \"Radio group\",\n\"Label\": null,\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"Id\": \"035aec8f-a559-43ce-8fd7-f91ddd51f68f\",\n\"ActorId\": \"87fad4ea-d39d-435b-94fe-48072fd5a15f\",\n\"Location\": null,\n\"Dimensions\": null,\n\"Status\": \"Pending\",\n\"ExternalReference\": null,\n\"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"9fbecc40-94f2-4622-98e3-b26128878dc8","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"1243b657-f8ed-49f2-b7be-104c961bdb22","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4cde9a97-6ea9-4dfb-918e-b2962252f445","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"217645ca-6699-43cc-b77c-4f0cac193266","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"da5474e6-6492-45af-bdfd-73929796c3e2","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"7e5bbc7f-11a0-42ae-b058-f96801060463"},{"name":"Gets an element by id","id":"5d363ddd-2e89-4040-8753-aaee867cbbd2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Get element by ID

\n

Description

\n

This call allows you to retrieve an element by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKElement is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"892f2dec-a2c6-404f-8e07-bedcecca5d0e","type":"any","value":"","key":"packageId"},{"id":"19849e73-2ad6-4a8f-9364-0542ebb432f5","type":"any","value":"","key":"documentId"},{"id":"3e48cc9b-4261-493a-9394-ad4eb052683e","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"6584eb54-1d53-4882-8c6a-5d9fad7e009f","name":"elements was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"823a6a2b-7d05-4116-90e7-f373ce491e70","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f7156a26-adb7-4bf5-8b49-e7c1296638a4","name":"Target package, document or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"5d363ddd-2e89-4040-8753-aaee867cbbd2"},{"name":"Deletes an element by id","id":"9d4c7d40-fc0d-428f-bbae-9664252bbeb3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Delete element by ID

\n

Description

\n

This call allows you to delete a specified element from a specified document of a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"593ceb83-3519-4e4a-b7f9-914ad1edb19d","type":"any","value":"","key":"packageId"},{"id":"d2102585-26e7-4146-a463-6222d717291e","type":"any","value":"","key":"documentId"},{"id":"9caaad5c-cfbd-4b3b-94fc-455cff5ee126","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"94970147-3865-49dd-a87d-98b41fa63ff8","name":"Element was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"425c8af5-36a4-4987-88e2-126cd819f543","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7e16bf40-2cd5-499f-97b6-f40050f6a9f3","name":"Target package, document or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"8ced50ec-ba9b-4c6b-b558-616cf7115034","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"9d4c7d40-fc0d-428f-bbae-9664252bbeb3"}],"id":"c85f6b6e-b3b3-49ed-937e-659ec1e0c9d9","description":"

Elements

\n

The Elements collection contains all resources and methods for creating and managing elements. \n 

\n

What is an element?

\n

An element is an item that is placed on a document and may be assigned to an actor.

\n

An element cannot exist on its own, it is always part of a document.

\n

Currently, four types of elements can be added to a document:

\n
    \n
  • SigningField elements
    • \n
  • TextBoxField elements
    • \n
  • CheckBoxField elements
    • \n
  • RadioGroup elements
    • \n
\n
 \n

SigningField elements determine where on the document a signature must be placed. SigningFields are always mandatory. \n 

\n

TextBoxField elements determine where on the document a textbox field will be placed. A textbox may contain a default, prefilled value, which can be modified afterwards by the end user. A textbox may be mandatory or optional. \n 

\n

CheckBoxField elements determine where on the document a checkbox field will be placed. A checkbox may be already checked by default, but can still be modified by the end user. Like textboxes, checkboxes may also be mandatory or optional. \n 

\n

RadioGroup elements determine where on the document a radio group will be placed. A radio button may be already checked by default, but can still be modified by the end user. Radio groups may also be mandatory or optional. \n 

\n

Element methods

\n\n","_postman_id":"c85f6b6e-b3b3-49ed-937e-659ec1e0c9d9","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Stakeholders","item":[{"name":"Gets all stakeholders of a package","id":"5c796372-c1d3-4e22-ac0d-6aad9e1a7d86","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders","description":"

Get stakeholders

\n

Description

\n

This call retrieves all stakeholders that currently exist within a specified package.

\n

The results are ordered by date on which the stakeholders were added to the package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

GET \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose stakeholders you want to retrieve.String (GUID)
\n

\n

Response parameters

\n

The response parameters are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll stakeholders are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"ff8d146c-7a9d-4c11-9429-7e220dd358e0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"f6f85d9e-9703-4a21-87b4-f78d5749a728","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n]"},{"id":"d7073103-c5ab-436d-85d9-dcb277cda8ef","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7e3745d3-68a8-49af-9f7b-b85de7514ff9","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"5c796372-c1d3-4e22-ac0d-6aad9e1a7d86"},{"name":"Adds a stakeholder to a package","id":"fa696b10-ad37-4927-9ebe-5cf6cca4e4d6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"person\",\n \"Language\": \"en\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"BirthDate\": \"\",\n \"PhoneNumber\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders","description":"

Create stakeholder

\n

Description

\n

The POST stakeholders call creates a stakeholder and adds it to a specified package.

\n

A stakeholder is an entity that has an interest in a package.

\n

Three types of stakeholders can be created:

\n
    \n
  • a person stakeholder
    • \n
  • a group stakeholder
    • \n
  • a contactGroup stakeholder
    • \n
\n

A person stakeholder is a single person. Only that person will be able to take action on the package.

\n

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. Each person of the group will receive a unique URL to form fill/approve/sign their document.
Attention: as soon as one member of the group has taken action, the others no longer can.

\n

A contactGroup stakeholder can be used when a contact group has been created in the eSignatures WebPortal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the WebPortal instead of defining each member in the call.
Note: the stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder will be added.string (GUID)
\n

Request parameters

\n

Actor parameters

\n

The Actor parameters are identical to those of the Create actor call and are described here. \n 

\n

Create Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created. Supported values: person, group and contactGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
Language*UI language of this stakeholder, expressed in a 2 letter ISO 639-1 code. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastName*Last name of the stakeholder Maximum length: 150String
EmailAddress*Email addressString (email)
BirthDate*Date of birth in format: YYYY-MM-DD Note: activating mandated signer validation in the Config Index might make this parameter required.String (date)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
\n

Create Group stakeholder

\n

Note that iDIN signing currently doesn't support Group stakeholders.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupName*Name of the group Maximum length: 128String
Members*Members that must be added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCode*Code that was generated when creating a contact group in the eSignatures WebPortal.String
\n

Response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe stakeholder was created successfully.
400 Bad requestRequest validation failed. The stakeholder could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictStakeholder could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"eaf858a3-57cc-4d86-8cbf-396411d35f51","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"52779ccb-84f0-4799-9aef-3da0cc059694","name":"Stakeholder was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created stakeholder","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"af7ae259-b9d6-42cd-ab3b-a2f8671deecf","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"74fda2c2-f061-4873-a85f-c7db036c3a44","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e9ca4b8d-2e0c-49fe-8e54-72400d5724db","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"3fc27814-798b-4c15-9b4e-774fd4127e82","name":"Stakeholder could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"fa696b10-ad37-4927-9ebe-5cf6cca4e4d6"},{"name":"Gets a stakeholder by id","id":"e4629bae-645f-4b65-8b32-0fe5910908d9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Get stakeholder by ID

\n

Description

\n

This call allows you to retrieve a stakeholder by its ID.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to retrieve.String (GUID)
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

GET \n 

\n

Response parameters

\n

The response parameter are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStakeholder is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b081d3a4-c04b-411a-9f64-37b846ddd6ef","type":"any","value":"","key":"packageId"},{"id":"8ac7398f-4211-4038-9d58-38b26c2b3cb8","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"a338d6a0-82cb-45ad-8733-83603bdc3d03","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"2705819a-e932-4b18-a2d7-0ed3b20d021c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9277e3e8-a328-4fc8-bc48-359346446760","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"e4629bae-645f-4b65-8b32-0fe5910908d9"},{"name":"Deletes a stakeholder by id","id":"3f8b8e3a-aa05-4dbf-9717-4412d1af0946","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Delete stakeholder by ID

\n

Description

\n

This call allows you to delete a specified stakeholder from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentStakeholder was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
409 ConflictStakeholder could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
409Stakeholder.CannotRemoveUndecided
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b725df35-5d70-4cb1-9d4a-86f72a30070d","type":"any","value":"","key":"packageId"},{"id":"16c34cea-4070-41fe-8e71-4658f664a4fa","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"e1761cd7-80ab-41d9-addb-4a6916656923","name":"stakeholder was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bc2a2d5f-1fb1-471c-b7bf-0e50ac37878c","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0c3a87e0-0ccc-4226-9175-06fe8e908023","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"4383d273-530c-47ef-9802-7f9587f5841b","name":"Stakeholder could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3f8b8e3a-aa05-4dbf-9717-4412d1af0946"}],"id":"77019d1a-aca4-473b-a538-4f644fb8e7fc","description":"

Stakeholders

\n

The Stakeholders collection contains all resources and methods for creating and managing stakeholders. \n 

\n

What is a stakeholder?

\n

A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must take. For instance, fill out forms, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. \n 

\n

Stakeholder methods

\n\n","_postman_id":"77019d1a-aca4-473b-a538-4f644fb8e7fc","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Actors","item":[{"name":"Gets a stakeholder's actors","id":"875a29f1-eedc-4594-ae75-8afead0243f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Get actors

\n

Description

\n

This call retrieves all actors of a specified stakeholder. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors \n 

\n

HTTP method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors you want to retrieve.String (GUID)
StakeholderId*Unique identifier of the stakeholder whose actors you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actors are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"80c7390c-5530-4da3-ab49-53106f15161f","type":"any","value":"","key":"packageId"},{"id":"a62e66cd-4252-46c0-8c62-b70ecbf46417","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"d90a5a91-bb25-411f-b4f2-0e2d8423b38c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"b38b7638-9059-4b3e-8559-fa765afcce81","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8bfcfb2b-e02b-4556-a309-8e5177e1f779","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"875a29f1-eedc-4594-ae75-8afead0243f4"},{"name":"Creates an actor for a stakeholder","id":"d20e7962-b4d2-477f-b636-193916a8017d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Create actor

\n

Description

\n

The POST actors call creates an actor and adds it to the stakeholder you specify.

\n

An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are:

\n
    \n

  • FormFiller (as of eSignatures 6.3)
    A FormFiller must fill in TextBoxFields, CheckBoxFields and/or RadioGroups on a document. FormFiller actors do not sign or approve documents.

    \n
    • \n

  • Approver
    An Approver must approve the document before it is sent to any signer.
    Note that the approval may occur before or after the filling of forms.

    \n
    • \n

  • Signer
    A Signer must sign the document.

    \n
    • \n

  • Receiver
    A Receiver receives a a copy of the document when it has been signed by all signers. A Receiver does not take action on the document.

    \n
    • \n
\n

Important:

\n
    \n

  • All FormFillers/Approvers must be added to the first step of the process. This is because they must first take action on a package before it is sent to any signers. All receivers must be added to the last step of the process, since a package is only sent to receivers once it has been signed by all signers.

    \n
    • \n

  • If you do not define the process steps manually, all FormFiller actors are also added to the first step, together with the Approvers. As a result, the approval action may happen before, during or after the filling of forms.

    \n
    • \n
\n

Attention: All other process steps may only contain one type of actor. It's not supported to mix actor types, with the exception of FormFillers and Approvers, within an array.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor must be added.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor must be added.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. TextBoxField, CheckBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. Currently, four element types are supported: SigningField, TextBoxField, CheckBoxField and RadioGroup. This parameter does not apply to Receivers, since this actor type does not take action on documents. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action.
See the RedirectUrl Details section below for more information.		String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
CompletedDateDate when the action was completed.String (date-time)
SigningMethodSigning method the actor used to sign the document. This parameter only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was created
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or stakeholder could not be found
409 ConflictActor could not be added to the stakeholder
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400Actor.TypeCantHaveFormFields
400Actor.InvalidOrder
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. PackageId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592<;

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"a04ef99b-37ce-437b-af82-23306c060898","type":"any","value":"","key":"packageId"},{"id":"a5bb2a38-4009-4a83-b776-0499ca4cf998","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"5ad25568-0fa2-438e-8534-0b9a4b09cb17","name":"Actor was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"7b26de56-a2d3-49e5-9290-3d5c4d62d3e4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"5bc68ef9-5ead-4fcb-b492-82b15e9885be","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a978923f-b429-494e-ae8e-0ad35fd96b85","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"31398b5c-7eb7-4f21-9433-b8f9b4ecd98c","name":"Actor could not be added to the stakeholder","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d20e7962-b4d2-477f-b636-193916a8017d"},{"name":"Gets an actor by id","id":"c46b6d45-2216-4443-890b-593b7cabd4d4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Get actor by ID

\n

Description

\n

This call allows you to retrieve an actor by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to retrieve.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKActor is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
404Actor.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"410162f5-7175-495d-9371-a602ba1c0d79","type":"any","value":"","key":"packageId"},{"id":"b7ede867-a3cc-4e33-8b2a-7e71927b9ce4","type":"any","value":"","key":"stakeholderId"},{"id":"56c018c4-bb52-4abc-9e66-66bfbfe4c88f","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"ade01464-32db-4db2-b4a4-2c8128aa3d74","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"a8038cf1-f7b6-44e2-98f0-d06b8306afd1","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b5a082a5-706e-4357-8385-1a3dde63e108","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"c46b6d45-2216-4443-890b-593b7cabd4d4"},{"name":"Deletes an actor by id","id":"b03b30a5-0423-4101-a249-7f14c1d6dc94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Delete actor by ID

\n

Description

\n

This call allows you to delete a specified actor from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentActor was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
409 ConflictActor could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
404Actor.NotFound
409Actor.CannotRemoveUndecided
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"02c1160f-3597-4ce5-9267-8dfc254341b4","type":"any","value":"","key":"packageId"},{"id":"b41a3677-e93c-4815-bdb4-216756910dd6","type":"any","value":"","key":"stakeholderId"},{"id":"a5f66176-39cc-46cc-9a02-c8232126a69d","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"86718d7b-7161-411f-bc82-e82fe1146763","name":"Actor was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8ec0f50a-7e0e-4a3d-b2ce-26dd9ca4089f","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bf193ea8-8391-4935-9d10-6a2d5302831e","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"d077a28f-b795-406f-872d-cec54dd68d89","name":"Actor could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"b03b30a5-0423-4101-a249-7f14c1d6dc94"},{"name":"Actors Reassign Actor","id":"ba26e4be-08af-48e9-8291-aca11379571f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","description":"

Reassign actor

\n

Description

\n

The POST reassign actor call reassigns an actor from the package towards a new actor .

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId}/reassign

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
actorId*Unique identifier of the actor which needs to be reassinged.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of AdditionalProperties. AdditionalProperties is only needed when reassigning a signing actor that has mandated signing and needs extra data therefore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Stakeholder*The stakeholder the actor needs to be reassigned too.Object
Type*Type of stakeholder that must be created. When reassigning the only supported value is personString
(enum)
FirstName*First name of the stakeholder, Maximum length: 150String
LastName*Last name of the stakeholder, Maximum length: 150String
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length 256.String
EmailAddress*Email address.String (email)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
ReassignmentReason*The reason behind this reassignmentString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was reassigned
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package, stakeholder or actor could not be found
409 ConflictActor could not be reassigned
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
409MandatedSigner.MissingRequiredProperty
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"host":[""],"query":[],"variable":[{"id":"b382298f-c060-4c46-ba62-9aa90bcdb0c7","type":"any","value":"","key":"packageId"},{"id":"8500e907-53dc-427e-abfd-04a3dbfaff78","type":"any","value":"","key":"stakeholderId"},{"id":"8c0cff7a-df85-4423-a7b1-d70934e61d62","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"5ec0eee3-7f41-4fa9-b250-5c2efd386b89","name":"Actor was reassigned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Person\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"}],"_postman_id":"ba26e4be-08af-48e9-8291-aca11379571f"}],"id":"08d0d353-d555-424d-856a-ef4d19ce6f6d","description":"

Actors

\n

The Actors collection contains all resources and methods for creating and managing actors.

\n

What is an actor?

\n

An actor is a single action a stakeholder needs to take on a package.

\n

There are four types of actors: form fillers, approvers, signers and receivers.

\n

Actor methods

\n\n","_postman_id":"08d0d353-d555-424d-856a-ef4d19ce6f6d","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Process","item":[{"name":"All process steps","id":"d5778bd0-eb33-4f98-96d1-5ea793caed54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process","description":"

Get all process steps

\n

Description

\n

This call retrieves all actions that must be done on a specified package.

\n

The actions are displayed in a 2D array where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process steps you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"494c8e84-52c8-4683-9b6d-ceb2af2ad93b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7219f94a-a87d-4b3c-8bfa-f91b539c4ac7","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ]\n]"},{"id":"e8faf619-d223-4128-a0ab-32d27b979057","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ad1be9c8-b15b-41a7-9974-99ace5b1fb09","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d5778bd0-eb33-4f98-96d1-5ea793caed54"},{"name":"Adds a step in the package's process","id":"e35f61e4-caf2-4a21-8834-613361e40f16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Add process step

\n

Description

\n

This call adds a process step to a package's process. A process step consists of an array of actors.

\n

Please note: It's not supported to mix different actor types, with the exception of FormFillers and Approvers, within the same process step.

\n

The approval and form filling flow(s) need to proceed the signing flow. This limitation is in place since adding approval and/or form filling data to the source file is regarded as making changes to the source file. Adding approval and/or form filling data after signatures are placed will consequently render the electronic signature invalid.

\n

After the approval and form filling flow, all signing flows (sequential, parallel, mixed) need to be completed before the final (receiver) step.

\n

The receiver flow is always parallel.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process

\n

HTTP method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderId*Unique identifier of the stakeholder.String (GUID)
\n

The Request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. CheckBoxField, TextBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. See the RedirectUrl section below for more details.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderIdThe stakeholder's unique identifier.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: approver, formfiller signer and receiver.String (enum)
StatusStatus of an action. Available statuses are: draft, waiting, available, inProgress, failed, finished, rejected, kipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor will is linked. This parameter only applies to signers and formfillers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to receivers.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service.String
CompletedDateDate when the action was completed.String (date-time)
IdentityIdentity date returned when signer used eID or OpenID Connect to sign.TBD
SigningMethodSigning method the actor used to sign the document. Only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.Array of objects
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedProcess step was successfully created.
401 UnauthorizedCaller is unauthorized to do this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. ActorId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED,* REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c51a20ff-39d3-4266-b303-b30b258f31a7","name":"Process step was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created process step","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"440b6780-f1ed-4e8c-9f39-2450428fc950","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3b6abf04-e5fa-4fde-b9f7-39e622ab4a0a","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e35f61e4-caf2-4a21-8834-613361e40f16"},{"name":"Overwrites process steps of a package","id":"0d0e4271-0488-4ead-8ee0-a70c13d38d4c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Approver\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Update process steps

\n

Description

\n

This call overwrites all actors in a package using a 2D array, where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

HTTP method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must be updated.String (GUID)
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess steps were updated successfully.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"8cb6a632-0eb4-4604-986c-692e96418687","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"ce9f8865-a787-4501-9aa3-f51fd4b2f6f9","name":"Process steps were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b75b588a-de43-41a7-88f2-a17d001bf174","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8860e8bb-7a7c-4cc6-8178-088b6b9a0f02","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"0d0e4271-0488-4ead-8ee0-a70c13d38d4c"},{"name":"Gets all actions of a process step","id":"a1c4cab7-107b-4f42-a680-fd53a5c33b94","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Get process step actions

\n

Description

\n

This call gets a particular set of actions that can be completed in parallel from any specific process step

\n

The process step of which the actions must be retrieved is specified by the StepIndex parameter. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
StepIndex*Index of the process step that must be retrieved.Integer
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"38817477-c2d7-4caa-a767-edf3f3362c37","type":"any","value":"","key":"packageId"},{"id":"2c62af68-b0c6-4dca-81c2-8a5bba117de5","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"1023546c-60c6-4903-b480-eebd9168de18","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"a7dcb5d0-849c-4340-b8d8-f82ab97d7d23","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3cfa9c26-249a-44ed-8bbe-78160d50595a","name":"package or process step could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"a1c4cab7-107b-4f42-a680-fd53a5c33b94"},{"name":"Deletes a process step and all its actors","id":"8552a6f7-4301-410f-8525-a4f74b89ebd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Delete process step and its actions

\n

This call allows you to delete a process step and its actions from a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process step must be deleted.String (GUID)
StepIndex*Index of the process step that must be deleted.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess step was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or process step could not be found.
409 ConflictProcess step could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Actor.NotFound
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"69e99bbe-c957-4f95-8a5e-fd1f3c333762","type":"any","value":"","key":"packageId"},{"id":"ddf8c92e-0471-41ab-84ab-08154e81498e","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"127ff0bf-d199-4e92-9265-babb5323f54f","name":"Process step was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b16aa67c-d696-4747-a2de-6a45f557b61f","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8d40ee88-ee23-455e-a670-44e98875bca5","name":"package or process step could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"9c7b19a2-c1c1-48af-a743-7b204d0520d6","name":"Process step could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"8552a6f7-4301-410f-8525-a4f74b89ebd0"},{"name":"Adds an actor to a process step","id":"14a7a368-ef6e-40bd-a123-0fbcfe944b6c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process/:stepIndex","description":"

Add process step action

\n

Description

\n

This call adds an actor to a process step, by means of StepIndex. The StepIndex indicates at which step of the process the action must be done. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
StepIndex*Step at which the action must be done.Integer
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response parameters

\n

The response parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedActor was successfully added to the process step
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or process step could not be found
409 ConflictActor could not be added to the process step
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
400Actor.InvalidOrder
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
404FormField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"bbffb313-54b1-4fac-9424-3d8a041e8372","type":"any","value":"","key":"packageId"},{"id":"4359cfc6-4a75-470c-9f3d-3599f4da1358","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"eb578a98-16d5-48b3-8796-92e067cf7836","name":"Actor was added to the process step. The location header points to the location of the created actor under its stakeholder.\n","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor (under its stakeholder)","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"770a0ac6-c92d-4df1-9a1c-baf83378aeaa","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4147c4f3-c81d-4e4a-8094-b3f52fb44581","name":"package or process step could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"ee56ce05-8afc-4326-8027-c623768c395d","name":"Actor could not be added to the process step","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"14a7a368-ef6e-40bd-a123-0fbcfe944b6c"},{"name":"Gets all actions the current process step","id":"6be28d8d-c306-4355-a055-4de4cb75b74d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/current","description":"

Get process step actions of current process step

\n

Description

\n

This call gets all actions that can be completed in parallel of the current process step, i.e. the process step that is currently in progress.

\n

In the example below, you'll see that the actions of the signing step are retrieved. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4//packages/{packageId}/process/current \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actions of the current process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process","current"],"host":[""],"query":[],"variable":[{"id":"b0f57706-a3a1-4b37-8e31-155455e643e5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"d2f50e88-4aa1-4088-bf8c-9d1a71f33704","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"70098251-344e-435d-b108-6f85a590e6fa","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a41dc675-337c-4f62-b35c-ada45a2146e4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"6be28d8d-c306-4355-a055-4de4cb75b74d"}],"id":"61762969-022e-45e3-b954-3036b42696fd","description":"

Process

\n

The Process collection contains all resources and methods to set up a package's form filling/approval/signing process. Its allows you to set up parallel, sequential and complex signing flows. \n 

\n

How does a process work?

\n

A package's process defines which stakeholder will do their action at which moment in time.

\n

A process may consist of multiple process steps. A process step is a set of actions that may be done in parallel. For instance, approve in process step 1, fill out forms in step 2, sign in step 3 and receive in step 4. The approval step may occur before or after the filling of forms, as long as they are both prior to signing. Receivers must be placed in the last step, since they receive the signed documents after the signers have completed their tasks. \n 

\n

Process methods

\n\n","_postman_id":"61762969-022e-45e3-b954-3036b42696fd","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"SigningMethods","item":[{"name":"Returns all signing methods that are currently configured","id":"9e371609-1738-4f3a-ae20-577dc5c720c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/signingmethods?isActive=","description":"

Get signing methods

\n

Description

\n

This call retrieves all signing methods that are currently enabled or disabled in the eSignatures Configuration Index and are thus available to the users.

\n

This call is useful for integrators who need to know which methods are currently enabled in a given eSignatures installation, otherwise that list of signing methods would need to be duplicated in the integrator’s configuration database as well.

\n

Note that this API v4 call retrieves both the SigningTypes that are configured in the deprecated Signing Options settings group, and the SigningMethods and the Signing Behavior they belong to, configured in the new Signing Options settings group. The new SigningMethods are formatted as follows: SigningBehavior:SigningMethod. E.g. SmartCard:BeID.

\n

Note that as of eSignatures 6.5.0, a new Signing Behavior has been introduced: RemoteHashSigning. This Signing Behavior currently encompasses two supported SigningMethods: itsme and Swisscom. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/signingmethods \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveDetermines whether the call must retrieve all active or inactive SigningMethods.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveWhether the SigningMethod can be used to create new signing fields.Boolean
NameThe name of the SigningMethod as configured in the Configuration Index.String
DisplayNamesThe names of the SigningMethod in the different languages as they will be shown to a signer in WYSIWYS.Array or objects
DisplayNamesInitiatorThe names of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
DescriptionsThe descriptions of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
RequiredPropertiesThe properties that are required to be passed in the Create stakeholders call. When RequiredProperties are returned for a SigningMethod, it means mandated signing rules have been applied to that SigningMethod. To check whether a signer is mandated to sign during a particular signing session, eSignatures compares the data passed in the RequiredProperties to the external data retrieved from the signing certificate or returned by the signing service.Array or objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe SigningMethods list is successfully returned.
401 UnauthorizedCaller is unauthorized to do this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["signingmethods"],"host":[""],"query":[{"description":{"content":"

only return active / inactive signing methods

\n","type":"text/plain"},"key":"isActive","value":""}],"variable":[]}},"response":[{"id":"3fec61a6-858d-4bf6-ab6a-48a74b5a9622","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"consequat_958\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"dolore6\": \"\"\n },\n \"Descriptions\": {\n \"anima38\": \"\",\n \"pariatur_f\": \"\",\n \"ea_2b\": \"\",\n \"exercitation0f\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"do_e8\": \"\",\n \"irured\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"esse_33\": \"\",\n \"ullamco_d\": \"\",\n \"proident_82d\": \"\"\n }\n }\n ]\n },\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"est96\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"nostrud87\": \"\"\n },\n \"Descriptions\": {\n \"laboris9c6\": \"\",\n \"irure18f\": \"\",\n \"id_7\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"incididunt_d\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"aliquip_dd\": \"\",\n \"aliquip_5\": \"\",\n \"magna4\": \"\"\n }\n }\n ]\n }\n]"},{"id":"b76f3e68-e412-46d2-ab6a-ca6e23be25dd","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9e371609-1738-4f3a-ae20-577dc5c720c2"}],"id":"0f8e8e86-4ee6-4ced-b521-3fae82b3df71","description":"

The signing methods that are configured in eSignatures

\n","_postman_id":"0f8e8e86-4ee6-4ced-b521-3fae82b3df71","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"AuditProofs","item":[{"name":"This call allows API users to add extra proofs from an external source to a location on a document.","id":"0b3fa864-824a-4944-95f7-c153815f8d83","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": \"\",\n \"Name\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/auditproof/proofs","description":"

Add Proof from External Source

\n

Description

\n

This call allows API users to add extra proofs from an external source to a location on a document.

\n

This call can be done multiple times for the same location and even when the package is fully signed (in this case the API user is responsible for making sure that any proof is added before retrieving the signed Audit proofs xml). \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/proofs \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
LocationIdMandatoryLocation of the signature for which the proof content is generated.Guid
NameMandatoryName of the proof.String
DescriptionOptionalBrief human-readable description of the proof.String
TypeMandatoryA machine-readable “type” key. Can be freely chosen.String
ContentMandatoryThe actual content of the proof.Base64 string
IpAddressOptionalIP address of the end user of the external source for which the proof was added.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentThe proof was created for the requested location.
400 Bad RequestThe request contained parameters which could not be accepted.
404 Not FoundThe documentId or the LocationId could not be found.
409 ConflictThe proof could not be added due to some other reason.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","proofs"],"host":[""],"query":[],"variable":[{"id":"802a6e0f-fa5d-4c7e-84cd-8471fd9d7801","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7ef1116c-7ee2-4270-b5b4-a6294f570c24","name":"Audit proof created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7a6b1763-3814-4b4f-94d2-d8d2f3103968","name":"When the Content is not a valid Base64 string or the Type contains an invalid value","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"d9470a73-1231-4819-a77d-dd4990797282","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0d85d2f3-a8f7-4cce-bec0-4b5ac269a22c","name":"When the packageId could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d71563eb-29c9-4366-abfc-4e7ef5a3030b","name":"When Audit Proofs are not enabled or package is in an invalid status.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"0b3fa864-824a-4944-95f7-c153815f8d83"},{"name":"Downloads the Audit Proofs of a package","id":"84b78f41-cc62-43b0-acfc-c565818eabf3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download","description":"

Get Package or Document Audit Proofs Xml

\n

Description

\n

A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the package status is right).

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"130834e3-6e9c-4285-ae49-cd00a90d12bd","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"8537d1d3-4c0e-4d22-9724-92837eb575f1","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"f54a47c1-44a0-416e-8510-d58c5774bed1","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"aa891f80-1109-43cf-8f9e-764296c1d792","name":"When the packageId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"33ebcba7-691b-4415-9f28-47c3fffd2c1a","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"84b78f41-cc62-43b0-acfc-c565818eabf3"},{"name":"Downloads the Audit Proofs of a document","id":"c21f398f-96d7-4ddd-a7ad-d70a41837d15","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download/:documentId","description":"

Downloads the Audit Proofs of a document

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"6a6615cd-d01e-4ca7-bcd9-2b6f58d2537d","type":"any","value":"","key":"packageId"},{"id":"3f1c2f0f-e359-414d-9d3b-d73365eead10","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"452ec26c-689d-46ba-85cf-19e1e0ca737f","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"d41f0d48-c491-4a88-8706-9434dfe63e80","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ed2876f6-64b6-4010-9c43-e19bd220df00","name":"When the document or package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"08e50998-986d-4e42-aee4-6ae505673518","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this document.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"c21f398f-96d7-4ddd-a7ad-d70a41837d15"},{"name":"Downloads the Audit Proofs by packageCorrelationId","id":"626fdf75-afa1-439a-8fd1-cb42267b9661","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packagecorrelations/:correlationId/auditproof/download","description":"

Get Package or Document Correlation Audit Proofs Xml

\n

Description

\n

Correlation ids are used to track packages or documents across several passes through the eSignatures application. On a document it states the “external identity” of that document so that it can be established what happened to it, whereas for a package it depends on how you interpret the data.

\n

Either way, retrieving the audit proofs for such an identifier will combine all available audit proofs into one big XML. Items will be grouped into packages and documents to indicate how they were uploaded several times of the lifespan of the set.

\n

Important: combined audit proofs xmls should only be retrieved when all packages containing the package correlation id or all documents with the given correlation id are fully signed, or otherwise in a final state. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packagecorrelations/{correlationId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/documentcorrelations/{correlationId}/auditproof/download

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CorrelationId*Unique identifier that links related audit proofs together .String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the status of all items in the set is right). \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit proofs xml is returned.
404 Not FoundThe document/package id could not be found.
409 ConflictThe package is not fully signed.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packagecorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"5236174f-eac2-426c-9904-c0b893790911","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"41282f91-7377-481a-9da0-394e9080432d","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"1da497bc-3187-4e28-bd54-6faec5022903","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"83ad55a2-1bd7-4cba-b6f5-a5e98d67cca7","name":"When no package with given correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"372a6cab-3572-4d07-a13d-82e7552d207b","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"626fdf75-afa1-439a-8fd1-cb42267b9661"},{"name":"Downloads the Audit Proofs by documentCorrelationId","id":"2e99d77d-f139-407c-b11a-f02f54551ab0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/documentcorrelations/:correlationId/auditproof/download","description":"

Downloads the Audit Proofs by documentCorrelationId

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["documentcorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"9efb8a1a-4450-4826-99a8-da5c4e1be255","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"3bd47479-a56c-4caf-80d9-29a684515c90","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"3b79745c-b572-48ba-9f07-40ef202f8c66","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4928f2a4-8eb7-4040-9712-92e82b5a4643","name":"When the correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"b1fb4064-b383-4bfb-92ce-fb2d23f57e57","name":"When Audit Proofs are not enabled","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"2e99d77d-f139-407c-b11a-f02f54551ab0"},{"name":"Deletes audit proof infos of a package","id":"4f69a4c6-a6aa-4f1d-b083-93ed360d5689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/auditproof","description":"

Delete Audit Proof Info

\n

Description

\n

Audit proofs are no longer automatically deleted as soon as the corresponding package is deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can now be configured on environment level in the Configuration Index, or specified per package through the DelayedDeletionDate parameter in the Delete Package by ID call.

\n

If you want to delete audit proofs earlier than specified, you can also do a manual Delete audit proof info call and specify of which package the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentAll audit proofs are deleted successfully
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundNo audit proofs available for this package
409 ConflictCould not perform operation on package with id {id}
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof"],"host":[""],"query":[],"variable":[{"id":"5891e857-8b98-4fa5-a0ee-1ff35482d958","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"852ee129-a89e-4c05-9a50-c92f69d6d7f4","name":"Audit proofs of package were succesfully deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"73e5d433-34a7-429f-9f44-4855e154ea4d","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8f1b9908-8243-47fa-9735-5d2e98534ea8","name":"No auditproofs were found for given packageId","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"257e831f-3f69-4145-aee8-f2c2b463dea1","name":"Package wasn't deleted yet","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4f69a4c6-a6aa-4f1d-b083-93ed360d5689"},{"name":"Gets audit proof infos of all packages","id":"e4c03e00-84d1-4647-b6ef-783a0403ceb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","description":"

Get Audit Proof Info

\n

Description

\n

This calls allows to you retrieve the audit proof info of packages.

\n

Currently, you can retrieve the audit proof info of DELETED packages.

\n

You can narrow the search for specific audit proof info by adding the optional request parameters listed below. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproofinfo \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Status*Status of the package. Currently, you can only retrieve the audit proof info of packages that have the status DELETED.String (enum)
PackageIdUnique identifier of the package whose audit proof info you want to retrieve.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.String (GUID)
CreatedBeforeGets only the audit proof info of packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the audit proof info of packages created after this date. ISO 8601 date format.String (date-time)
DeletedBeforeGets only the audit proof info of the packages deleted before this date. ISO 8601 date format.String (date-time)
DeletedAfterGets only the audit proof info of the packages deleted after this date. ISO 8601 date format.String (date-time)
ExpiresBeforeGets only the audit proof info of the packages that expire before this date. ISO 8601 date format.String (date-time)
ExpiresAfterGets only the audit proof info of the packages that expire after this date. ISO 8601 date format.String (date-time)
SortFieldField on which the result is sorted.String
SortOrderDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
PageSizeMaximum number of records in the response Default value is 20.Integer
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.String (GUID)
PackageNameName of the package.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.
PackageCreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
PackageDeletionDateDate and time when the package was deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DelayedDeletionDateDate and time when the audit proofs of the package were deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DocumentsThe documents that the retrieved package contains.Array of objects
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
DocumentIdUnique identifier of the document.String (GUID)
CorrelationIdIdentifier that correlates this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll audit proof info is successfully retrieved.
400 Bad requestThe parameter Status does not support value 'xyz'. Supported value is 'Deleted' only.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","auditproofinfo"],"host":[""],"query":[{"description":{"content":"

(Required) The status of the packages to get the auditproof infos for

\n","type":"text/plain"},"key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items deleted before given date

\n","type":"text/plain"},"key":"deletedBefore","value":""},{"description":{"content":"

Select items deleted after given date

\n","type":"text/plain"},"key":"deletedAfter","value":""},{"description":{"content":"

Select items expires before given date

\n","type":"text/plain"},"key":"expiresBefore","value":""},{"description":{"content":"

Select items expires after given date

\n","type":"text/plain"},"key":"expiresAfter","value":""},{"description":{"content":"

Select items on given correlationId

\n","type":"text/plain"},"key":"correlationId","value":""},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field the result is sorted

\n","type":"text/plain"},"key":"sortField","value":"packageDeletionDate"}],"variable":[]}},"response":[{"id":"1fba9ee3-1979-404e-99d4-d941323a3791","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n },\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"872d7a5f-cbca-4921-9ae4-5023d2613913","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"2f7b8f89-d0d7-4f92-8c0e-b289e6ff0a3d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e4c03e00-84d1-4647-b6ef-783a0403ceb4"}],"id":"fc90affd-c544-49c2-86a3-387d6334d42b","description":"

Audit proofs

\n

When the Audit proofs setting is enabled in the Configuration Index, eSignatures keeps Audit proofs about each signature that is placed.

\n

The following information is collected in base64 format about each form filling:
Form filling events information

\n
    \n

  • Time when form fields on the package were filled out

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an invitation was sent to form fill the package, content of the invitation, recipient(s)

    \n
    • \n

  • For all form filling events mentioned above, the form filler’s IP address is added to the Audit proofs.

    \n
    • \n
\n

The following information is collected in base64 format about each approval:
Approval events information

\n
    \n

  • Time when package was approved

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an invitation was sent to approve the package, content of the invitation, recipient(s)

    \n
    • \n

  • For all approval events mentioned above, the approver’s IP address is added to the Audit proofs.

    \n
    • \n
\n

The following information is collected in base64 format about each reassignment:
Reassignment events information

\n
    \n

  • Time when package was reassigned

    \n
    • \n

  • Reason why the package was reassigned

    \n
    • \n

  • First name of previous and new approver or signer

    \n
    • \n

  • Last name of previous and new approver or signer

    \n
    • \n

  • Email address of previous and new approver or signer

    \n
    • \n
\n

The following information is collected in base64 format about each signature:
Signing events information

\n
    \n

  • Start time of signing, end time of signing

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an SMS OTP was sent, content of the SMS, recipient of the SMS

    \n
    • \n

  • Time when a mail OTP was sent, content of the mail, recipient of the mail

    \n
    • \n

  • Time when an invitation was sent to sign the package, content of the invitation, recipient(s)

    \n
    • \n

  • For the signing events mentioned above, the signer’s IP address is added to the Audit proofs

    \n
    • \n
\n

Signature information

\n
    \n

  • Signature certificate that was used to place the signature, its certificate chain and certificate revocation information (OCSP / CRL)

    \n
    • \n

  • Timestamp certificate, its certificate chain and certificate revocation information (OCSP / CRL)

    \n
    • \n

  • The signed PDF when the package is fully signed

    \n
    • \n

  • If the setting Intermediate States Saved is enabled in the Configuration Index, a copy of the document gets added in base64 format after each signature.

    \n
    • \n

  • Any extra proofs which were added by the client through the Post extra proof call.

    \n
    • \n

  • If the setting IsOneTimeUrlEnabled is disabled in the Configuration Index, the following value is added for every signature that was placed by means of an “unsecure” URL: “One-time URL was disabled when signing”.

    \n
    • \n
\n

All this data is stored in xml files which are signed at the end. The signed xml files can then be retrieved through one of the following four calls:

\n
    \n

  1. The Audit proofs of a specific document within a package, based on the document id

    \n
    2. \n

  2. The Audit proofs of a specific package, based on the package id.

    \n
    3. \n

  3. The Audit proofs of all packages containing a specific package correlation id.

    \n
    4. \n

  4. The Audit proofs of all documents containing a specific document correlation id.

    \n
    5. \n
\n

Important: If a package is deleted via the API or the eSignatures Portal then the audit proofs are deleted as well.

\n","_postman_id":"fc90affd-c544-49c2-86a3-387d6334d42b","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"AuditTrails","item":[{"name":"Downloads the audit trail of the Package (PDF)","id":"c3ab1f4f-2e58-41f8-9f19-38c3d4ead609","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/audittrail/:culture","description":"

Download PDF Audit Trail

\n

Description

\n

This call allows you to retrieve the PDF Audit Trail representation of the specified package in a specified language.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/audittrail/{culture}

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/pdf

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to retrieve.String (GUID)
Culture*ISO 639-1 language code of the language.String
\n

Response parameters

\n

The API returns the Audit Trail in pdf format.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit Trail pdf is returned.
404 Not FoundThe package could not be found.
409 ConflictThe package is not in a final state.
401 UnauthorizedYou don't have the correct rights for this call
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","audittrail",":culture"],"host":[""],"query":[],"variable":[{"id":"a4600f58-709e-459a-952f-d53e48a5b976","type":"any","value":"","key":"packageId"},{"id":"579d190a-86b9-4ac2-85e8-361ac3b12070","type":"any","value":"","key":"culture"}]}},"response":[{"id":"bd54545b-d8e1-49b6-9ed4-a360fae45615","name":"The signed Audit Trail in pdf file.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/pdf"}],"cookie":[],"responseTime":null,"body":""},{"id":"24e4a3a5-8dd1-4876-b134-6f0d6f814c7b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"614a2838-fe3a-4352-9b97-070257564ab0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e3aeaae0-3c00-458b-bcc5-91715b4f9eb3","name":"When the package has not been fully signed, rejected or revoked","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"c3ab1f4f-2e58-41f8-9f19-38c3d4ead609"},{"name":"Verifies whether the audittrail is valid","id":"8a4bf99c-3044-4a7c-b2a9-5e89bf650ea9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/audittrail/verify","description":"

Verify Audit Trail

\n

Description

\n

This call allows you to verify if a specified package's Audit Trail is valid. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/packages/{packageId}/audittrail/verify \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to verify.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA Boolean indicating if the Audit Trail is valid.
404 Not FoundThe package could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","audittrail","verify"],"host":[""],"query":[],"variable":[{"id":"1f3863ff-a16f-435d-aa75-fd7512189f4e","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"a07a275a-7e73-4dd4-809b-dd9db4abe9a2","name":"A boolean indicating if the Audit Trail is valid.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"f934c58b-de18-42d6-a3b8-aa9368df9d87","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"8a4bf99c-3044-4a7c-b2a9-5e89bf650ea9"}],"id":"9ba8b0eb-c153-4d52-a24a-769c75dc0490","description":"

Audit trails

\n

Prior eSignatures versions already supported the Audit Proof, an XML that can be downloaded through the API that keeps track of all actions taken on a package.

\n

With eSignatures 6.1.0, we added the notion of the Audit Trail. The Audit Trail is a pdf that can be downloaded from the Document Portal or through the API. The Audit Trail contains the actions taken for that package and can be downloaded when the package is in a final state.

\n","_postman_id":"9ba8b0eb-c153-4d52-a24a-769c75dc0490","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Templates","item":[{"name":"Gets all package templates available","id":"d8d3c691-8f03-4948-abdd-42f7f5a7842f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","description":"

Get Templates

\n

Description

\n

This call retrieves all the templates, and their code, that are available in the eSignatures WebPortal.

\n

The Template code can be entered as a request parameter when doing a Create Package call. The package will then be created with all the information from the template. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/templates \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
pageNumberOptionalThe page to retrieve.Int
pageSizeOptionalMaximum number of recordsInt
documentGroupCodeOptionalFilter the records by the document group they are in.String
sortOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
createdAfterOptionalOnly show the templates that are created after a
specific date		DateTime
createdBeforeOptionalOnly show the templates that are created before a
specific date		DateTime
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
TotalNumber of total records for the given parametersInt
ItemsList of templatesArray of objects
NameName of the templateString
TemplateCodeUnique id of the templateString
PageSizeMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe templates list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["templates"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"a08ce7a0-c3d0-4bd2-a47d-5aea284edb61","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","host":[""],"path":["templates"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n },\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n }\n ]\n}"}],"_postman_id":"d8d3c691-8f03-4948-abdd-42f7f5a7842f"}],"id":"05bbd6e0-4043-45af-af05-f28f99d867b2","description":"

Package templates module

\n","_postman_id":"05bbd6e0-4043-45af-af05-f28f99d867b2","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"AbsencePeriods","item":[{"name":"Creates an absence period","id":"a0555306-f906-497a-b2d0-431932c0fcc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods","description":"

API v4: Create an absence period

\n

Set an absence period for a user and assign their substitutes.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods

\n

Method

\n

POST

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
User*The email address of a user for whom an absence period is created.String (email)
StartDate*

Absence start date and time.

For example:

2023-02-01T11:40:00Z 2024-12-20T08:00:00+0200

String ($date-time)
EndDateAbsence end date and time.String ($date-time)
SubstitutesSubstitutes for this absence period.
See the child parameters of this parameter.		Array of objects
\n

Child parameters of the Substitutes parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
Type*Possible values:String
person

A stakeholder who takes action on the package individually.		See the parameters for the person type.
group

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to fill out forms and approve or sign a package on behalf of the entire group. Each person in the group will receive a unique URL for the package.

As soon as one member of the group has taken action, the others no longer can.		See the parameters for the group type.
contactgroup

A contact group stakeholder can be used when a contact group has been created in the eSignatures Portal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the eSignatures Portal instead of defining each member in the call.

Note: The stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains.		See the parameters for the contactgroup type.
ActionTypes*

Possible values:

- approver
- receiver
- signer
- formFiller

String (enum)
AllowedToReassignIf enabled, the substitute can assign a package to another user.Boolean
\n

Parameters for the person type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
Language*User language.
A two-letter ISO 639-1 language code.

For example: en		String
TitleFor example: Ms.String
FirstNameThe first name of a substitute.

Maximum length: 150 characters.		String
LastName*The last name of a substitute.

Maximum length: 150 characters.		String
EmailAddress*The email address of a substitute.String (email)
PhoneNumberThe phone number of a substitute.String
BirthDateThe birth date of a substitute.String (date)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the group type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
GroupName*The name of the group.
Maximum length: 128 characters.		String
Members*The list of persons in this group.
Use the same parameters as described for the person type.		Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the contactgroup type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
ContactGroupCode*The contact group code in the eSignatures Portal.String
\n

Response parameters

\n

The response parameters will be the same as the request parameters. Additionally, the required response parameter Id*, which is the unique identifier of the string($guid) type, will be returned for:

\n
    \n
  • The absence period
    • \n
  • The substitutes (person, group, contact group)
    • \n
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
201The absence period has been created.
400

The request failed validation.

For example:

[ { \"Code\": \"Name.MinimumLength:6\", \"Message\": \"The minimum length for a name is 6\" } ]

401The caller is unauthorized to perform this operation.
403It is forbidden to perform this operation.
404

An exception has occurred.

For example:

{ \"Code\": \"User.NotFound\", \"Message\": \"No user found with email address [hello@world.test].\" }

409

The request conflicts with existing information and/or business rules.

For example:

{ \"Code\": \"AbsencePeriod.OverlapsWithExistingAbsencePeriod\", \"Message\": \"The provided absence period overlaps with an existing absence period.\" }

\n

Error codes

\n

|

HTTP code

|

Error code

|\n|

400

|

Json.DeserializationFailed

|\n|

400

|

Request.RequiredFieldIsMissing:{fieldName}

|\n|

400

|

Request.FieldMaxLength:{fieldName},{maxLength}

|\n|

400

|

EmailAddress.Invalid

|\n|

400

|

Request.DateInvalid:{date}

|\n|

400

|

Actor.TypeInvalid:{actorType}

|\n|

400

|

Person.UnsupportedLanguage:{language}

|\n|

400

|

Person.EmailAddressInvalid:{emailAddress}

|\n|

400

|

Person.BirthDayInvalid:{date}

|\n|

400

|

Person.BirthDayInFuture:{date}

|\n|

400

|

Person.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

ContactProperty.Invalid:{contactPropertyKey}

|\n|

400

|

ContactProperty.Duplicate:{contactPropertyKey}

|\n|

400

|

ContactProperty.MissingValue:{contactPropertyKey}

|\n|

400

|

ContactProperty.InvalidValue:{contactPropertyKey}

|\n|

400

|

GroupMember.UnsupportedLanguage:{language}

|\n|

400

|

GroupMember.EmailAddressInvalid:{emailAddress}

|\n|

400

|

GroupMember.BirthDayInvalid:{date}

|\n|

400

|

GroupMember.BirthDayInFuture:{date}

|\n|

400

|

GroupMember.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

PersonGroup.DuplicateEmailAddress

|\n|

400

|

AbsencePeriod.ShouldHaveStartDate

|\n|

400

|

AbsencePeriod.StartDateInThePast

|\n|

400

|

AbsencePeriod.EndDateBeforeStartDate

|\n|

403

|

ContactGroup.ViewNotAllowed

|\n|

403

|

OutOfOffice.Disabled

|\n|

404

|

User.NotFound:{emailAddress}

|\n|

404

|

ContactGroup.NotFound:{contactGroupCode}

|\n|

409

|

AbsencePeriod.OverlapsWithExistingAbsencePeriod

|\n|

409

|

AbsencePeriod.HasMoreThanOneSubstituteDefinedForActionType:{actionType}

|

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"9ea45c6a-9b3a-49c7-bdfa-a7a008e77120","name":"Absence period was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created absence period","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"629114f3-220f-451c-bff8-86be2fee8bd7","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"3692ccf1-ea37-499e-adfc-75b5439047d5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1c076f8b-5cd6-4ac3-b7e1-aff443333105","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"97118b72-568f-4cab-99fa-64807ad6475d","name":"An exception has occured","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"052021b1-38e5-4f89-b6eb-5860961b99e5","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"a0555306-f906-497a-b2d0-431932c0fcc6"},{"name":"Gets absence periods by email address","id":"c1830644-7724-4834-b621-e96444d6d820","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods?email=","description":"

API v4: Get absence periods by email address

\n

Get the list of absence periods for a user by email address.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
email*The email address of a user for whom an absence period is created.String (email)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods"],"host":[""],"query":[{"description":{"content":"

(Required) The user email address to search on

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"74c35240-fe8f-468a-9502-01b61187b973","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"approver\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"deserunt_18\": {},\n \"cupidatat_583\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"approver\",\n \"formFiller\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"nisi_c\": {},\n \"ea_3\": {}\n }\n }\n ]\n },\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"sint3a8\": {},\n \"voluptate_9\": {},\n \"euc90\": {},\n \"qui_7\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"eu_7a\": {},\n \"quis02c\": {}\n }\n }\n ]\n }\n]"},{"id":"7b8fac8b-7e27-4f67-ac94-1f69ff011584","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ad2f6c60-d17e-4ad0-9f5c-a42543326457","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"24a56150-f940-4abd-8dda-5e9264182ac4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c1830644-7724-4834-b621-e96444d6d820"},{"name":"Gets an absence period by id","id":"88748c76-8401-45a2-8211-363af4debedf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Get an absence period by ID

\n

Get the information about an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"f9b0a641-325b-4b82-8ce6-da86a61d842c","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"2ed95b55-1bac-40a3-87d0-c658d58c27e1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"b7ef64f8-c4cc-40b4-80d9-1b77b2830892","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f637eba6-a8af-4327-9a1c-7856c1eb8593","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"08114a80-ee4a-4af7-93a5-b202d5b9876c","name":"An exception has occured","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"88748c76-8401-45a2-8211-363af4debedf"},{"name":"Updates an absence period by id","id":"003f7c49-f23b-47af-8a1b-b67556a131f4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Update an absence period by ID

\n

Update the information in an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

PUT

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

Request parameters

\n

For the list of request parameters, refer to API v4: Create an absence period.

\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"5283921c-bf18-45d5-b705-c4d2e4e80c44","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"4f558c31-db1a-467b-a192-05f91b5261e2","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"9f8a7310-4c28-43d1-a6e6-4d7e3f5cf224","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"419c7181-ce1b-49b9-b503-1b4ff7825865","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"625a76b2-3221-4e15-8649-dc2605758cfc","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d4f84f96-631a-4c97-9e58-fe696bbf867d","name":"An exception has occured","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"008ea0c2-e88c-4c8a-8adf-108062284937","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"003f7c49-f23b-47af-8a1b-b67556a131f4"},{"name":"Deletes an absence period by id","id":"170f1ad5-1b5a-43f5-aa19-1117fcb51533","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Delete an absence period by ID

\n

Delete an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

DELETE

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
204The absence period was deleted.
\n

For other response codes, refer to API v4: Create an absence period.

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"bf141146-9b03-4661-add7-b8356b321b25","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"f572813b-c168-4a05-b25c-a4be7aaa9192","name":"Absence period was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6889bcc7-aed1-4d69-947e-34befb6f0db8","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f7125da5-2db3-4388-bcaf-e22a0ad52af9","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a64b6881-a730-4dff-bebf-9e71fb6a85d4","name":"An exception has occured","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"170f1ad5-1b5a-43f5-aa19-1117fcb51533"}],"id":"eccac807-e2f1-4f34-af9a-73b96f55a94a","description":"

API v4: Managing absence periods

\n

You can set absence periods for users and name their substitutes. In their absence, packages assigned to a user will be forwarded to these substitutes who will act as a form filler, approvers, signers and receivers. \n 

\n

By using API calls, you can:

\n\n","_postman_id":"eccac807-e2f1-4f34-af9a-73b96f55a94a","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"BulkActions","item":[{"name":"Create a bulk signing session for given user","id":"2772841a-73cd-4600-9b41-ba3db1fde689","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"EmailAddress\": \"\",\r\n \"Language\": \"\",\r\n \"Packages\": [\r\n \"\",\r\n \"\"\r\n ]\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk","description":"

API v4: Bulk sign packages

\n

Description

\n

This call allows you to sign multiple pending packages. When providing only the EmailAddress parameter, all available actors will be chosen for bulk signing.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/sign/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailAddress*The email address of the actor for whom you want to start a bulk signing session.String (email)
LanguageThe language of the current signing session.String (language code)
Packages

Collection of PackageIds; i.e., unique identifiers of the packages that must be signed.

Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.

Array of strings (GUID)
ActorsCollection of ActorIds; i.e., unique identifiers of the actors who must sign.
 Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.		Array of strings (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlThe link to a bulk signing session.String (URL)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAn ActionUrl is provided in the response body, this url will open the bulk signing session.
400 Bad RequestThe bulk sign session could not be created due to invalid data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","sign","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"fd9a2c58-1a4f-44be-a4e8-da9109fa4cb2","name":"OK.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"43a7b0dc-7550-4caf-9ca7-283b026c5261","name":"When the Content has an invalid value.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"f65835c7-1bc7-4586-8e06-4e154ae38ea9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2772841a-73cd-4600-9b41-ba3db1fde689"},{"name":"Updates the status of multiple packages in bulk","id":"fcb037a4-fb3b-4d21-aa9b-92addc920fb4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk","description":"

Bulk update status of packages

\n

Description

\n

This call allows you to update the status of multiple packages simultaneously.

\n

The possible combinations are:

\n
    \n
  • Draft to pending
    • \n
  • Pending to revoked
    • \n
\n

Draft to pending

\n

When packages are ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the packages visible to each of the stakeholders in their Signer Portal. \n 

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been processed yet, or packages that have failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package.

\n

Important: For the bulk update to succeed for all packages, make sure that all packages you update are in the same original status. Updating both 'draft' and 'pending' packages to 'revoked' for instance will only succeed for the pending packages. The draft packages can only be updated to pending and will therefore fail when trying to update them to revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/status/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose status you want to update.String (GUID)
Status*Status to which the packages must be updated. The possible values are: pending and revoked.String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad requestThe packages could not be updated due to missing data or unsupported values in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400Request.RequiredFieldIsMissing: status
400Request.UnsupportedValue
401Authentication failed, username or password incorrect.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","status","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"2744fdc6-8a7f-4f98-b322-8779a28e9640","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"20a23665-5735-4473-b563-85d3f8edc63c","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"fcb037a4-fb3b-4d21-aa9b-92addc920fb4"},{"name":"Removes multiple Packages in bulk.","id":"2fa56297-0d68-47fd-ae88-57125c345dfa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk","description":"

Bulk delete packages

\n

Description

\n

This call allows you to delete multiple packages simultaneously from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use this Bulk delete packages call or the Delete package by ID call.

\n

Note: you can only delete packages that have status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be deleted.String (GUID)
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of the packages will be deleted, once the packages have been deleted. When this parameter is not passed, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400AuditProof.DelayedDeletionTimeNegative
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"da859ee3-c1ff-4789-bf89-b90dbf5f59f7","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"f1a72602-2695-4d7a-9799-e8d72d3cddc2","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2fa56297-0d68-47fd-ae88-57125c345dfa"},{"name":"Allows to download multiple Packages in bulk.","id":"9d6ff122-906b-4fa0-ab1c-b0f3b37c24ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk","description":"

Bulk download packages

\n

Description

\n

This call allows you to download multiple finished packages. Note that bulk downloading packages works in two steps:

\n
    \n
  1. The Bulk download packages call downloads the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe packages could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3df949e8-ff8d-4e98-8096-c3d668414839","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"71ad014d-2642-4d18-bf06-a62998315461","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"9d6ff122-906b-4fa0-ab1c-b0f3b37c24ec"},{"name":"Allows to send reminders to the Actors of multiple Packages in bulk.","id":"0446964f-e258-455f-9696-1abde4c3dd54","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk","description":"

Bulk send reminders

\n

Description

\n

The Bulk send reminders call sends a reminder to the actors of the specified packages.

\n

Company policy might require that a document is handled within a given timespan. Doing a Bulk send reminders call looks up all actors within the specified packages who haven't approved/signed/filled out their document and sends them an extra notification as a reminder.

\n

Note that only the next available actor(s) in the workflow are notified. This means approvers/signers/form fillers waiting for someone else to take action first in a serial workflow will not receive a notification. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/reminders/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe reminder could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","reminders","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"3c86c855-c216-4ec0-9ded-1ccd4bfbd505","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"193bc5d9-9f79-4de7-ac46-99c02c763ead","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0446964f-e258-455f-9696-1abde4c3dd54"},{"name":"Allows to extend expiry date of Packages in bulk.","id":"4260c64f-2ef0-46b4-8009-4c075e8ecdc6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk","description":"

Bulk extend the expiry date of packages

\n

Description

\n

This call allows you to extend the expiry date of multiple packages simultaneously. This way, you can make documents that were expired available again. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/expirydate/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose expiry date must be extended.String (GUID)
ExpirationTimeStampDate and time when these packages expire and are no longer accessible. Documents within the packages expire on the same date.

Format is ISO 8601 date-time.		String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe expiration date could not be extended due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","expirydate","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6e2275e4-475d-4cff-8a4c-93a417b18a11","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"5b913ddf-a284-4ac6-9476-9fe3d059fded","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4260c64f-2ef0-46b4-8009-4c075e8ecdc6"},{"name":"Allows to skip a number of Actors of multiple Packages in bulk.","id":"f03a2537-e335-4681-bab0-12e939f23632","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk","description":"

Bulk skip actors of multiple packages

\n

Description

\n

This bulk action call allows you to skip the actors of the specified packages who haven't taken action on their package yet.

\n

With this call you can either skip approvers and form fillers, by sending the packages ToSigners. This way the packages become available for signing, and the approvers/form fillers can no longer take action. Or you can skip any signers who haven't signed yet, by sending the packages ToFinished. This way you can end the signing flow of multiple packages simultaneously. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/skip/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
Target

Target to which the packages must be sent.
Supported values:

- ToSigners
- ToFinished

String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","skip","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"47ab5476-e75f-4a2a-88e3-5f540fb144ba","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"70580dc7-810e-4a17-b803-82461229bdb1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f03a2537-e335-4681-bab0-12e939f23632"},{"name":"Removes audit proofs of deleted packages in bulk.","id":"ccd4903d-eb59-40a8-93e4-6c809e043756","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk","description":"

Bulk delete audit proofs of deleted packages

\n

Description

\n

This call allows you to manually delete the audit proof info of multiple deleted packages simultaneously. As of eSignatures 6.4 it is no longer required to delete audit proofs one by one.

\n

Note that Audit proofs are not automatically deleted as soon as the corresponding packages are deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can be configured on environment level in the Configuration Index, or specified per package(s) through the DelayedDeletionDate parameter in the Delete Package by ID call or Bulk delete packages call.

\n

If you want to delete audit proofs earlier than specified, you can do a manual Delete audit proof info call or this Bulk delete audit proofs call and specify of which package(s) the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproof/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe audit proofs could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","auditproof","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7ca1de4b-042e-4026-a35b-b9c1284fe183","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"554949f1-683d-468e-8e6a-1b56086f70b3","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ccd4903d-eb59-40a8-93e4-6c809e043756"},{"name":"Allows to download audit trails of multiple packages in bulk.","id":"4e552d81-aaff-4807-bfb5-04199cf71e51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk","description":"

Bulk download Audit Trail PDFs

\n

Description

\n

This call allows you to download the audit trail PDFs of multiple packages.

\n

Note that the packages must be in finished, archived, rejected or revoked status to download their audit trail PDF.

\n

Note that bulk downloading audit trail PDFs works in two steps:

\n
    \n
  1. The Bulk download audit trails PDF call downloads the audit trails of the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/audittrails/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
CultureISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe Audit Trails could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","audittrails","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7d8879e2-ec66-4ec6-b522-048642802071","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"ba58ca5d-56f8-47cf-8ccf-e444658a6e26","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4e552d81-aaff-4807-bfb5-04199cf71e51"},{"name":"Get all status information of a bulk package action session.","id":"9ce71bfc-25b9-44c6-b90b-d3e15ede33be","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per package about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of packages that were processed in the bulk action.integer
SucceededThe number of packages that succeeded in the bulk action.integer
FailedThe number of packages that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info per package.Object
\n

BulkActionDetail (per package)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the package.string
ErrorMessageError message displayed when processing the package.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"type":"any","value":"","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":""}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"RequestAuditTrails\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"895f91c0-858a-4a9f-b9a7-66de52e4ea29","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"347f2db9-5775-4f11-ab1e-182390a08d97","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"9ce71bfc-25b9-44c6-b90b-d3e15ede33be"},{"name":"Get all status information of a bulk action session.","id":"59d58ecf-c993-447d-8fc6-93eeed1c728f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each action in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified items. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per item about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of items that were processed in the bulk action.integer
SucceededThe number of requests that succeeded in the bulk action.integer
FailedThe number of requests that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info.Object
\n

BulkActionDetail (per item)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the item.string
ErrorMessageError message displayed when processing the item.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"type":"any","value":"","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"UserEmailInvitationNotification\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"3288af0c-1f48-44ad-891a-2047baee6288","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7212a062-3685-4321-91ab-1f265ed6a1d4","name":"An exception is occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"59d58ecf-c993-447d-8fc6-93eeed1c728f"},{"name":"Allows to download the result of a Bulk Action that creates a Zip archive.","id":"794aafba-c6bc-4178-bbbf-d3e1990e9c75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/bulkactionsession/download/:bulkActionSessionId","description":"

Get bulk action result call

\n

Description

\n

This call allows you to retrieve the result of a Bulk download packages or Bulk download audit trails PDF call once those calls have been finished.

\n

The result is always downloaded as a .zip file. The .zip file contains a subfolder for each package. Each subfolder may contain the documents in .pdf or .xml, or the audit trails in .pdf format. The .zip file also contains a .json file with information about each package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/​/packages​/bulkactionsession​/download​/{bulkActionSessionId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe results of the requested bulk action are successfully downloaded as .zip file.
400 Bad RequestThe results could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"host":[""],"query":[],"variable":[{"id":"02a4d69d-c6c5-40be-b156-877f5d0cffc2","type":"any","value":""},{"id":"91eef4f1-5432-4c55-aa10-45e3b922b5b6","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2607d9db-0319-4581-af31-691d8a3e3e5b","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"794aafba-c6bc-4178-bbbf-d3e1990e9c75"}],"id":"2bce7916-8aea-4a59-8085-726954e53540","description":"

API v4: Bulk actions

\n

You can perform actions on multiple packages at once. 

\n

The following API calls for bulk actions are available: \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CallAdded in version
Bulk sign packages7.4.0
Update the status of packages6.4.x
Bulk delete packages6.4.x
Bulk download packages6.4.x
Bulk send reminders6.4.x
Bulk extend the expiry date of packages6.4.x
Bulk skip actors6.4.x
Bulk delete the audit proofs info of deleted packages6.4.x
Bulk download audit trail PDFs of packages6.4.x
Get bulk action info about a specified bulk action session6.4.x
Get bulk action result call (to download the .zip files created by a Bulk download packages or Bulk download audit trails call)6.4.x
\n

Bulk action calls differ from regular API calls. When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session (BulkActionSessionId) is returned.

\n

This unique ID (BulkActionSessionId) can be used in: 

\n
    \n
  • A Get bulk action info call to check whether the specified bulk action session is finished and what the results are.
    • \n
  • A Get bulk action result call to download the contents (as .zip file) of a Bulk download packages or Bulk download audit trails PDF call.
    • \n
\n","_postman_id":"2bce7916-8aea-4a59-8085-726954e53540","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}},{"name":"Users","item":[{"name":"Sends an user email invitation for given email addresses","id":"cec0aaef-d8d8-4f6d-92aa-8d357c5a544f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\",\n \"InvitationLanguage\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite","description":"

Invite users

\n

Description

\n

This call allows API users to invite other users to the eSignature environment and add them to the correct user groups.

\n

This call can be used to invite multiple users at the same time and create a shared contact from that user if needed.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/users/invite

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
EmailsMandatoryEmail addresses of all the users you want to invite.Array of Strings
UserGroupsOptionalThe user groups you want to assign the invited users toArray of Strings
CreationOptionsOptionalOptional options for the invited users.Object
\n

CreationOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
IsSharedContactOptionalOption to create a shared contact for the userBoolean
InvitationLanguage (as of 7.5.0)OptionalLanguage that will be used for the invitation. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 Request is acceptedThe users have been invited.
400 Bad RequestThe request contained parameters which could not be accepted.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}},"urlObject":{"path":["users","invite"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"d5bb8c3a-0889-410b-9b6a-f8f3dfe3d230","name":"Request is accepted.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Link\": \"\"\n}"},{"id":"db4044d0-4526-47be-a06e-7e00ced89af9","name":"Request failed validation.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"4f67ed62-1372-4918-8fe9-56df0015d0d1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cec0aaef-d8d8-4f6d-92aa-8d357c5a544f"}],"id":"fe0ace79-d90a-4cea-99d9-c14481290cbc","_postman_id":"fe0ace79-d90a-4cea-99d9-c14481290cbc","description":"","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","name":"v7.6 - Documentation","type":"folder"}}}],"id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89","description":"

Last updated 13/10/2023

\n

Introduction

\n

This document describes the technical specifications of the Nitro Sign Premium API v4.

\n

The Nitro Sign Premium API is a REST API. It is a web service that allows external systems to make requests for Nitro Sign Premium sources through URL paths. More concretely, it allows external systems to interact with the Nitro Sign Premium platform and use its features to create and manage signing flows.

\n

Disclaimers

\n

Only the described use cases are supported. All other use cases, even though possibly technically feasible with the API, are explicitly not supported and should not be implemented as such.

\n

In case of discrepancies between examples and the description of the parameters section, the description of the parameters section prevails.

\n

The descriptions of error codes in this document or the actual error message fields returned by the API are subject to change. External applications should rely on the returned error code values, anything else is only for diagnostic purposes.

\n

All documents uploaded to the API must comply with the standards corresponding of that format. Conversions are based on a best-effort approach. The behavior of uploading non-compliant documents and / or conversions in an environment where required fonts, color profiles etc. are missing is undefined.

\n

The URLs of the REST API in this document were changed to v4 in Nitro Sign Premium version 6.0. The support period for the API with v3 URLs outlined in the Nitro Sign Premium version 5.x API Technical Documentation is governed by the Nitro Sign Premium support Contract.

\n

The API calls with v2 URLs are no longer supported since version 6.0.

\n

Be aware that the agile nature of JSON for the REST services supports adding optional parameters to the request or new parameters to the responses. The only actions that are considered breaking changes of the API are adding required parameters, changing existing parameters in the requests, or parameters missing from responses.

\n

Important: Always use conforming JSON data in the requests. When the Web Application Firewall in front of Nitro Sign Premium is enabled, the firewall validates all JSON passing through it and does not accept invalid JSON (e.g. which contains embedded comments such as // or /* */ and extra commas).

\n

Optional fields that are not used must be left out of the request message. An empty string or dummy value for optional fields is also a value, and hence may trigger an error in the current version or a future version.

\n

There is no dedicated error code for packages which exceed a given file size other than HTTP code 404.13 returned by IIS. However, as a practical guideline a document must not exceed 30 MB. Packages must not be larger than 150 MB in total and should not contain more than 15 documents. Note that large files might affect signing performance, depending on the user's Internet connections.

\n

REST service

\n

The services are plain REST based services, maintaining no state whatsoever. All data exchanges, in and out, are handled in JSON data format and using UTF-8 encoding.

\n

The default URL is:

\n

https://[servername]:[port]/esig/webportalapi/v4/

\n

Important note about MTLS:

\n

When the setting IsMtlsEnabled is enabled in the Configuration Index, API users must make sure that an HTTP/1.1 connection is established and that the following header is sent in all Nitro Sign Premium API calls:

\n

Plain Text

\n
Expect: 100-continue\n\n

The client should then wait for the HTTP 100 Continue response before sending the actual payload.

\n

Failing to do so will cause problems with large payloads (e.g. when uploading PDF documents). In such a case the payload will fill the server’s receiving buffer before proper mutual authentication is finished, the connection will never be established and the request will time out as a result.

\n

If for some reason such HTTP/1.1 connection is not feasible, API users can also try to send a HEAD request using their HTTP client object before doing the actual file upload request with the same client. This workaround is not recommended however, since the client may decide to reset the connection in between the two different calls.

\n

HTTP statuses

\n

Below you find an overview of the HTTP statuses that are returned, and their meaning.

\n

Successful responses

\n

200 OK
The response body contains a representation of the requested / created resource.

\n

201 Created
The request led to the creation of a resource. The created resource is in the body of the response and its location is found in the Location header.

\n

204 No Content
The request was successful and there is no additional content to send in the response body.

\n

Client Error responses

\n

400 Bad Request
The server cannot or will not process the request due to something that is perceived to be a client error (e.g. failed validation).

\n

401 Unauthorized
The request has not been applied because it lacks valid authentication credentials for the target resource.

\n

404 Not Found
The origin server did not find a current representation of the target resource.

\n

409 Conflict
The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request.

\n

Server error responses

\n

500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.

\n

Concepts Overview

\n

This section explains the different concepts that are used in the Nitro Sign Premium API.

\n

Package
Packages lie at the core of Nitro Sign Premium. A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

Document
A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder.

\n

A document may contain multiple elements. This element could be a signing field or a form field (e.g. textbox field, checkbox field and radio buttons) and as of 7.0.0 it can also be a UnplacedElement (e.g. not attached to a document yet)

\n

Element
An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor or a form field that can be assigned to a form filler actor.

\n

Stakeholder
A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must do. For instance, form fill, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group.

\n

Actor
An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are: form filler, approver, signer and receiver.

\n

Process and process steps
A package's process defines which stakeholder will do their action at which moment in time. A process may consist of multiple process steps. This way, you can set up parallel, sequential or complex flows in which actors can form fill and approve or sign. All actors that are put in the same process step will be completed in parallel.

\n

Tip: Consult the Glossary section for an overview of more Nitro Sign Premium related terms.

\n

Authentication and Security

\n

Authentication

\n

Basic authentication

\n

The Nitro Sign Premium API supports ‘Basic Authentication’ via a username and password combination that must be placed in the header of every request.

\n

The default credentials, which must be changed through configuration at installation time should have been communicated to you by email or sms.

\n

Note: depending on the Configuration Index settings, the use of an Mtls Client certificate might be required.

\n

Authentication using JWT Access Token

\n

Authentication can be done using a JWT access token following the Oauth 2.0 protocol using the \"Client Credentials Grant\" flow.

\n

The access token can be retrieved by calling the token endpoint of the authentication server. The Url of the token endpoint can be retrieved from the discovery endpoint available at /.well-known/openid-configuration.

\n

The access token should be cached and reused for its lifetime. A new access token should be retrieved using the refresh token when it is expired.

\n

Getting the token with curl:

\n

View MorePlain Text

\n
curl -A \"ClientApplication/1.0\" -d \"grant_type=client_credentials&client_id=${client_id}&client_secret=${client_secret}&scope=${scope}\" \"${token_endpoint}\"\n\n

client_id is the value of the client id (also called application id) provided by Connective client_secret is the \"password\" for the client id, provided by Nitro scope must contain \"https://connective.eu/scopes/esignatures\" for eSignatures token_endpoint is the token endpoint on the authentication server

\n

The response is a json document of the form:

\n

View Morejson

\n
{\n  \"access_token\": \"eyJhb.........A\",\n  \"expires_in\": 300,\n  \"refresh_expires_in\": 1800,\n  \"refresh_token\": \"eyJhb...........A\",\n  \"token_type\": \"bearer\",\n  \"not-before-policy\": 1591634674,\n  \"session_state\": \"0f65368c-90df-4e2f-b039-5320a0b34871\",\n  \"scope\": \"email https://connective.eu/scopes/esignatures profile\"\n}\n\n
\n

When calling the API, the access token must be placed in an Authorization HTTP Header of type “Bearer”. See https://tools.ietf.org/html/rfc6750

\n

NB: a valid User Agent string is required for calls. The default user agent for curl or wget can be blocked by the Web Application Firewall protecting the application.

\n

Security through one-time URLs

\n

The URL lifetime is by default limited to one-time use (unless the administrator disabled the IsOneTimeUrlEnabled setting in the Config Index, which is not recommended). It is therefore recommended to request the stakeholder's actor links just before redirecting them. This way, you make sure they receive the latest generated link.

\n

When end users open an action URL they already used, they will either see a warning or be redirected to a given URL (if available). The only way to achieve this is to request a new URL and provide it to the user. You can do this by retrieving the Actor information via any of the API status calls.

\n

When end users try to take action on a document that has been deleted, a 404 Not found error will occur. This cannot be recovered from, since all information has been purged from eSignatures.

\n

Error Handling Responses

\n

Nitro Sign Premium API v4 uses HTTP error codes to give an idea of whether a call succeeded or failed, and a system of error codes in the response body to give more information in case things went wrong.

\n

The used error codes for each call are listed in that call’s section. The meaning of each error code is further explained in Error Code Descriptions.

\n

The error responses are JSON containing the following list of objects:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Errors (array of objects)List of the errorsArray
ErrorCodeError code with variable informationString
MessageError message detail text, not localizedString
\n

A Nitro Sign Premium error code is always displayed as follows:

\n

Resource.Error:parameter

\n

E.g. Package.NotFound:00000000-0000-0000-0000-000000000000. The GUID behind the colon is the packageId that wasn't found.

\n

Error codes can be reused: if the HTTP response code is HTTP 400 Bad Request, an error code like “Document.InvalidTargetFormat” indicates a value that is not supported by Nitro Sign Premium. If the HTTP response code is HTTP 409 Conflict, an error code like “Document.InvalidTargetFormat” means that the request value can currently not be used because the configuration forbids it.

\n

Note: any HTTP 500 Server Error or other 50x responses might deviate from the format described in this section as they are not part of the API.

\n

Full error code descriptions

\n

https://connectivegroup.my.site.com/s/article/API-v4-Error-code-descriptions

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"77f470aa-791e-412d-b78c-e02567d5b3c0","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"d5fa7e9b-88b6-4521-9ce7-ccfd0b356503","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"ea6d37d5-32ab-4c00-8dc7-ecf93905af89"},{"name":"v8.0 - v8.1 - Documentation","item":[{"name":"Configuration","item":[{"name":"Gets all contact groups","id":"ef34b404-f2cf-4fea-b2d8-fd00ff826833","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get ContactGroups

\n

Description

\n

This call retrieves all the contact groups, and their code, that are currently created in the eSignatures WebPortal.

\n

The ContactGroup code can be entered as a request parameter when doing a Create Package call. Any member of the requested contact group will be able to sign the package for the entire group.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/contactgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of contact groupsArray of objects
NameName of the contact groupString
CodeUnique id of the contact groupString
MaxQuantityMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe contact groups list gets returned successfully.
400 Bad requestA request parameter was invalid.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["contactGroups"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"742b541c-87df-4758-82ad-7cf285bee3ce","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"db247d4d-1367-441a-97e5-ef599704eeaa","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n },\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n }\n]"},{"id":"ceaa7aad-fd74-459f-9ca6-ff788b77b65b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ef34b404-f2cf-4fea-b2d8-fd00ff826833"},{"name":"Retrieves all document groups to which packages can be assigned","id":"e5ee47a7-54fb-41d8-beb0-dceb239fcfa9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/documentGroups","description":"

Get DocumentGroups

\n

Description

\n

Some requests need to identify a Document Group in which a document is to be used. This request allows to list the names of document groups and most importantly their associated codes.

\n

There is always at least one document group: “My Documents” (the name could be different) with Code “00001”. This group is special because the documents in this group are only visible to the eSignatures Portal user who uploaded the document (in case of an upload made through the API from this document it will be the user whose email was given as Initiator).

\n

Please note that the Code field is a string. Its value may look numeric but its leading zeroes are part of the value.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/documentgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurenceContent / DescriptionType
nameOptionalThe document group name (or part) to search forString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentGroupsList of all document groupsArray of objects
NameName or description of the document groupString
CodeA unique value identifying each document groupString
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document groups gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["documentGroups"],"host":[""],"query":[{"disabled":true,"description":{"content":"

The document group name (or part) to search for

\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[{"id":"2846dcc2-0da3-498e-a768-1c999435f8c8","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"DocumentGroups\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ]\n}"},{"id":"69e41834-c429-4379-a70b-b32c34ae41ac","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"e5ee47a7-54fb-41d8-beb0-dceb239fcfa9"},{"name":"Retrieves all languages that are enabled in the application","id":"96ef3c5e-a405-4845-99ee-b5ca2aeab5fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/languages","description":"

Get Enabled Languages

\n

Description

\n

This call retrieves the list of languages that have been enabled in the eSignatures Configuration Index and are thus available in the eSignatures Portal.

\n

This call is useful for integrators who need to know which languages are currently enabled in a given eSignatures installation.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/languages

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EnabledLanguagesList of enabled languagesArray of objects
DisplayNameDisplayName of the language as defined in the Config Index.String
NativeNameNativeName of the language as defined in the Config Index. The NativeName is the name of the language in its actual language. E.g. français for French.String
IsoCultureCodeISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe EnabledLanguages list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["languages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0932f4a7-ba7d-428b-837b-266f015d3076","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"EnabledLanguages\": [\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n },\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n }\n ]\n}"},{"id":"59b9f21a-f8e5-475b-b8bc-8baf15220c3c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"96ef3c5e-a405-4845-99ee-b5ca2aeab5fb"},{"name":"Retrieves all themes that can be assigned to a packages","id":"a275a4f8-0632-435c-babc-32a1afc47e58","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get Themes

\n

Description

\n

This call retrieves all the Themes, and their code, that are currently created in the Configuration Index.

\n

The theme code can be entered as a request parameter when doing a Create Package call. The packages in question will then have the requested theming.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/themes

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of themesArray of objects
NameName of the themeString
CodeUnique id of the themeString
MaxQuantityMaximum number of recordsInt
TotalTotal number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe themes list gets returned successfully.
400 Bad requestA request parameter was invalid
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["themes"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"2976cb53-6782-49a2-b38a-722889cf9c47","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"39b228ae-064e-4cf8-b125-d14ea399178b","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"ec7bf1cf-1344-4a85-adb5-0e07648bf993","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a275a4f8-0632-435c-babc-32a1afc47e58"},{"name":"Retrieves the version of the WebSigner application","id":"34985e73-21ee-479e-b737-0fc46b539922","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/version","description":"

Get Version

\n

Description

\n

This call checks the version and build number of eSignatures.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/version

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ProductVersionNumber of the versionString
FileVersionNumber of the file (build)String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe version and build number get returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["version"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"14d42e60-23b5-400b-b67b-9f434deb3004","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ProductVersion\": \"\",\n \"FileVersion\": \"\"\n}"},{"id":"fbebf518-4d0b-434f-ac33-a1dca1e65d47","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"34985e73-21ee-479e-b737-0fc46b539922"}],"id":"48ec8fbf-fa2f-49b1-b1c5-850b331506f4","description":"

Retrieving information about the configuration

\n","_postman_id":"48ec8fbf-fa2f-49b1-b1c5-850b331506f4","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Packages","item":[{"name":"Gets all packages","id":"f720d97f-3e8c-4d17-912f-1853a3b328b6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","description":"

Get packages

\n

Description

\n

This call retrieves all packages that currently exist within eSignatures, and their current status.

\n

Packages are always sorted on creationDate. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.Integer
PageSizeMaximum number of records in the response Default value is 20.Integer
CreatedBeforeGets only the packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the packages created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
DocumentGroupCodeGets items that have given documentGroupCode. An admin may configure document groups in eSignatures to which users can upload their documents. The documentGroupCode is the identifier of the document group to which the package has been uploaded.String
InitiatorGets only the packages created by the specified initiator email address.String
PackageNameGets packages that have the specified name as package name.String
ExternalReferenceGets packages with the specified value as external package reference. Note this only applies for external package references, not external document/field references.String
SortDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. Default value is 20.Integer
TotalTotal number of items.Integer
ItemsThe packages that are retrieved.Obects
\n

The Response parameters per package are identical to the ones of the Create package call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

Select items that have given initiator email address

\n","type":"text/plain"},"key":"initiator","value":""},{"description":{"content":"

Select items that have given package name

\n","type":"text/plain"},"key":"packageName","value":""},{"description":{"content":"

Select items that have given external reference

\n","type":"text/plain"},"key":"externalReference","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"2b9fe2b1-f176-4f4b-9758-7995dd88f8f1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Processing\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"document\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n },\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"InProgress\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Rejected\",\n \"Elements\": [\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"ProcessingFailed\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n }\n ]\n}"},{"id":"1ea32641-8a40-4e76-8286-28dcf4b0ba6d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"f720d97f-3e8c-4d17-912f-1853a3b328b6"},{"name":"Creates a new package","id":"c79a99d3-ae6f-420b-965f-556cfb2368bc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"\",\r\n \"Initiator\": \"\",\r\n \"Status\": \"pending\",\r\n \"ExpiryDate\": \"\",\r\n \"DefaultLegalNotice\": {\r\n \"Name\": \"\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Name\": \"\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"PdfOptions\": {\r\n \"TargetFormat\": \"pdfa1a\"\r\n },\r\n \"Base64data\": \"\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n }\r\n ],\r\n \"Stakeholders\": [\r\n {\r\n \"Type\": \"person\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\",\r\n \"PhoneNumber\": \"\",\r\n \"AdditionalProperties\": {\r\n \"BeId\": \"\",\r\n \"BeLawyer\": \"\"\r\n },\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 0,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 0,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"Type\": \"group\",\r\n \"GroupName\": \"\",\r\n \"Members\": [\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n },\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n }\r\n ],\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 1,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 1,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"ThemeCode\": \"string\",\r\n \"CallBackUrl\": \"https://callback.test\",\r\n \"NotificationCallBackUrl\": \"https://notifications.test\",\r\n \"DefaultRedirectUrl\": \"\",\r\n \"F2fRedirectUrl\": \"\",\r\n \"IsUnsignedContentDownloadable\": true,\r\n \"IsReassignEnabled\": false,\r\n \"ExternalReference\": \"myFirstPackage\",\r\n \"ActionUrlExpirationPeriodInDays\": 7,\r\n \"ProofCorrelationId\": \"\",\r\n \"AddInitiatorAsReceiver\": false,\r\n \"MustBeArchived\": true,\r\n \"ArchiveAuditProofs\": false,\r\n \"ArchiveAuditTrail\": false,\r\n \"AutomaticReminder\": {\r\n \"IsSendAutomaticRemindersEnabled\": true,\r\n \"DaysBeforeFirstReminder\": 2,\r\n \"IsRepeatRemindersEnabled\": true,\r\n \"RepeatReminders\": 3\r\n },\r\n \"ExpirationReminder\": {\r\n \"IsSendExpirationRemindersEnabled\": true,\r\n \"DaysBeforeExpirationReminder\": 2\r\n },\r\n \"OtpAuthenticationSetting\": {\r\n \"IsSmsOtpAuthenticationEnabled\": false,\r\n \"IsMailOtpAuthenticationEnabled\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages","description":"

API 4: Create package

\n

Description

\n

The POST package call creates an empty package, to which documents can be added later on.

\n

In its simplest form, this method contains only two request parameters: the package name and the initiator, which is the user who will be sending the packages. Afterwards you can build on this method by adding additional resources. You can add documents, elements, stakeholders, actors, etc. by using their respective calls.

\n

You can also choose to define all parameters in a single POST package call, making it a so-called \"super call\".

\n

Size limitations

\n

Consider the following size limitations when creating packages.

\n
    \n

  • A package must not exceed 150 MB.

    \n
    • \n

  • A package must not contain more than 15 documents and each document must not exceed 30 MB.

    \n
    • \n

  • An .xml file must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.

    \n
    • \n

  • Large files might affect signing performance depending on the user's Internet connection.

    \n
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n

The parameters with an asterisk are mandatory. All others are optional.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the package. The name is displayed in the eSignatures WebPortal, and used as file name when you download the package as .zip file from the WebPortal. Note: do not add an extension to the Name value Important: Pay attention when choosing a package name. Don’t use forbidden file name characters such as slash (/), backslash (), question mark (?), percent (%), asterisk (*), colon (:), pipe (), quote (‘), double quote (\"), less than (<), greater than (>). Note however, that is list is not exhaustive. Don’t use characters that are HTML-sensitive such as ampersand (&) or apostrophe (‘). Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150
Initiator*The email address of the user who will send the package. The user must be a known user in the eSignatures WebPortal.String (email)
StatusThe status the package will be in when created. The possible values are: draft or pending. By default, a package is in draft after creation.String (enum)
DocumentGroupCodeThe documentGroupCode is the identifier of the document group to which the package must be uploaded. In a default configuration, an initiator uploads packages to their personal MyDocuments folder, which cannot be shared with others. To enable collaboration however, an eSignatures admin can configure multiple document groups to which different users may have access. This way, they can collaborate on one another's' documents. To upload packages to the MyDocuments folder, do not use this parameter, or specify value 00001. To upload packages to a specific document group, enter its documentGroupCode. Tip: to know which document groups have been configured in eSignatures, use the Get document groups call.String
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time. E.g. 2018-01-23T12:34:00.000ZString (date-time)
DocumentsDocuments in base64 encoded format that must be added to the package. The request parameters regarding documents are identical to those of the Add document call and are described here.Array of objects
StakeholdersStakeholders that must be added to the package. A stakeholder is an object that provides information about any person who is involved with the package. The request parameters regarding stakeholders are identical to those of the Create stakeholder call and are described here.Array of objects
DefaultLegalNoticeThe default legal notice that will be added to a signer when no legal notice is specified. See the section defaultLegalNotice below for more info.Object
ThemeCodeDefines which themeCode must be applied to the package. An eSignatures admin can rebrand the look and feel of the eSignatures WebPortal by creating and configuring new themes. Each theme has a themeCode to identify it. When this parameter is not used, the theme that has been configured on environment level in the Configuration Index, or on document group level if applicable will be applied.String
CallBackUrlThe Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place. See Callback URL details below.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URL. Since eSignatures by default uses one-time URLs, the link to sign a package only works once. As soon at is has been clicked, the link expires and a new signing link must be requested.String (url)
DefaultRedirectUrlDefault URL to which stakeholders will be redirected after completing their actions. Set on package submit, when actor has no RedirectUrl. New since eSignatures 7.0.String (url)
F2fRedirectUrlURL to which the end user is redirected after all fields have been signed or rejected face to face in the Document Portal. See the F2fRedirectUrl Details section below for more information.

Attention: Don't confuse the f2fRedirectUrl with the regular RedirectUrl. The f2fRedirectUrl only applies when signing face to face in the Document Portal. The redirect occurs after signing or rejecting. This field must be a valid absolute url.

Note: during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new url after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.		String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting. Enter ‘true’ if you want actors to be able to download the package before form filling/approving/signing. This way they can print it and read it on paper for instance. Enter ‘false’ to hide the download icon and prevent actors to be able to download packages from the WYSIWYS. When this parameter is not used, the value from the Config Index setting IsDownloadUnsignedFilesEnabled under Customization Settings is used.Boolean
IsReassignEnabledDetermines whether a stakeholder may reassign their action to another party. Enter ‘true’ if you want actors to be able to reassign the package. Enter ‘false’ to hide the reassign button and prevent actors to be able to reassign packages from the WYSIWYS. When no value is entered, this parameter takes it value from the Config Index setting IsReassignEnabled under Customization Settings.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String (GUID)
AddInitiatorAsReceiverThis parameter is available as of eSignatures 6.5.0. It determines whether the initiator is added by default as receiver of the package. This way, you no longer need to do this manually in a Create actor call.

This parameter allows to override the default environment level setting IsAddInitiatorAsReceiverEnabled set in the Configuration Index.
Note however that when that setting is set to true, it is unnecessary to pass the AddInitiatorAsReceiver parameter, since each initiator is then added as receiver by default.		Boolean
MustBeArchivedAvailable as of eSignatures 6.6.0, this parameter enables you to determine whether the package should be archived or not.
Note: The value will be ignored if archiving is not configured on an environment level in the Config Index.
When archiving is configured, it is unnecessary to pass the MustBeArchived parameter, since each package is then archived by default.		Boolean
ArchiveAuditProofsAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit proofs must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit proofs are disabled in the audit tools settings or in the archive settings.		Boolean
ArchiveAuditTrailAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit trail must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit trail is disabled in the audit tools settings or in the archive settings.		Boolean
TemplateCodeDefines which template will be used for the package. When using a template code the package will have all the information from the predefined template already implemented, You can still add or change information using additional api calls.
Note: When using a templateCode the only other mandated parameter is the \"Initiator\", the following are optional: \"name\", \"ExternalReference\" and \"ProofCorrelationId\" all others will be overwritten by the template itself.		String
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:

- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer). The minimum value: 1.
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer). The minimum value: 1.

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:

- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer). The minimum value: 1.

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that will be applied to the signer when no legal notice is specified.

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive*.

\n

*When using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

When defining a defaultLegalNotice, you can choose from two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LEGALNOTICE1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

The maximum length of the text value is 1000 characters (including fill-in values). When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable.

\n

Instant Package

\n

API v4 allows to mimic the 'Instant Package' functionality available within API v3. This is possible by combining all different objects within one call (not applicable when using a templateCode)

\n
    \n

  • Create Package

    \n
    • \n

  • Add document(s)

    \n
    • \n

  • Add element(s)

    \n
    • \n

  • Add stakeholder(s)

    \n
    • \n

  • Add actor(s)

    \n
    • \n

  • Add process

    \n
    • \n
\n

This does bring one additional concept to take into account when adding multiple documents, as you will need to define for which document you are adding the stakeholder(s) / actor(s). As at this point you have not yet received the documentId, the concept of documentIndex has been introduced on element level. The documentIndex is being used to identify the document for which the actor is being added, 0 being the first document in the call, 1 the second and so on.

\n

Response parameters

\n

The Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe package was created successfully.
400 Bad requestRequest validation failed. The package could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
409 ConflictThe package could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Package.InitiatorInvalid
400Url.Invalid
400Request.UnsupportedValue
400Document.UnsupportedLanguage
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400LegalNotice.NameAndTextUsedSimultaneously
401Authentication failed, username or password incorrect
404DocumentGroup.NotFoundWithCode
404Theme.NotFoundWithCode
404User.NotFound
404Actor.NotFound
404Stakeholder.NotFound
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
409Document.DataMissing
409SigningField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
409Package.UnassignedElements
\n

CallbackUrl Details

\n

The Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place.

\n

A callback happens in the following cases:

\n
    \n

  • A user has changed the status of the package created via API from Draft to Pending through the Document Portal.

    \n
    • \n

  • A user has clicked confirm in a Drag and drop editor window.

    \n
    • \n

  • A user has revoked the package through the Document Portal.

    \n
    • \n

  • One of the signers has completed all their signing fields.

    \n
    • \n

  • All signers signed the package.

    \n
    • \n

  • One of the signers has rejected the package.

    \n
    • \n

  • The approver approved the package.

    \n
    • \n

  • The form fillers completed the fields.

    \n
    • \n

  • The status of the package has been changed to Failed by the system.

    \n
    • \n
\n

Note: API requests explained in this document will never trigger a callback. A callback will happens only when an end user triggers an action in the eSignatures Portal or Signer application. Other triggers might be added in the future.

\n

The callback URL must contain a valid, absolute URL with no parameters.

\n

eSignatures 6.4.1 to current:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"Finished\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

As of eSignatures 6.0, the base URL CallbackURL only contains PackageId as parameter. The PackageStatus is passed in the application/json body. Prior to 6.0, the base URL contained both the packageId and the packageStatus - also notice the difference in casing. If you're upgrading from eSignatures 5.x and have an existing integration you don't want to break, make sure to select the legacy or both option under API Settings in the Config Index. That way, the PackageId and PackageStatus parameters are still appended to the base URL. The body uses parameters starting with a lower case, such as 'packageId', while the CallbackURL uses parameters that start with a capital letter, such as 'PackageId'.

\n

Until eSignatures 6.3.x:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"FullySigned\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

Important:

\n
    \n
  • If you are upgrading from eSignatures 5.x, and you want to append the PackageId and PackageStatus to the base URL, as was the standard behavior in eSignatures prior to version 6.0, make sure to select the legacy or both option under API Settings in the Config Index.
    • \n
\n

However that there is a difference in casing between the two eSignatures versions. As of version 6.0, camel casing in used. If your integration is case-sensitive, it will fail on the callback verification, since it expects the parameters \"PackageId\" and \"PackageStatus\" in the CallbackURL instead of \"packageId\" and \"packageStatus\". This casing issue has been solved in eSignatures 6.4.1.

\n
    \n
  • For performance and scalability purposes, a Callback timeout has been introduced and is set to 100 seconds. This way, if the driving application doesn’t respond to eSignatures’ callback, a timeout will be forced, and the rest of the flow will be finished as if the expected 200 OK message were received. If eSignatures were to wait indefinitely for a response to finish the package, its performance would drop drastically.
    • \n
\n

For this reason, it’s highly recommended that the client’s callback service is developed in such a way that it sends its response as soon as possible. Any other actions done by the callback service must not depend on the response being sent but should function asynchronously.

\n

In case a Callback error should occur, eSignatures by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See the Installation Documentation for more information.

\n

Notification Callback Details

\n

The Notification Callback parameter, if specified, will in certain cases override the usual behavior of sending out emails and triggers a remote service instead. The remote service must then retrieve information about the package and choose what to do.

\n

While the normal callback is called for major state changes, the notification callback can be called multiple times without any apparent change. For that reason, the callback includes information about the type of notification which was requested.

\n

The remote server is called only once per user action; there is no retry unless the end user requests a new notification.

\n

This callback system may at one point be superseded by a more generic extension mechanism for notifications. At that point only the more generic mechanism will receive improvements.

\n

eSignatures waits for this remote service to complete its job before returning control to the end user. Therefore the remote service needs to give a response within seconds.

\n

A callback consists of a POST request to the specified URL with content-type application/json. The following parameters are available in the JSON body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the packageString (GUID)
actorIdIdentifier of the actor for which the notification was triggeredString (GUID)
languageThe language which the end user was told to use (see the Language parameter in the Stakeholder object of the Set Process Information call).String
notificationTypeKeyWhich kind of notification was requestedString
\n

A callback may currently happen in the following cases:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
notificationTypeKeyUse Case
SendActionUrlThe single-use action (form filler, approver, signer) link has been used already and the end user requested a new link.
SendDownloadUrlThe single-use download link has been used already and the end user requested a new link.
\n

Since this list may grow in the future, the remote service will need to ignore other types without returning an error response.

\n

Other use cases will not send a callback until explicitly listed in the table above. The existing emails sent when a package is created, revoked, etc. will depend on the SuppressNotifications parameter which is separate from the NotificationCallbackUrl.

\n

In case a callback error should occur, eSignatures now by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See Installation Documentation of the latest released version for more information.

\n

F2FRedirectUrl Details

\n

The F2FRedirectUrl is used to redirect the end user after all fields have been signed or rejected face to face in the Document Portal.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create Package call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. PackageId)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical. However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.
    For consistency, the F2FRedirectUrl response parameter is also named PackageExternalReference.

    \n
    • \n
\n

The F2FRedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.

\n

For example, if the RedirectUrl parameter contains the following redirect URL:

\n

https://myserver.example.org/rental/services/testredirect

\n

Then, the effective F2FRedirectUrl will be:

\n

https://myserver.example.org/rental/services/testredirect?PackageExternalReference=DemoReference&Status=SIGNED&SessionID=38bb590e-1eca-4c98-bf0c-bf1af2347000

\n

The end user can counterfeit the F2FRedirectUrl because the redirection happens client-side.
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

During asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a F2FRedirectUrl however is to redirect the signer to a new URL after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6aecdf40-a13f-41f7-a016-f860edfc7108","name":"Package was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Name\": \"example package\",\n \"Initiator\": {\n \"value\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"SingleMarkerMatchPerElement\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages","description":"

API 4: Create package from template

\n

Description

\n

The POST package call creates a package based on an existing template.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n

The parameters with an asterisk are mandatory. All others are optional.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameName of the package. The name is displayed in the eSignatures WebPortal, and used as file name when you download the package as .zip file from the WebPortal. Note: do not add an extension to the Name value Important: Pay attention when choosing a package name. Don’t use forbidden file name characters such as slash (/), backslash (), question mark (?), percent (%), asterisk (*), colon (:), pipe (), quote (‘), double quote (\"), less than (<), greater than (>). Note however, that is list is not exhaustive. Don’t use characters that are HTML-sensitive such as ampersand (&) or apostrophe (‘). Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150
Initiator*The email address of the user who will send the package. The user must be a known user in the eSignatures WebPortal.String (email)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
TemplateCode*Defines which template will be used for the package. When using a template code the package will have all the information from the predefined template already implemented, You can still add or change information using additional api calls.
Only other mandated parameter is the \"Initiator\", the following are optional: \"name\", \"ExternalReference\" all others will be overwritten by the template itself.		String
SingleMarkerMatchPerElementControls the lifecycle of unplaced elements (originating from template) identified by document markers. Defaults to 'false'.
- 'false' (or 'null'): Allows an element definition to be matched by markers in multiple documents; cleanup of remaining unplaced elements is deferred.
- 'true': Each element definition can only be matched by one marker during document confirmation; the definition is removed after being placed.		Boolean
\n

Response parameters

\n

The Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe package was created successfully.
400 Bad requestRequest validation failed. The package could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
409 ConflictThe package could not be created.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6d75e450-1df0-4ab2-a362-0c481c3db2b1","name":"Package was created.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": \"CD758AE3-5382-48B2-A4F3-DD76C7200EE0\",\r\n \"Name\": \"example pending package\",\r\n \"Initiator\": \"hello@world.test\",\r\n \"Status\": \"pending\",\r\n \"ExpiryDate\": \"2020-01-17T12:33:47.923Z\",\r\n \"DefaultLegalNotice\": {\r\n \"Name\": \"LegalNotice1\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Id\": \"1E501B99-9F0F-4F12-9AD9-6C737C6394E8\",\r\n \"Name\": \"my first document\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"doc0\",\r\n \"ProofCorrelationId\": \"correlation identifier\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"PdfOptions\": {\r\n \"TargetFormat\": \"pdfa1a\"\r\n },\r\n \"Base64data\": \"string\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n },\r\n {\r\n \"Id\": \"1BAE1A85-BF29-426C-A9B6-D7BD330CF4CD\",\r\n \"Name\": \"my second document\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"doc1\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"Base64data\": \"string\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n }\r\n ],\r\n \"stakeholders\": [\r\n {\r\n \"Id\": \"C2CEBEEF-A9BB-4BF8-9FD9-7F78EBC80CC2\",\r\n \"Type\": \"person\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"EmailAddress\": \"john@doe.test\",\r\n \"BirthDate\": \"1990-01-16\",\r\n \"PhoneNumber\": \"+32xxxxxxxxx\",\r\n \"AdditionalProperties\": {\r\n \"BeId\": \"12345678900\",\r\n \"BeLawyer\": \"b459d74c-1f90-4d63-9f4a-6de9cead8c5e\"\r\n },\r\n \"Actors\": [\r\n {\r\n \"Id\": \"5D197888-8660-4374-BB42-102A4F6E35C4\",\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 0,\r\n \"Elements\": [\r\n {\r\n \"Id\": \"F77A4B19-ADEB-495B-A098-1E99DB0E42FD\",\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 0,\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ],\r\n \"Links\": [\r\n \"https://api.example.test/signinit?packageSignId=cd758ae3-5382-48b2-a4f3-dd76c7200ee0&token=123\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"Id\": \"57274DC0-2B9F-4A1E-B9FD-CFD1C1893683\",\r\n \"Type\": \"group\",\r\n \"GroupName\": \"Great mates\",\r\n \"Members\": [\r\n {\r\n \"Id\": \"750FC8F4-00D0-4247-AA5A-9323A1E1F740\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"EmailAddress\": \"john@doe.test\",\r\n \"BirthDate\": \"1990-01-16\"\r\n },\r\n {\r\n \"Id\": \"BE89E158-4278-41E7-BF33-7EE6F8B2ECFB\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"Zu\",\r\n \"LastName\": \"Li\",\r\n \"EmailAddress\": \"zu@li.test\",\r\n \"BirthDate\": \"1991-03-14\"\r\n }\r\n ],\r\n \"Actors\": [\r\n {\r\n \"Id\": \"F62C2D0D-42E2-48E9-BA4B-C9825290C474\",\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 1,\r\n \"Elements\": [\r\n {\r\n \"Id\": \"E62DB347-5ED1-48DA-91A3-90A660AA18CC\",\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 1,\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ],\r\n \"Links\": [\r\n \"https://api.example.test/signinit?packageSignId=cd758ae3-5382-48b2-a4f3-dd76c7200ee0&token=321\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"ThemeCode\": \"string\",\r\n \"CallBackUrl\": \"https://callback.test\",\r\n \"NotificationCallBackUrl\": \"https://notifications.test\",\r\n \"IsUnsignedContentDownloadable\": true,\r\n \"ExternalReference\": \"myFirstPackage\",\r\n \"MustBeArchived\": true,\r\n \"ArchiveAuditProofs\": false,\r\n \"ArchiveAuditTrail\": false\r\n}"},{"id":"b93cac60-2aff-40b8-b257-58495f370888","name":"The package could not be created.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"5c291645-036c-4d44-a4d4-430564e6f80d"},{"name":"Gets a package by id","id":"d0ad26f7-f13f-49d0-83d6-641598bca21b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId","description":"

Get package by ID

\n

Description

\n

This call allows you to retrieve a package by its ID.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the package.String (GUID)
NameName of the package. Minimum length: 1 Maximum length: 150String
StatusStatus of the package.String (enum)
CreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00:00ZString (date-time)
ExpiryDateDate and time when the package will expire. Format is ISO 8601 date-time. E.g. 2020-01-25T13:00:00:00ZString (date-time)
InitiatorEmail address of the user who sent the package. This must be a known user of the WebPortal.String (email)
UnplacedElementsDetails of each of the elements that have not been placed or sized in a document. The unplaced element response parameters are the same as the element response parameters listed in the tables below, except that they do not have a location and dimension.Array of objects
DocumentsThe documents that were added to the package. The document response parameters are listed in the table below.Array of objects
StakeholdersThe stakeholders that were added tp the package. The stakeholder response parameters are listed in the table below.Array of objects
DefaultLegalNoticeDefault legal notice that has been added for the signer(s). The default legal notice response parameters are listed in the table below.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
DocumentGroupCodeIdentifier of the document group to which the package will be added.String
ThemeCodeIdentifier of the themeCode that has been applied to this package.String
CallBackUrlLink that will be called upon each status change. See CallbackUrl Detailsbelow for more info.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URLString (url)
F2fSigningUrlLink to the package which allows to start a face to face signing session.String (url)
PreviewUrlLink to access the preview for a pending package.String (url)
F2fRedirectUrlLink to which the end user is redirected when all fields have been signed, or when a field has been rejected. Attention: not to be confused with a \"regular\" redirectUrl.String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting.Boolean
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String
AddInitiatorAsReceiverWhether or not the initiator has been added as receiver of this package.
Note: This parameter is only returned for draft packages.		Boolean
WarningsWarning about the package, e.g., missing data. The warning response parameters are listed in the table below.Object
MustBeArchivedWhether or not the package will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditProofsWhether or not the audit proofs will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditTrailWhether or not the audit trail will be sent to the external archive when the package status is Finished.Boolean
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:
- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer).
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer).

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:
- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer).

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

Document response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. The element response parameters are listed in the tables below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Further information regarding documents is identical to those of the Add document call and is described here.

\n

Element response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document. The location response parameters are listed in the table below.Object
DimensionsDimensions of the element. The dimensions response parameters are listed in the table below.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field. The legal notice response parameters are listed in the table below.Object
MarkerType (as of 7.5.0)The type of marker of an unplaced element. Possible values: None, Text, PdfFormField. Note: Only viable for unplaced elements of a package.String (enum)
MarkerId (as of 7.5.0)A piece of text or PDF field identifier of the corresponding MarkerType. Note: Only viable for unplaced elements of a package.String (date)
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Further information regarding elements is identical to those in the Create element call and is described here .

\n

Stakeholder response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Further information regarding stakeholders is identical to those of the Create stakeholder call and is described here.

\n

Actor response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers. The result response parameters are listed in the table below.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
Links/MemberLinksThis parameter defines links for interacting with the package.String (url)
ActionUrlsThis parameter will lead to the download for a Receiver, for other actors it will lead to the WYSIWYS or the Preview.Array of objects
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByThe actor information see table belowObject
CompletedDateDate when the action was completed.String (date-time)
RejectReasonReason why a document was rejected.String
\n

CompletedBy

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

ActionUrls

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
UrlLinks to interact with the package.String (url)
TypeType of the ActionUrl.String
\n

Further information regarding actors is identical to those of the Create actor call and is described here.

\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that is applied to the signing field. A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive. However, when using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

There are two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Warning schema

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage is successfully retrieved.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId"],"host":[""],"query":[],"variable":[{"id":"b9489a97-4bed-4c51-9277-d6d9587aaf75","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"384451d1-e3cf-4568-9155-e87e2311bce8","name":"Package was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Finished\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"InProgress\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n}"},{"id":"a554a20e-1b01-4253-a3f7-aba4256d2c14","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ed4ce737-186e-4c74-bb19-30a5e2edf7d4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d0ad26f7-f13f-49d0-83d6-641598bca21b"},{"name":"Deletes a package by id","id":"e39f6635-9959-478b-8b3a-b0932954d6e0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId?delayedDeletionTime=","description":"

Delete package by ID

\n

Description

\n

This call allows you to delete a package from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use the DELETE packages by ID call.

\n

Note: you can only delete a package that has status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package that must be deleted.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of this package will be deleted, once the package has been deleted. When this parameter is not sent, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictPackage could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId"],"host":[""],"query":[{"description":{"content":"

The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.

\n","type":"text/plain"},"key":"delayedDeletionTime","value":""}],"variable":[{"id":"6e1c09e0-6baa-4c69-93cc-c27fc762cdd9","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"569ab24b-61a4-4018-8aa9-7d487cd57afa","name":"Package was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"28dc96f9-d128-440f-ad91-c0507f07cc99","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ee0bb38f-c713-4377-aeb6-b33b197e9cf4","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1df3dc9c-66ae-4994-893e-a39eaf5c241c","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"79b08d5e-e0ee-4c4c-b5ea-85088d9eff78","name":"Package could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e39f6635-9959-478b-8b3a-b0932954d6e0"},{"name":"Gets a package's expiry date by","id":"20d9495d-5516-4a8c-93be-93a7791837b5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/expirydate","description":"

Get package expiry date

\n

Description

\n

This method allows you to retrieve the expiry date of a package.

\n

The only template parameter you need to use is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage expiry date was successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"5be91ff4-0258-4382-8160-f778ce2dee59","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"6ec359ce-7a35-4c1c-a0d2-65f7337eb713","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"b61be1bf-98e1-4454-87fe-f952a3e22c1b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"26016aa5-9247-437c-a4d4-fefffc088629","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"20d9495d-5516-4a8c-93be-93a7791837b5"},{"name":"Updates a package's expiry date","id":"acbda9ac-40c9-4a5e-a9da-26540a8a7e9b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/expirydate","description":"

Update package expiry date

\n

Description

\n

This call allows you to update the expiry date of a package. This way, you can make a document that was expired available again.

\n

The only template parameter you need is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to update.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage expiry date was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"a28a1aa6-35a5-4ea4-9084-8b582c231ac0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"9ecb7816-38c7-4280-8c39-db8c231f9d1c","name":"package's expiry date was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6b8b3fa3-04f3-402d-8c55-c9dec303db88","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"9f8befb2-aeaf-45f7-893f-6728cad31704","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a58eae39-8607-4797-b2b5-60db6fd3852a","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"fe9bbea4-68ec-46e0-aade-28f3e8130ae5","name":"Exiry date of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"acbda9ac-40c9-4a5e-a9da-26540a8a7e9b"},{"name":"Gets a package's status","id":"85ac379a-5a5f-44e5-bc5b-c1d5a7229c84","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/status","description":"

Get package status

\n

Description

\n

This method allows you to retrieve the status of a package.

\n

The only template parameter you need to use is packageId.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusThe possible values are: DraftActionNeeded, Draft, Pending, InProgress, Ending, Finished, Rejected, Revoked, Expired, Failed, Processing, ProcessingFailedString (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStatus was successfully retrieved.
401 UnauthorizedThe caller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"id":"f29cba5a-78b5-42fa-8eeb-8c9ace20ddaf","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"3a8ddc6b-8722-4dec-b95f-000149169fdf","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"85ac379a-5a5f-44e5-bc5b-c1d5a7229c84"},{"name":"Updates a package's status","id":"847e0b6a-170d-4a9b-afc7-21ab4d9e17a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/status","description":"

Update package status

\n

Description

\n

This call allows you to update the status of a package.

\n

Possible combinations:

\n
    \n
  • Draft to pending
    • \n
  • Pending to revoked
    • \n
\n

Draft to pending

\n

When the package is ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the package visible to each of the stakeholders in their Signer Portal. \n 

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been form filled/approved/signed yet, or packages of which the signing has failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status \n 

\n

HTTP Method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Status

Status to which the package must be updated. The possible values are:

- pending
- revoked.

Please note: the status parameter is part of the URL and must be omitted from the body, because you only need the value in the body, such as “pending”, and not the parameter, such as “status”:”pending”, which is the case for all other calls.

String (enum)
\n

\n

Example

\n
\"pending\"\n\n

\n

Response parameters

\n

None.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage status was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
409 ConflictPackage status could not be updated.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"id":"c7d3204a-19aa-495b-b189-3a91ada396a3","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"4eb58b21-82db-4fa0-a4c7-6a645814157d","name":"package's status was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"revoked\"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6cc7990f-be0c-4219-8389-44bd3234a76d","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"a2255bf2-06b7-4db7-b8dc-4684d866577a","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7ff23230-b4f1-4f59-a53e-a397c7bb6e2e","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"2fb85cde-44aa-4c4e-ab24-d77b7c8b0644","name":"Status of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"847e0b6a-170d-4a9b-afc7-21ab4d9e17a9"},{"name":"Updates a package's documents order indices","id":"2d307d11-8e38-41dd-9384-ca90b8a6ae51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/orderindices","description":"

API v4: Reorder documents in a package

\n

This call updates the order of the documents in a Draft package.  \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/orderindices \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Documents

The documents from the draft package you want to change in order.

Child parameters:

- DocumentId (String (Guid)).
- OrderIndex (Integer). The order of the document

Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe order of the documents has been updated.
400 Bad RequestCould not update the order.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not FoundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Package.InvalidStatus
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents","orderindices"],"host":[""],"query":[],"variable":[{"id":"d263391a-022d-48ad-be87-6f022375136d","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"2812a2ca-456b-4742-ad60-eb446c0ed2ba","name":"Order indices were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"92b524a6-bc2a-4aee-91b7-6ae3d5270a1e","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"969c7870-1854-4d46-b882-dcab2f7ef855","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f16f3837-cc12-4680-906a-c0461d3f36bf","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2d307d11-8e38-41dd-9384-ca90b8a6ae51"},{"name":"Gets a package's warnings","id":"e924c9e1-bd51-41d2-9805-74fb44be045b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/warnings","description":"

Get package warnings

\n

Description

\n

This call retrieves all warnings there might be about a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/warnings \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose warnings you want to retrieve.String (GUID)
\n

Response parameters

\n

The response is a list of warnings.

\n

Warning schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","warnings"],"host":[""],"query":[],"variable":[{"id":"15ed1b74-578e-44d2-b2e3-5307d215d0e1","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c5e5e27b-a330-4596-934e-1bc7754d12bf","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n]"},{"id":"6ca7ac16-c360-40d8-abae-94435b1cc516","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"91d89c08-543b-4a15-a391-673806162b8f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e924c9e1-bd51-41d2-9805-74fb44be045b"},{"name":"The actors in the current process step will be notified","id":"7bbec1c0-e9bc-4bce-9085-dd7f959a0898","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/reminders","description":"

Send reminders

\n

Description

\n

The POST reminders call sends a reminder to the actors of the current process step.

\n

Company policy might require that a document is handled within a given timespan. Doing a POST reminders call looks up all actors within the current process step who haven't form filled/approved/signed their document and sends them an extra notification as a reminder.

\n

Note that only the next available form filler(s)/approver(s)/signer(s) in the workflow are notified. This means form fillers/approvers/signers waiting for someone else to form fill/approve/sign first in a serial workflow will not receive a notification. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/reminders \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must receive a reminderString (GUID)
\n

Response parameters

\n

Empty response body \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe reminders have been sent.
404 Not foundThe package with the given id could not be found.
409 ConflictThe package did not have status Pending.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","reminders"],"host":[""],"query":[],"variable":[{"id":"bd922185-fee9-4707-af03-c6e738c1e61b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"15e2ae6f-7148-4518-bafe-c5dc973ffd17","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"56ab722a-2abe-4f26-a567-a629a02d5414","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"757d20db-a7b5-468d-9622-3dfacd04ebc4","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"f6bbe483-7bdb-41e0-834c-576ccf688791","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"7bbec1c0-e9bc-4bce-9085-dd7f959a0898"},{"name":"Approvers that are not finished yet will get the status Skipped","id":"3d6fbb16-e5b7-4cbe-8d98-1a476fc4b149","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipapprovers","description":"

API v4: Skip approvers

\n

A package that has been approved by at least one of multiple approvers can be sent to the signers by doing a Skip Approvers call. This call skips all approvers that haven’t approved yet and sets their status to “Skipped”, which results in the complete package being marked as “Pending”.

\n

This way, the package becomes available to the signers and it is no longer necessary to wait for all approvers to complete their task before anyone can sign.

\n

If the package was created with the SendNotifications parameter set to true, then all approvers will get a notification that the packages has been sent to the signers.

\n

Attention: when you skip approvers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipapprovers \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll approvers that hadn’t approved yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","skipapprovers"],"host":[""],"query":[],"variable":[{"id":"1dc92b55-8835-423a-86f4-3cad0ea6f58b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7f7334a0-2cfd-4114-961f-adb9cf679251","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b9f286bd-1da4-4722-b707-ebb5872fc516","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f79b5396-2187-4d8b-b7d3-a80ba006382c","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"45cf826b-061a-455b-9212-b01ffdb1c60d","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3d6fbb16-e5b7-4cbe-8d98-1a476fc4b149"},{"name":"Signers that are not finished yet will get the status Skipped","id":"2c294d9f-7be2-4f84-89d2-09dd57eec04c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipsigners","description":"

API v4: Skip signers

\n

Description

\n

A package that has been signed by at least one party, but still has some unsigned fields, that must be signed by others can now be finished by doing a Skip Signers call. This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”.

\n

This way, the package becomes available for download and it is no longer necessary to wait for all parties to sign before everyone can download the document.

\n

If the package was created with the SendNotifications parameter set to true, then all signers will get a notification that they can download the ended package.

\n

Attention: when you skip signers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipsigners \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
packageIdUnique Identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll signers that hadn’t signed yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
409Package.NotSigned:{packageId}
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","skipsigners"],"host":[""],"query":[],"variable":[{"id":"d7f0297c-cbb8-47fc-b846-e5ba5da7d138","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"629908ce-eee5-45c5-9837-a5a5d7084435","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"99d53bdf-eece-4c63-b86c-ce523f498f34","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7961d0df-3cee-4fbe-bf8e-ab3724b60802","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"fa6d0ed2-5cb4-48e9-a163-aa42f62aa4d1","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2c294d9f-7be2-4f84-89d2-09dd57eec04c"},{"name":"Creates template from given package","id":"0ac2c872-e9ad-4fee-9833-98446097edf0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/template","description":"

Create template

\n

Description

\n

This POST call saves a draft package as a template. Everything that defines the package, such as its documents and stakeholders, is saved as part of the template, enabling you to quickly create templates on the fly as part of an automated process through the API.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/template \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdThe unique identifier of the package that you want to save as a template.String (GUID)
\n

Request body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateNameThe name of the template, which must be unique in its document group.String (GUID)
\n

Response body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateCodeThe unique identifier created for the template.String (GUID)
\n

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","template"],"host":[""],"query":[],"variable":[{"id":"fcf0b93f-4921-4ba9-84d6-59d1d85e0a7f","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"18c741c5-18f5-4119-a1d3-a0eb2b1c0c34","name":"The template has been created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"TemplateCode\": \"\"\n}"},{"id":"7eb3c11d-ebcd-4eb2-a96c-ed5fa5f161a0","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3f3d2404-5d78-440e-9d33-f737389d6212","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"0ac2c872-e9ad-4fee-9833-98446097edf0"},{"name":"Used for downloading all documents in a certain package as a Zip file.","id":"61504556-439a-4f35-8c8c-9f5fcfc31390","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/:packageId/download","description":"

Download package

\n

Description

\n

This call retrieves all documents of a specified package as a .zip file.

\n

Note that only finished and archived packages can be downloaded. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose documents you want to download as .zip file.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","download"],"host":[""],"query":[],"variable":[{"id":"996a5b35-9a0c-479e-b0d7-07f755ef65b0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"42f1f12d-d7d7-4361-bcef-43f94200b872","name":"The package's contents in a zip file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/zip"}],"cookie":[],"responseTime":null,"body":""},{"id":"d5aa967f-8903-470b-bee5-df940e4c7698","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f38f8986-eb07-4af8-84de-9bc91ec66e3f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"8c0f0900-ec8d-4fe1-a04f-2933fedee036","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"61504556-439a-4f35-8c8c-9f5fcfc31390"},{"name":"Get all Actors for the specified person EmailAddress","id":"8e98370d-bca3-455c-b1bc-f7462fd610d5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","description":"

API v4: Get actors for a user

\n

This call retrieves all actors for a specific user email address. 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/actors \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
emailAddress*The email address from the user you want to filter on.String
(email)
PageNumberThe page to retrieve. The default value is 0.Integer
PageSizeMaximum number of records in the response Default value is 20.Integer
CreatedBeforeGets only the actors created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the actors created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, and failed.		String (enum)
type

The type of actors you want to filter on. 

Values are: Signer, Receiver, Approver, FormFiller

String
(enum)
SortDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. The default value is 20.Integer
TotalTotal number of items.Integer
ItemsThe actors that are retrieved. See the child parameters of this parameter.array of
Objects
\n

Items

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActorIdUnique identifier of the actorString
(GUID)
StakeholderIdUnique identifier of the stakeholderString
(GUID)
StatusThe status of the actor.
Values: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped		String
(GUID)
PackageIdUnique identifier of the package the actor is part ofString
(GUID)
PackageNameThe name from the packageString
CreationDateReturns the date the actor was created. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, failed.		String (enum)
type

The type of the actor. 

Values are: Signer, Receiver, Approver, FormFiller.

String
(enum)
InitiatorThe email address of an initiator who created the package.String (email)
Documents

All the documents this actor is assigned to.

Child parameters:

- Id (String (GUID))
- Name (String)

Array of Objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","actors"],"host":[""],"query":[{"description":{"content":"

(Required) The email address of the person

\n","type":"text/plain"},"key":"emailAddress","value":""},{"description":{"content":"

The status of actors to retrieve

\n","type":"text/plain"},"key":"status","value":"Finished"},{"description":{"content":"

The type of actors to retrieve

\n","type":"text/plain"},"key":"type","value":"Approver"},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"3a8bc375-9cb6-4bf7-880b-7e95b799956a","name":"List of actors across packages for given person.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"InProgress\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Receiver\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Available\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n }\n]"},{"id":"c0f0e199-4411-471b-a4ed-00f054562519","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4a93324d-def6-4397-a28e-cbdc336224e8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"8e98370d-bca3-455c-b1bc-f7462fd610d5"}],"id":"3b888a44-c5b8-4a63-bce8-c0fc9b063dc8","description":"

API v4: Packages

\n

What is a package?

\n

Packages lie at the core of eSignatures. A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

API calls for managing packages

\n

With API calls, you can do the following:

\n\n","_postman_id":"3b888a44-c5b8-4a63-bce8-c0fc9b063dc8","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Documents","item":[{"name":"Gets all documents of a package","id":"57260158-a3ab-4510-9a33-c8f24e382feb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents?status=","description":"

API v4: Get documents

\n

Description

\n

This call retrieves all documents that currently exist within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/ \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose documents must be retrieved.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll documents are successfully retrieved.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""}],"variable":[{"id":"94cb399e-8902-4094-9f51-a56f2c456bfe","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"19f567e8-38a9-431b-848a-489d9b7cfd83","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Ending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Pending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n]"},{"id":"eb8a1ee6-ecfd-4438-8495-86145b558bc8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"57260158-a3ab-4510-9a33-c8f24e382feb"},{"name":"Adds a document to a package","id":"3e94c3a1-ca67-409b-8e25-4eec40678e3d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n }, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=false","description":"

Add document to package synchronously

\n

Before you start | URL | HTTP method | MIME type | Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package. Once the status of a package is Draft, you can continue working on them. The asynchronous upload method offers extra parameters to keep existing signatures, form and signing fields. For more details, refer to API v4: Add document to package asynchronously.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n
 \n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
  • Parameters marked with an asterisk are required.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents \n 

\n

HTTP method

\n

POST \n 

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request parameters

\n

The parameters with an asterisk are mandatory.
​​​​​​​

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. See section 'PDF Error Handling' below for more info. Values:
-Ignore                    -DetectWarn
-DetectFail              -DetectFixWarn             -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. In the current version, an element can be a form field or signing field. The elements parameters are identical to those in the Create element call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail\n When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

​​​​​​​Before you start | URL | HTTP method ​​​​​​​| MIME type ​​​​​​​| Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"false"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"b36ac827-c96c-4398-9342-1b9e33aa82a6","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"1a5e5e9b-3c8b-4a09-9b14-eaafe9c00437","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"647b7602-016f-4074-af9f-b6cfc863d0be","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d2211090-6940-496b-bfc8-8cf52e040aaa","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8af67164-4daa-4e6a-aa6f-0048ea79b787","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ec5ebf19-bbbc-436d-809b-5d3c7f7225b6","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3e94c3a1-ca67-409b-8e25-4eec40678e3d"},{"name":"Adds a document to a package asynchronously","id":"c68881b5-b313-476a-a6fe-79e96da7cd73","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n },\r\n \"KeepSignatures\": false, \r\n \"KeepSigningFields\": false,\r\n \"KeepFormFields\": false, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=true","description":"

API v4: Add document to package asynchronously

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package and, once the status of a package is Draft, you can continue working on it.

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents?async=true

\n

HTTP method

\n

POST

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request and query parameters

\n

Parameters marked with an asterisk are required.

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
async*To use the asynchronous upload method, you must set this parameter to true.String
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
KeepSignaturesThis parameter is available from version 7.4.0 onwards.

Determines whether to keep the existing signatures of the document. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.
Boolean
KeepSigningFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.		Boolean
KeepFormFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepFormFields is set to true, you cannot set KeepSignatures to true.
Boolean
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. For more details, see the section PDF error handling details.

Values:
-Ignore -DetectWarn
-DetectFail -DetectFixWarn -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n

This call doesn't return any response parameters. Use the Get package by ID call to see the status of your package. Once the status is Draft, you can continue working on the package. For more details, refer to API v4: Get package by ID.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request or due to conflicting actions.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.ConflictingActions
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail
    When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

Before you start | URL | HTTP method | MIME type | Request and query parameters | Response parameters ​​​| Response codes​​​​​​​ ​​​​​​​| Error codes ​​​​​​​| PDF error handling details​​​​​​​

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"true"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"e9292f6a-e7f0-47de-a7e8-6d44edb62bcb","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"ad9f57a4-7575-4739-9770-7089a7f94838","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"0a08bde2-d285-4ab4-9f08-9e4d2f4987e3","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"090a3d6c-f10f-4a9f-a3bc-6392055bffde","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e6d6c5c7-8452-4d62-94e9-70259dd262a6","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"03ac06c0-63ef-4e99-8baa-3ce0ec74653b","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c68881b5-b313-476a-a6fe-79e96da7cd73"},{"name":"Gets a document by id","id":"8490373d-2562-4102-b7b0-2fb19820b377","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Get document by ID

\n

Description

\n

This call allows you to retrieve a document by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document you want to retrieve.String (GUID)
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
400 Bad requestRequest failed validation.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"057558b0-302f-4a07-acf8-c1744b001053","type":"any","value":"","key":"packageId"},{"id":"2f9be465-5903-43f3-a66d-ccb16d55248c","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"87af0bde-6b87-4969-aea9-dd542d1f9bd2","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"57cdef84-d331-4c2b-8ef2-058984e05668","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"cab6c3e7-1094-4c54-9682-5aa0cb3e4558","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3bec7f87-6577-4d71-a9f3-8aba4b2dcc99","name":"Target package or document could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"8490373d-2562-4102-b7b0-2fb19820b377"},{"name":"Deletes a document by id","id":"7a64ea36-853e-4543-8db0-9eca9bf70c88","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Delete document by ID

\n

Description

\n

This call allows you to delete a specified document from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document that must be deleted.String (GUID)
PackageId*Unique identifier of the package to which the document belongsString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentDocument was successfully deleted.
404 Not foundTarget package or document could not be found.
409 ConflictDocument could not be deleted.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"e6e62e6d-47e9-4d14-b024-54ea79901a8a","type":"any","value":"","key":"packageId"},{"id":"4803c397-76bf-458f-9c05-57e502746d8b","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"375022a8-42b3-4ce4-9b12-7f7e7dbc3904","name":"Document was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"31fb4ed8-6658-4b30-aa67-34b2ab27f3e4","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9b61449f-a944-4093-a3a1-59ccdb7aee89","name":"Target package or document with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"cbcd392b-1615-4c51-a09d-5b95e6460795","name":"Document could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"7a64ea36-853e-4543-8db0-9eca9bf70c88"},{"name":"Performs actions (keep/remove signatures, form fields, signing fields) on the not fully processed document.","id":"55ddc07f-9507-4c0e-8ec4-5d5b1ceef9c9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/actions","description":"

API v4: Perform actions on a not fully processed document

\n

Description

\n

Use this call to perform the following actions on a not fully processed document: keep and remove existing signatures, form and signing fields.

\n

For example, a document was uploaded via the Document Portal and it has existing signatures, form or signing fields. If you get the package containing this document by ID: \n 

\n
    \n
  • The IsActionNeeded parameter is set to true.
    • \n
  • Depending on the data that exists in the document, the following parameters are set to true: HasSigningFields, HasSignatures and HasFormFields.
    • \n
\n

You can use this API call to decide which data to keep so that the document is fully processed.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/actions \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package.String (GUID)
DocumentId*The unique identifier of the document.String (GUID)
\n

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
KeepSignaturesDetermines whether to keep the existing signatures of the document. The default value is false.Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.Boolean
KeepSigningFieldsIf it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.Boolean
KeepFormFields

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.

boolean
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No ContentDocument is put in Draft status
400 Bad requestBad request, Action could not be performed.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Document.ConflictingActions
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","actions"],"host":[""],"query":[],"variable":[{"id":"9a5bd2a9-d0ac-4031-bd76-cf0ef753fc29","type":"any","value":"","key":"packageId"},{"id":"4941f80f-6521-40f7-b814-3019d6f0dd3a","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"aed765be-0311-4418-82e3-5425afc95d49","name":"Document is in Draft status, no action required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"03438fd2-0825-462c-9c95-5cda33be6914","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"191b05bb-144f-49c2-a2f7-fc2845d0caf5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"34f36b13-ecf0-4ec9-8c5d-dd4fcb1d690e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"a5c8e21c-11c2-42a0-8a4d-bbd76587bc63","name":"Unable to perform actions on the document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"55ddc07f-9507-4c0e-8ec4-5d5b1ceef9c9"},{"name":"Download a signed document from a package.","id":"43bfefa5-1ff5-4629-bfd7-d6dcbbee5f00","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/download/:documentId","description":"

Download document

\n

Description

\n

This call downloads a specified document from a specified package as PDF or XML file.

\n

Note that you can only download documents from fully finished packages. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download/{documentId} \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package of which you want to download a document.String (GUID)
DocumentId*The unique identifier of the document you want to download.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document is successfully downloaded.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package /document could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"7820f9ba-4883-423d-91bd-1ec6bdad58e2","type":"any","value":"","key":"packageId"},{"id":"942d747e-f49e-4fb0-a55b-38e8fe5a15c9","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"9ee34c3a-33ae-45fd-b869-75da4ab33876","name":"The specified document in a pdf or xml file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"32338526-e4d7-4e06-a96e-6360cc3972d0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"193bead0-8a4f-475f-90b1-76aae82bea01","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"b91ebb49-2b55-49c3-8fca-90872bd510b3","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"43bfefa5-1ff5-4629-bfd7-d6dcbbee5f00"},{"name":"Gets a document by its index within a package","id":"4110801e-8ec5-4d59-a3f3-f49d9ddeea30","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:orderIndex","description":"

Get document by orderIndex

\n

Description

\n

This call allows you retrieve a document within a specified package based on its OrderIndex.

\n

The OrderIndex defines the order in which documents should be sorted within a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{orderIndex} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the target package.String (GUID)
OrderIndex*Order of the document within the package. Value must be positive.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":orderIndex"],"host":[""],"query":[],"variable":[{"id":"2299dc73-073b-41e3-8b82-acff55cf16d0","type":"any","value":"","key":"packageId"},{"id":"be9ca9b4-d441-43f7-be02-12f614449ffd","type":"any","value":"","key":"orderIndex"}]}},"response":[{"id":"a30415b5-93fc-4bc9-82b2-cb45e14b518e","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"86fe61fb-f450-4d05-a7db-735a5c558509","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e01470bf-9e64-45b9-8181-9c96fcdb691b","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"4110801e-8ec5-4d59-a3f3-f49d9ddeea30"}],"id":"adc200c2-e6a7-4b32-8136-181bc2e3e0df","description":"

API v4: Documents

\n

What is a document?

\n

A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder. Note that as of eSignatures 6.3, a document may also be marked as optional. In that case, the end user may choose not to sign it.

\n

A document may contain multiple elements. As of eSignatures 6.3, there are three types of elements: SigningField elements, CheckBoxField elements, TextBoxField elements and RadioGroup elements. \n 

\n

API calls for managing documents

\n\n","_postman_id":"adc200c2-e6a7-4b32-8136-181bc2e3e0df","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Elements","item":[{"name":"Gets the package elements editor url","id":"48796168-cb24-41a6-9e49-8b3070682bc9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","description":"

Get Package Elements Editor ActionUrl

\n

Description

\n

The GET element call retrieves a one-time ActionUrl that can be used by end-users to drag-n-drop (un)placed elements.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/elements/actionurl

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
RedirectUrlThe URL to call upon cancellation or confirmation.URL
LanguageThe Package Elements Editor language.String
IsIFrameShould the Package Elements Editor open in an IFrame.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlA one-time link that can be used by end-users to drag-n-drop (un)placed elements.URL
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe URL was created successfully.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","elements","actionurl"],"host":[""],"query":[{"description":{"content":"

Indicates whether the package elements editor opens in an iframe.

\n","type":"text/plain"},"key":"isIframe","value":""},{"description":{"content":"

The URL to call upon cancellation or confirmation.

\n","type":"text/plain"},"key":"redirectUrl","value":""},{"description":{"content":"

The package elements editor language.

\n","type":"text/plain"},"key":"language","value":""}],"variable":[{"id":"f89e4d8f-1c49-4b42-9872-29288d869ef8","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"305e39a8-4376-453d-9f37-17cbcedf8edd","name":"The package elements editor url was created","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"055f68bd-974d-485d-ba08-88ef7fa6ed25","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e5665109-2b0d-4f69-a950-185da562af4f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"b1c8d6eb-3932-440e-bbd1-633ced5fabc7","name":"Target package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"8dba42e7-f6fb-4f43-9b29-f3054f76bc9c","name":"Unable to create action url","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"48796168-cb24-41a6-9e49-8b3070682bc9"},{"name":"Gets a package's elements that are not placed yet","id":"4c96fe75-dba3-4566-80fd-c8d5dcc80ae9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements","description":"

Get unplaced elements

\n

Description

\n

This call retrieves all unplaced elements within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"30f475b3-a2a1-4cd8-beb3-2ce50ce9df7a","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"f86f449f-9613-412a-a501-df5416b5e858","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"887a5f47-e11f-4547-83d8-7b3a61ea369f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c0725cc2-79a5-4bb6-b113-01fc7197a50f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4c96fe75-dba3-4566-80fd-c8d5dcc80ae9"},{"name":"Creates unplaced elements for a package","id":"bf3f58a4-6a08-4224-876c-76404b1a71b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/unplacedElements","description":"

Create unplaced element

\n

Description

\n

The POST element call adds an element to an existing package. This section covers the unplaced element parameters.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Extra parameters are needed depending on the type of unplaced element. More details can be found on the designated page, listed below.

\n\n

\n

Response parameters

\n

The response parameters depend on the element type, see the references above for details.

\n

Response codes

\n

The response codes depend on the element type, see the references above for details.

\n

Error codes

\n

The error codes depend on the element type, see the references above for details.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"331caa61-f053-4946-ab62-1a9191c257be","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"63f33c45-67cb-4f33-a64c-92ea0c52e745","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"c76e6bd8-04bd-4986-8cc6-b9ec2db53b57","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"5215cf8e-f3f4-4c19-ab50-a88ad49164d2","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1f406ca5-2f99-4328-8115-612e209eaed5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"db1170e7-9f53-4b26-a106-d12b87a3e96d","name":"Unplaced elements could not be created for the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"bf3f58a4-6a08-4224-876c-76404b1a71b8"},{"name":"Gets a package's unplaced element","id":"7b5a93f3-0ad7-4892-b304-2a08749cdbdd","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Get unplaced elements by ID

\n

Description

\n

This call retrieves a specified unplaced element within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"d142081e-dc6a-4b34-a938-57d8ada8f7e7","type":"any","value":"","key":"packageId"},{"id":"a126ba19-66dc-4683-a291-d2ba6676007c","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"c0717bb3-9ccd-4715-8e3a-31b64554c676","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"1db32912-19dc-41a7-848e-324147212bfd","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"34ffb61d-2852-43d0-a32b-be9929546c87","name":"Target package or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"7b5a93f3-0ad7-4892-b304-2a08749cdbdd"},{"name":"Deletes a package's unplaced elements","id":"ca781194-42e9-40bd-ba07-cc6cd20c3b3b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Delete unplaced element by ID

\n

Description

\n

This call allows you to delete a specified unplaced element from a specified draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}//elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"6ecd33ce-9c27-4982-99bf-14e2b3a88e39","type":"any","value":"","key":"packageId"},{"id":"a523903a-8356-42f2-8c7e-371218df18af","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"165f6fe0-6880-45c2-ae31-a3a0aa0f4cc4","name":"UnplacedElement was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c2bc20bd-8695-4a4b-a0cb-4c7404823dfb","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e39c7d18-d8d8-446a-aa55-51f13c81760c","name":"Target package or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"fdce81df-a31e-4efa-893c-4b6e1e0bbff8","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"ca781194-42e9-40bd-ba07-cc6cd20c3b3b"},{"name":"Gets the elements on a document","id":"b9d03236-202f-4c7d-9f3b-e948ada32b39","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements","description":"

Get elements

\n

Description

\n

This call retrieves all elements within a specified document. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
DocumentId*Unique identifier of the document whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document id could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"0b800569-49b0-412c-b6f9-a7e7e7ba7362","type":"any","value":"","key":"packageId"},{"id":"3d52352b-f1d6-4652-8289-b740d39b8e4f","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"1d99f50a-24ab-4f09-bf74-64dacca5ca4b","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"f83e8fb1-111e-4e69-926e-a2cf57e9bbc0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"423a4f00-8683-428f-a934-c05168b588fd","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"b9d03236-202f-4c7d-9f3b-e948ada32b39"},{"name":"Creates a new SigningField element on a document","id":"36a098e6-4725-456c-bbaf-3f96134f42e6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Type\": \"\",\r\n \"ExternalReference\": \"\",\r\n \"Location\": {\r\n \"Page\": \"\",\r\n \"Left\": \"\",\r\n \"Top\": \"\"\r\n },\r\n \"Dimensions\": {\r\n \"Width\": \"\",\r\n \"Height\": \"\"\r\n },\r\n \"signingMethods\": [\r\n {\r\n \"Name\": \"\",\r\n \"KeyPair\": \"\"\r\n },\r\n \"\"\r\n ],\r\n \"LegalNotice\": \"\"\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateSigningField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the SigningField element parameters.

\n

A SigningField element can be created in four different ways:

\n\n

Important: A single document must not contain more than 30 signing fields.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a SigningField element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case SigningField element.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SigningMethodsThe SigningMethods that may be used to sign this signing field. Note: When using a single SigningMethod, it must also be placed in an array.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

LegalNotice

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive.

\n

When defining a LegalNotice, you can choose from two LegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000.String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LegalNotice1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

Note: When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable. \n 

\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 70. Maximum value is 999999_._Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons, it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains the location and dimensions of the element. Pattern: #[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat DC for instance), and you want to convert those input fields into signing fields.

\n

Attention: For performance reasons, it's recommended to do this at document upload time. It may happen that after a document conversion the field with the given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Invisible Signing Fields

\n

When the SigningMethod parameter is set to server signing for all signers, it is possible to sign the document without adding a visible signing field. In this case, the PDF will be signed, and the signature can be checked but it will not be visible on the document.

\n

To leave the visible signing field out, the following parameters must be omitted:

\n
    \n
  • Location
    • \n
  • Dimensions
    • \n
  • FieldId
    • \n
  • Marker
    • \n
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
401Authentication failed, username or password incorrect
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409Element.FieldIdNotUnique
409Package.InvalidStatus
409Document.NotFoundInPackage
409SigningField.InvalidPage
409LegalNotice.NotFound
409SigningField.MarkerOrFieldIdNotFound
409SigningField.MultipleMarkersFound
409SigningField.MarkerAlreadySigned
409SigningField.InvalidWidthMarker
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"92bbac6c-92fb-4d4e-99a0-42d1b2f852ac","type":"any","value":"","key":"packageId"},{"id":"d6cd0d90-a1f6-4bd4-8c70-cf69d4086d11","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"0a9e7658-9751-46e8-a7d1-cc1a8f147098","name":"New element was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created element","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"a993beab-507f-4e81-ab85-0932af641d1f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"667a6a6e-0553-461a-a6a6-0b1e774372d6","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"029774ac-d6cb-4001-ab65-2a49bd206879","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"835bca5f-53d3-4eaf-8545-44ebfc8ce8e6","name":"element could not be added","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"36a098e6-4725-456c-bbaf-3f96134f42e6"},{"name":"Creates a new TextBoxField element on a document","id":"d5a5984e-1722-4964-9926-5c2d1485b14a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"textBoxField\",\n \"Marker\": \"TXT01\",\n \"Name\": \"\",\n \"externalReference\": \"\",\n \"DefaultValue\": \"\",\n \"ToolTipLabel\": \"\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateTextBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the TextBoxField element parameters.

\n

A TextBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a TextBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a TextBoxField element.

\n

Important: The parameters Name, IsMultiline and CharLimit must only be used to create TextBoxField elements using element location and element dimensions. As of eSignatures 6.8.0, it is also possible to use these parameters when creating TextBoxField elements with markers. They must not be used when creating TextBoxField elements when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of TextBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case TextBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the TextFieldBox is mandatory or optional. When set to true, the text field is mandatory. The default value is false. Note: If you're sending a document that already contains a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDefault value prefilled in the TextBoxField. Note: If you're sending a document that already contains a prefilled form field and enter a DefaultValue parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the DefaultValue parameter must be null.String
IsMultiLineDetermines whether the TextBoxField has multiple lines. Default value is false. Wen set to true, the TextBoxField will be scrollable.Boolean
CharLimitDetermines the maximum number of characters that may be entered in the TextBoxField.Integer
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat Pro for instance), and when you want to show those input fields as textbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case TextBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the TextFieldBox is mandatory or optional.Boolean
DefaultValueDefault value prefilled in the TextBoxField.String
IsMultiLineWhether the TextBoxField has multiple lines.Boolean
CharLimitMaximum number of characters that may be entered in the TextBoxField.Integer
ValueValue of the completed TextBoxField.String
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n    \"type\": \"textBoxField\",\n    \"name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"100\",\n        \"top\": \"50\"\n    },\n    \"dimensions\": {\n        \"width\": \"150\",\n        \"height\": \"50\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"textboxfield\",\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"Value\": null,\n    \"Name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"Id\": \"54e6d471-17ad-44e0-9798-b27c04da13d4\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 50.0,\n        \"Left\": 100.0\n    },\n    \"Dimensions\": {\n        \"Width\": 150.0,\n        \"Height\": 50.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
400TextBoxField.InvalidCharLimit
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"cfce0942-4f96-4f7c-b80e-b35b7785edd0","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"fd7c23cb-7691-472b-aea7-b7b2a585c215","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ebce128e-2bfc-4aab-a54a-5021ce23ace4","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"4856ee6b-a770-47a5-bdf2-c1270e87185e","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"e5356188-6805-4be1-9087-225c44a8f14d","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d5a5984e-1722-4964-9926-5c2d1485b14a"},{"name":"Creates a new CheckBoxField element on a document","id":"9ae90df3-6089-4fe3-8f4d-5f25e4d65532","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"checkBoxField\",\n \"Marker\": \"CHK01\",\n \"Name\": \"Checkbox1\",\n \"Type\": \"checkboxfield\",\n \"DefaultValue\": false,\n \"ToolTipLabel\": \"Check Me\",\n \"externalReference\": \"Checkbox1\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateCheckBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the CheckBoxField element parameters.

\n

A CheckBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a CheckBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a CheckBoxField element.

\n

Important: The Name parameter must only be used to create CheckBoxField elements using element location and element dimensions. It must not be used when creating CheckBoxField elements using markers, or when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of CheckBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case CheckBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the checkbox is mandatory or optional. When set to true, the checkbox is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDetermines whether the checkbox is checked or unchecked by default. When set to true, the checkbox is checked. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the DefaultValue parameter is set to false. Otherwise the original value will be overwritten.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used documents that already contain input fields (created in Adobe Acrobat Pro for instance), and you want to show those input fields as checkbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case CheckBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the checkbox is mandatory or optional.Boolean
DefaultValueWhether the checkbox is by default checked or unchecked.Boolean
CheckedThe value of the completed checkbox field.Boolean
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
 {\n    \"type\": \"checkBoxField\",\n    \"name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"DefaultValue\": false,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"300\",\n        \"top\": \"230\"\n    },\n    \"dimensions\": {\n        \"width\": \"12\",\n        \"height\": \"12\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"checkboxfield\",\n    \"DefaultValue\": false,\n    \"Checked\": false,\n    \"Name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"Id\": \"c4577ad0-fcca-43b3-bb39-465c6e0a27f5\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 230.0,\n        \"Left\": 300.0\n    },\n    \"Dimensions\": {\n        \"Width\": 12.0,\n        \"Height\": 12.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"36a3bd46-2ee8-4738-8ea1-95a7f22565ab","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"23e00da1-e135-4d6b-be17-f1125f4f1d4f","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"84e0ad14-620d-4592-8295-8e0f0d1d1f6e","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"de37c70e-2416-483f-993a-4ae40a152918","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"10793d3f-9cac-408c-8687-24eb51dab2fb","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"9ae90df3-6089-4fe3-8f4d-5f25e4d65532"},{"name":"Creates a new RadioGroup element on a document","id":"59ce0558-daf7-4dc3-b81f-62e9c1157627","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"RadioGroup\",\n \"name\": \"\",\n \"Label\": \"\",\n \"Options\": [\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 233.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 293.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 263.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n }\n ],\n \"ToolTipLabel\": \"\",\n \"IsRequired\": true,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

Create RadioGroup element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the RadioGroup element parameters. A RadioGroup may contain multiple RadioGroup buttons.

\n

A RadioGroup element can be created in different ways: either the RadioGroup was already added to the document(s) you're sending, via an application such as Adobe Pro DC, or you create it using the eSignatures API.

\n

If the RadioGroup already exists, you must use the FieldId parameter

\n

If the RadioGroup is to be created through API, you need to add RadioGroupOptions to the RadioGroup. A RadioGroupOption represents a single radio button within a RadioGroup. RadioGroupOptions can be created by using specific dimensions and a specific location.

\n

Note that the different ways of creating a RadioGroup element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a RadioGroup element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case RadioGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document. Important: The Name parameter must not be used when specifying an existing RadioGroup (created in Adobe Pro DC for instance) by means of the FieldId parameter.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the RadioGroup is mandatory or optional. When set to true, the RadioGroup is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
\n

CreateRadioOption

\n

A RadioOption represents a single radio button within a RadioGroup.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name/choice of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedDetermines whether the radio button is selected by default.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

RadioGroup with field identifier

\n

The FieldId parameter must only be used if the documents you're sending already contain radio buttons (created in Adobe Pro DC for instance), and you want those radio buttons to be kept.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
Type*Type of element that was created. In this case RadioGroup.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the RadioGroup is mandatory or optional.Boolean
SelectedThe name of the selected RadioOption.String
OptionsThe RadioOptions (i.e. the different radio buttons within the group)Object
\n

RadioOption

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedWhether the radio button is selected.Boolean
LocationLocation of the radio button within the document.Object
DimensionsDimensions of the radio button.Object
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n\"type\": \"RadioGroup\",\n\"name\": \"Radio group\",\n\"Options\": [\n    {\n        \"Name\": \"one\",\n        \"ToolTipLabel\": \"RadioGroup one tooltip\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"ToolTipLabel\": \"RadioGroup two tooltip\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"three\",\n        \"ToolTipLabel\": \"RadioGroup three tooltip\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"documentIndex\": 0\n},\n\n

Example response

\n
{\n\"Type\": \"radiogroup\",\n\"Selected\": \"one\",\n\"Options\": [\n    {\n        \"Name\": \"three\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"one\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": true,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"Name\": \"Radio group\",\n\"Label\": null,\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"Id\": \"035aec8f-a559-43ce-8fd7-f91ddd51f68f\",\n\"ActorId\": \"87fad4ea-d39d-435b-94fe-48072fd5a15f\",\n\"Location\": null,\n\"Dimensions\": null,\n\"Status\": \"Pending\",\n\"ExternalReference\": null,\n\"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"45d230bd-1860-434f-bd9e-c8d14b7e6685","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"88343237-222f-4960-befc-b385c68cd511","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"aa751bd9-9bad-47c9-a23b-df634a7d0f9c","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"021d07c3-866f-4262-b7ec-46b2d58a9e86","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"782d6187-bc35-4ae9-8c45-d72f1b063af3","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"59ce0558-daf7-4dc3-b81f-62e9c1157627"},{"name":"Gets an element by id","id":"fc34e0c9-0ad0-47d2-b82e-a16646d70a62","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Get element by ID

\n

Description

\n

This call allows you to retrieve an element by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKElement is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"892f2dec-a2c6-404f-8e07-bedcecca5d0e","type":"any","value":"","key":"packageId"},{"id":"19849e73-2ad6-4a8f-9364-0542ebb432f5","type":"any","value":"","key":"documentId"},{"id":"3e48cc9b-4261-493a-9394-ad4eb052683e","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"90eb9271-2e44-4c22-a453-98245c53ec4b","name":"elements was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"97a22f25-3cdf-40c2-b896-bab544806a8c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4978c30a-d3c4-433e-be91-f084ac5bfc81","name":"Target package, document or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"fc34e0c9-0ad0-47d2-b82e-a16646d70a62"},{"name":"Deletes an element by id","id":"6819d16e-fcd9-4b70-b083-1f09ddaa816f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Delete element by ID

\n

Description

\n

This call allows you to delete a specified element from a specified document of a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"593ceb83-3519-4e4a-b7f9-914ad1edb19d","type":"any","value":"","key":"packageId"},{"id":"d2102585-26e7-4146-a463-6222d717291e","type":"any","value":"","key":"documentId"},{"id":"9caaad5c-cfbd-4b3b-94fc-455cff5ee126","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"c3ee12ec-3b3f-4fb5-a73c-96fc89c72eeb","name":"Element was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"16ad9fee-4114-49a2-9040-25154e940038","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fa858adb-62e5-4b71-b4d2-9d0dd43ec0ad","name":"Target package, document or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"b3a9b080-e427-48f9-a0db-c738cefada03","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"6819d16e-fcd9-4b70-b083-1f09ddaa816f"}],"id":"8916b975-40e5-432e-b92d-cf4a7a59f43e","description":"

Elements

\n

The Elements collection contains all resources and methods for creating and managing elements. \n 

\n

What is an element?

\n

An element is an item that is placed on a document and may be assigned to an actor.

\n

An element cannot exist on its own, it is always part of a document.

\n

Currently, four types of elements can be added to a document:

\n
    \n
  • SigningField elements
    • \n
  • TextBoxField elements
    • \n
  • CheckBoxField elements
    • \n
  • RadioGroup elements
    • \n
\n
 \n

SigningField elements determine where on the document a signature must be placed. SigningFields are always mandatory. \n 

\n

TextBoxField elements determine where on the document a textbox field will be placed. A textbox may contain a default, prefilled value, which can be modified afterwards by the end user. A textbox may be mandatory or optional. \n 

\n

CheckBoxField elements determine where on the document a checkbox field will be placed. A checkbox may be already checked by default, but can still be modified by the end user. Like textboxes, checkboxes may also be mandatory or optional. \n 

\n

RadioGroup elements determine where on the document a radio group will be placed. A radio button may be already checked by default, but can still be modified by the end user. Radio groups may also be mandatory or optional. \n 

\n

Element methods

\n\n","_postman_id":"8916b975-40e5-432e-b92d-cf4a7a59f43e","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Stakeholders","item":[{"name":"Gets all stakeholders of a package","id":"4f8f04d0-904f-4d38-8686-c1699110161d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders","description":"

Get stakeholders

\n

Description

\n

This call retrieves all stakeholders that currently exist within a specified package.

\n

The results are ordered by date on which the stakeholders were added to the package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

GET \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose stakeholders you want to retrieve.String (GUID)
\n

\n

Response parameters

\n

The response parameters are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll stakeholders are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"ff8d146c-7a9d-4c11-9429-7e220dd358e0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"9d93c6d4-e190-4ab5-8dc3-22838b401c6e","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n]"},{"id":"364da524-35b1-4493-a81e-8b71c29daebf","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"cdbda2ad-36ee-4307-9e90-7b083356d36b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4f8f04d0-904f-4d38-8686-c1699110161d"},{"name":"Adds a stakeholder to a package","id":"da911526-6cdb-415d-b013-308c0e9012da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"person\",\n \"Language\": \"en\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"BirthDate\": \"\",\n \"PhoneNumber\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders","description":"

Create stakeholder

\n

Description

\n

The POST stakeholders call creates a stakeholder and adds it to a specified package.

\n

A stakeholder is an entity that has an interest in a package.

\n

Three types of stakeholders can be created:

\n
    \n
  • a person stakeholder
    • \n
  • a group stakeholder
    • \n
  • a contactGroup stakeholder
    • \n
\n

A person stakeholder is a single person. Only that person will be able to take action on the package.

\n

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. Each person of the group will receive a unique URL to form fill/approve/sign their document.
Attention: as soon as one member of the group has taken action, the others no longer can.

\n

A contactGroup stakeholder can be used when a contact group has been created in the eSignatures WebPortal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the WebPortal instead of defining each member in the call.
Note: the stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder will be added.string (GUID)
\n

Request parameters

\n

Actor parameters

\n

The Actor parameters are identical to those of the Create actor call and are described here. \n 

\n

Create Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created. Supported values: person, group and contactGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
Language*UI language of this stakeholder, expressed in a 2 letter ISO 639-1 code. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastName*Last name of the stakeholder Maximum length: 150String
EmailAddress*Email addressString (email)
BirthDate*Date of birth in format: YYYY-MM-DD Note: activating mandated signer validation in the Config Index might make this parameter required.String (date)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
\n

Create Group stakeholder

\n

Note that iDIN signing currently doesn't support Group stakeholders.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupName*Name of the group Maximum length: 128String
Members*Members that must be added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCode*Code that was generated when creating a contact group in the eSignatures WebPortal.String
\n

Response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe stakeholder was created successfully.
400 Bad requestRequest validation failed. The stakeholder could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictStakeholder could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"eaf858a3-57cc-4d86-8cbf-396411d35f51","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c47532a2-2683-4c4d-bacc-f58eca857466","name":"Stakeholder was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created stakeholder","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"e1c6c9ba-a7c6-4116-ade8-c8e693355276","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"22708c55-011c-431e-a71e-5db5c5a3935a","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d78d249d-f2e5-4ebd-8297-12b1b1fdbb0e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"1cbde02f-ae37-4f0b-9ede-615586890119","name":"Stakeholder could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"da911526-6cdb-415d-b013-308c0e9012da"},{"name":"Gets a stakeholder by id","id":"8a832287-ae7c-4e68-bded-1c5e7f8d503e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Get stakeholder by ID

\n

Description

\n

This call allows you to retrieve a stakeholder by its ID.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to retrieve.String (GUID)
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

GET \n 

\n

Response parameters

\n

The response parameter are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStakeholder is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b081d3a4-c04b-411a-9f64-37b846ddd6ef","type":"any","value":"","key":"packageId"},{"id":"8ac7398f-4211-4038-9d58-38b26c2b3cb8","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"9c118d27-502e-4199-add8-c004b3ec7f74","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"d86016e6-3c0d-4fe0-bc6f-7577c21647e0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4a074b89-e078-4f49-85ff-27ea76ed21b0","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"8a832287-ae7c-4e68-bded-1c5e7f8d503e"},{"name":"Deletes a stakeholder by id","id":"f40e98f2-c083-4083-a629-b2ea226c15df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Delete stakeholder by ID

\n

Description

\n

This call allows you to delete a specified stakeholder from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentStakeholder was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
409 ConflictStakeholder could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
409Stakeholder.CannotRemoveUndecided
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b725df35-5d70-4cb1-9d4a-86f72a30070d","type":"any","value":"","key":"packageId"},{"id":"16c34cea-4070-41fe-8e71-4658f664a4fa","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"5fb76670-a684-4d81-be0f-ccbe53c82bb9","name":"stakeholder was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"32967610-0ccb-49ba-9595-2a9b5c4d38a3","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"87696a7a-88a0-4d51-98f3-6143f0b2d34d","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"8d3e96ec-c96e-47ca-8d63-2dce886f004a","name":"Stakeholder could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"f40e98f2-c083-4083-a629-b2ea226c15df"}],"id":"b3ed050a-c152-44a6-b70b-bcdf4b4a62b6","description":"

Stakeholders

\n

The Stakeholders collection contains all resources and methods for creating and managing stakeholders. \n 

\n

What is a stakeholder?

\n

A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must take. For instance, fill out forms, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. \n 

\n

Stakeholder methods

\n\n","_postman_id":"b3ed050a-c152-44a6-b70b-bcdf4b4a62b6","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Actors","item":[{"name":"Gets a stakeholder's actors","id":"c51e0782-a299-4d1f-bcde-3d5e67324128","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Get actors

\n

Description

\n

This call retrieves all actors of a specified stakeholder. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors \n 

\n

HTTP method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors you want to retrieve.String (GUID)
StakeholderId*Unique identifier of the stakeholder whose actors you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actors are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"80c7390c-5530-4da3-ab49-53106f15161f","type":"any","value":"","key":"packageId"},{"id":"a62e66cd-4252-46c0-8c62-b70ecbf46417","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"04568af0-8be6-45b8-b6fb-a4ca7e261700","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"dba6dad6-25e5-4d5d-a622-745b962ac473","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"06946380-348e-4750-9660-0a226b273491","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"c51e0782-a299-4d1f-bcde-3d5e67324128"},{"name":"Creates an actor for a stakeholder","id":"422515a7-ee1f-49a3-a71e-b8331514d36e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Create actor

\n

Description

\n

The POST actors call creates an actor and adds it to the stakeholder you specify.

\n

An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are:

\n
    \n

  • FormFiller (as of eSignatures 6.3)
    A FormFiller must fill in TextBoxFields, CheckBoxFields and/or RadioGroups on a document. FormFiller actors do not sign or approve documents.

    \n
    • \n

  • Approver
    An Approver must approve the document before it is sent to any signer.
    Note that the approval may occur before or after the filling of forms.

    \n
    • \n

  • Signer
    A Signer must sign the document.

    \n
    • \n

  • Receiver
    A Receiver receives a a copy of the document when it has been signed by all signers. A Receiver does not take action on the document.

    \n
    • \n
\n

Important:

\n
    \n

  • All FormFillers/Approvers must be added to the first step of the process. This is because they must first take action on a package before it is sent to any signers. All receivers must be added to the last step of the process, since a package is only sent to receivers once it has been signed by all signers.

    \n
    • \n

  • If you do not define the process steps manually, all FormFiller actors are also added to the first step, together with the Approvers. As a result, the approval action may happen before, during or after the filling of forms.

    \n
    • \n
\n

Attention: All other process steps may only contain one type of actor. It's not supported to mix actor types, with the exception of FormFillers and Approvers, within an array.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor must be added.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor must be added.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. TextBoxField, CheckBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. Currently, four element types are supported: SigningField, TextBoxField, CheckBoxField and RadioGroup. This parameter does not apply to Receivers, since this actor type does not take action on documents. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action.
See the RedirectUrl Details section below for more information.		String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
CompletedDateDate when the action was completed.String (date-time)
SigningMethodSigning method the actor used to sign the document. This parameter only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was created
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or stakeholder could not be found
409 ConflictActor could not be added to the stakeholder
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400Actor.TypeCantHaveFormFields
400Actor.InvalidOrder
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. ActorId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592<;

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"a04ef99b-37ce-437b-af82-23306c060898","type":"any","value":"","key":"packageId"},{"id":"a5bb2a38-4009-4a83-b776-0499ca4cf998","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"cd6c14db-83e1-4078-9479-3508dc1e1e75","name":"Actor was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"4527f8a4-8d2c-4531-86ae-5bd940c3b3b4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ab005867-8846-4db8-8cf3-f8ca2c6df818","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9159de9c-641a-4f39-b691-ec0df06ce694","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"ed037cd2-abdf-4670-b479-b9abbca18698","name":"Actor could not be added to the stakeholder","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"422515a7-ee1f-49a3-a71e-b8331514d36e"},{"name":"Gets an actor by id","id":"237c8a66-94e3-4db7-aff4-e8fcfbd384f1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Get actor by ID

\n

Description

\n

This call allows you to retrieve an actor by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to retrieve.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKActor is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
404Actor.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"410162f5-7175-495d-9371-a602ba1c0d79","type":"any","value":"","key":"packageId"},{"id":"b7ede867-a3cc-4e33-8b2a-7e71927b9ce4","type":"any","value":"","key":"stakeholderId"},{"id":"56c018c4-bb52-4abc-9e66-66bfbfe4c88f","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"dae12462-59dc-4908-9731-c596a95d4945","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"ee671576-7fa0-487b-89ec-6175edbd213f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7ecb7b5f-9e6a-4581-aca8-6aaa483da3c5","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"237c8a66-94e3-4db7-aff4-e8fcfbd384f1"},{"name":"Deletes an actor by id","id":"97f9bf5b-b53c-478c-b0f3-d210084ad674","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Delete actor by ID

\n

Description

\n

This call allows you to delete a specified actor from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentActor was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
409 ConflictActor could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
404Actor.NotFound
409Actor.CannotRemoveUndecided
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"02c1160f-3597-4ce5-9267-8dfc254341b4","type":"any","value":"","key":"packageId"},{"id":"b41a3677-e93c-4815-bdb4-216756910dd6","type":"any","value":"","key":"stakeholderId"},{"id":"a5f66176-39cc-46cc-9a02-c8232126a69d","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"794ecc2e-0dd2-468b-b1c0-da7df198f241","name":"Actor was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"360ad674-5fbd-4080-b503-ee30a379aa1c","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7f05047e-094d-4046-ae70-f890755d498e","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"9d6295e1-71e5-4dc7-b97d-8e7000244186","name":"Actor could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"97f9bf5b-b53c-478c-b0f3-d210084ad674"},{"name":"Actors Reassign Actor","id":"81b0ac55-9f48-40a2-9042-39a4a5d43b85","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","description":"

Reassign actor

\n

Description

\n

The POST reassign actor call reassigns an actor from the package towards a new actor .

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId}/reassign

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
actorId*Unique identifier of the actor which needs to be reassinged.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of AdditionalProperties. AdditionalProperties is only needed when reassigning a signing actor that has mandated signing and needs extra data therefore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Stakeholder*The stakeholder the actor needs to be reassigned too.Object
Type*Type of stakeholder that must be created. When reassigning the only supported value is personString
(enum)
FirstName*First name of the stakeholder, Maximum length: 150String
LastName*Last name of the stakeholder, Maximum length: 150String
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length 256.String
EmailAddress*Email address.String (email)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
ReassignmentReason*The reason behind this reassignmentString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was reassigned
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package, stakeholder or actor could not be found
409 ConflictActor could not be reassigned
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
409MandatedSigner.MissingRequiredProperty
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"host":[""],"query":[],"variable":[{"id":"b382298f-c060-4c46-ba62-9aa90bcdb0c7","type":"any","value":"","key":"packageId"},{"id":"8500e907-53dc-427e-abfd-04a3dbfaff78","type":"any","value":"","key":"stakeholderId"},{"id":"8c0cff7a-df85-4423-a7b1-d70934e61d62","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"5de06104-4e90-430f-8b3a-568efa569571","name":"Actor was reassigned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Person\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"}],"_postman_id":"81b0ac55-9f48-40a2-9042-39a4a5d43b85"}],"id":"bdba477f-249f-4feb-97ca-74f577f4ca42","description":"

Actors

\n

The Actors collection contains all resources and methods for creating and managing actors.

\n

What is an actor?

\n

An actor is a single action a stakeholder needs to take on a package.

\n

There are four types of actors: form fillers, approvers, signers and receivers.

\n

Actor methods

\n\n","_postman_id":"bdba477f-249f-4feb-97ca-74f577f4ca42","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Process","item":[{"name":"All process steps","id":"e82d5391-a467-4f18-8d55-3fc36844d60e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process","description":"

Get all process steps

\n

Description

\n

This call retrieves all actions that must be done on a specified package.

\n

The actions are displayed in a 2D array where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process steps you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"494c8e84-52c8-4683-9b6d-ceb2af2ad93b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"feee16b6-8b48-4644-b6ef-be5c9014bdb4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ]\n]"},{"id":"c2b037ff-f8dd-4463-b2da-c4338bacc6ee","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bd691a87-90b9-4a36-8a55-7b5e64477f3c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e82d5391-a467-4f18-8d55-3fc36844d60e"},{"name":"Adds a step in the package's process","id":"11b0d8b1-4eda-4ecc-9945-4cc30c7c698a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Add process step

\n

Description

\n

This call adds a process step to a package's process. A process step consists of an array of actors.

\n

Please note: It's not supported to mix different actor types, with the exception of FormFillers and Approvers, within the same process step.

\n

The approval and form filling flow(s) need to proceed the signing flow. This limitation is in place since adding approval and/or form filling data to the source file is regarded as making changes to the source file. Adding approval and/or form filling data after signatures are placed will consequently render the electronic signature invalid.

\n

After the approval and form filling flow, all signing flows (sequential, parallel, mixed) need to be completed before the final (receiver) step.

\n

The receiver flow is always parallel.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process

\n

HTTP method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderId*Unique identifier of the stakeholder.String (GUID)
\n

The Request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. CheckBoxField, TextBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. See the RedirectUrl section below for more details.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderIdThe stakeholder's unique identifier.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: approver, formfiller signer and receiver.String (enum)
StatusStatus of an action. Available statuses are: draft, waiting, available, inProgress, failed, finished, rejected, kipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor will is linked. This parameter only applies to signers and formfillers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to receivers.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service.String
CompletedDateDate when the action was completed.String (date-time)
IdentityIdentity date returned when signer used eID or OpenID Connect to sign.TBD
SigningMethodSigning method the actor used to sign the document. Only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.Array of objects
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedProcess step was successfully created.
401 UnauthorizedCaller is unauthorized to do this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. ActorId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED,* REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"329f46b8-f1ac-4285-aa91-c6dba732bf80","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1f5e5834-fe7e-41f1-9e69-1e4167d3fe49","name":"Process step was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created process step","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"65185fea-def5-4d67-8e25-527ff52f41d9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7c0460c8-9d92-45df-9bc8-f6d7dac6ce53","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"11b0d8b1-4eda-4ecc-9945-4cc30c7c698a"},{"name":"Overwrites process steps of a package","id":"c846247d-d7d8-45c6-8a6d-9947c46b491e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Approver\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Update process steps

\n

Description

\n

This call overwrites all actors in a package using a 2D array, where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

HTTP method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must be updated.String (GUID)
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess steps were updated successfully.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"8cb6a632-0eb4-4604-986c-692e96418687","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1ab08955-eefe-4c1a-b469-4c7961417fef","name":"Process steps were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f2a5e36d-5702-4fb5-a4b7-a0460df677dc","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e41d483f-2eaf-4100-9427-2176053abfde","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c846247d-d7d8-45c6-8a6d-9947c46b491e"},{"name":"Gets all actions of a process step","id":"337e5db1-afa5-4d7f-bd97-12e77d878c89","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Get process step actions

\n

Description

\n

This call gets a particular set of actions that can be completed in parallel from any specific process step

\n

The process step of which the actions must be retrieved is specified by the StepIndex parameter. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
StepIndex*Index of the process step that must be retrieved.Integer
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"38817477-c2d7-4caa-a767-edf3f3362c37","type":"any","value":"","key":"packageId"},{"id":"2c62af68-b0c6-4dca-81c2-8a5bba117de5","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"5e994e35-d414-4b89-959b-73277addcd05","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"b2277b03-ce71-42e5-8bc0-3c0eceea17b3","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"187cb6e2-140e-4b95-8885-016de90c11e7","name":"package or process step could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"337e5db1-afa5-4d7f-bd97-12e77d878c89"},{"name":"Deletes a process step and all its actors","id":"c8eb3efc-2c38-4bd5-889f-65a082cd193a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Delete process step and its actions

\n

This call allows you to delete a process step and its actions from a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process step must be deleted.String (GUID)
StepIndex*Index of the process step that must be deleted.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess step was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or process step could not be found.
409 ConflictProcess step could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Actor.NotFound
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"69e99bbe-c957-4f95-8a5e-fd1f3c333762","type":"any","value":"","key":"packageId"},{"id":"ddf8c92e-0471-41ab-84ab-08154e81498e","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"f8e7c1d8-32a1-423a-a839-f9c872af2017","name":"Process step was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"68e4e575-3498-4d8f-84c0-def203d6da45","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"aa615486-9b2a-4b8a-802f-1d2d8adbe30f","name":"package or process step could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"31daf0bb-4ef1-40ec-94b1-70aa6a974ee9","name":"Process step could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c8eb3efc-2c38-4bd5-889f-65a082cd193a"},{"name":"Adds an actor to a process step","id":"f7f090c2-11b4-461b-b993-ce781089a350","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process/:stepIndex","description":"

Add process step action

\n

Description

\n

This call adds an actor to a process step, by means of StepIndex. The StepIndex indicates at which step of the process the action must be done. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
StepIndex*Step at which the action must be done.Integer
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response parameters

\n

The response parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedActor was successfully added to the process step
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or process step could not be found
409 ConflictActor could not be added to the process step
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
400Actor.InvalidOrder
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
404FormField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"bbffb313-54b1-4fac-9424-3d8a041e8372","type":"any","value":"","key":"packageId"},{"id":"4359cfc6-4a75-470c-9f3d-3599f4da1358","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"06fcfb54-7453-48f1-8546-122e204704e5","name":"Actor was added to the process step. The location header points to the location of the created actor under its stakeholder.\n","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor (under its stakeholder)","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"db368038-4c7d-43b4-9559-3dd73794664e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"eec32896-9775-4caf-b297-036700d8f0d0","name":"package or process step could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"65fd6226-fe96-46b7-bb17-a81e2978b76f","name":"Actor could not be added to the process step","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"f7f090c2-11b4-461b-b993-ce781089a350"},{"name":"Gets all actions the current process step","id":"d4de50cf-9987-445e-984a-a323985eec59","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/current","description":"

Get process step actions of current process step

\n

Description

\n

This call gets all actions that can be completed in parallel of the current process step, i.e. the process step that is currently in progress.

\n

In the example below, you'll see that the actions of the signing step are retrieved. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4//packages/{packageId}/process/current \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actions of the current process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","process","current"],"host":[""],"query":[],"variable":[{"id":"b0f57706-a3a1-4b37-8e31-155455e643e5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"a7d0e1c9-d425-4f19-a323-d20bf645cb3b","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"7c95a175-b430-4691-b2b8-290a88eca8c5","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"cb97c56b-9055-4e9b-a600-a229fa94df55","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d4de50cf-9987-445e-984a-a323985eec59"}],"id":"a39ec463-7033-45ab-abda-43374d203a50","description":"

Process

\n

The Process collection contains all resources and methods to set up a package's form filling/approval/signing process. Its allows you to set up parallel, sequential and complex signing flows. \n 

\n

How does a process work?

\n

A package's process defines which stakeholder will do their action at which moment in time.

\n

A process may consist of multiple process steps. A process step is a set of actions that may be done in parallel. For instance, approve in process step 1, fill out forms in step 2, sign in step 3 and receive in step 4. The approval step may occur before or after the filling of forms, as long as they are both prior to signing. Receivers must be placed in the last step, since they receive the signed documents after the signers have completed their tasks. \n 

\n

Process methods

\n\n","_postman_id":"a39ec463-7033-45ab-abda-43374d203a50","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"SigningMethods","item":[{"name":"Returns all signing methods that are currently configured","id":"380cb57d-4942-4e45-8015-9702e88c77fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/signingmethods?isActive=","description":"

Get signing methods

\n

Description

\n

This call retrieves all signing methods that are currently enabled or disabled in the eSignatures Configuration Index and are thus available to the users.

\n

This call is useful for integrators who need to know which methods are currently enabled in a given eSignatures installation, otherwise that list of signing methods would need to be duplicated in the integrator’s configuration database as well.

\n

Note that this API v4 call retrieves both the SigningTypes that are configured in the deprecated Signing Options settings group, and the SigningMethods and the Signing Behavior they belong to, configured in the new Signing Options settings group. The new SigningMethods are formatted as follows: SigningBehavior:SigningMethod. E.g. SmartCard:BeID.

\n

Note that as of eSignatures 6.5.0, a new Signing Behavior has been introduced: RemoteHashSigning. This Signing Behavior currently encompasses two supported SigningMethods: itsme and Swisscom. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/signingmethods \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveDetermines whether the call must retrieve all active or inactive SigningMethods.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveWhether the SigningMethod can be used to create new signing fields.Boolean
NameThe name of the SigningMethod as configured in the Configuration Index.String
DisplayNamesThe names of the SigningMethod in the different languages as they will be shown to a signer in WYSIWYS.Array or objects
DisplayNamesInitiatorThe names of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
DescriptionsThe descriptions of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
RequiredPropertiesThe properties that are required to be passed in the Create stakeholders call. When RequiredProperties are returned for a SigningMethod, it means mandated signing rules have been applied to that SigningMethod. To check whether a signer is mandated to sign during a particular signing session, eSignatures compares the data passed in the RequiredProperties to the external data retrieved from the signing certificate or returned by the signing service.Array or objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe SigningMethods list is successfully returned.
401 UnauthorizedCaller is unauthorized to do this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["signingmethods"],"host":[""],"query":[{"description":{"content":"

only return active / inactive signing methods

\n","type":"text/plain"},"key":"isActive","value":""}],"variable":[]}},"response":[{"id":"d4fc5acb-e3f1-4d80-a011-39b073ef3812","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"consequat_958\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"dolore6\": \"\"\n },\n \"Descriptions\": {\n \"anima38\": \"\",\n \"pariatur_f\": \"\",\n \"ea_2b\": \"\",\n \"exercitation0f\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"do_e8\": \"\",\n \"irured\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"esse_33\": \"\",\n \"ullamco_d\": \"\",\n \"proident_82d\": \"\"\n }\n }\n ]\n },\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"est96\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"nostrud87\": \"\"\n },\n \"Descriptions\": {\n \"laboris9c6\": \"\",\n \"irure18f\": \"\",\n \"id_7\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"incididunt_d\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"aliquip_dd\": \"\",\n \"aliquip_5\": \"\",\n \"magna4\": \"\"\n }\n }\n ]\n }\n]"},{"id":"db06b9fd-6ea1-45c0-9e87-f29460ae4723","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"380cb57d-4942-4e45-8015-9702e88c77fb"}],"id":"a2dcac53-72b8-46f9-9820-876a28db43cf","description":"

The signing methods that are configured in eSignatures

\n","_postman_id":"a2dcac53-72b8-46f9-9820-876a28db43cf","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"AuditProofs","item":[{"name":"This call allows API users to add extra proofs from an external source to a location on a document.","id":"51fe1a48-d543-4cd7-b25a-37ac806d4029","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": \"\",\n \"Name\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/auditproof/proofs","description":"

Add Proof from External Source

\n

Description

\n

This call allows API users to add extra proofs from an external source to a location on a document.

\n

This call can be done multiple times for the same location and even when the package is fully signed (in this case the API user is responsible for making sure that any proof is added before retrieving the signed Audit proofs xml). \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/proofs \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
LocationIdMandatoryLocation of the signature for which the proof content is generated.Guid
NameMandatoryName of the proof.String
DescriptionOptionalBrief human-readable description of the proof.String
TypeMandatoryA machine-readable “type” key. Can be freely chosen.String
ContentMandatoryThe actual content of the proof.Base64 string
IpAddressOptionalIP address of the end user of the external source for which the proof was added.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentThe proof was created for the requested location.
400 Bad RequestThe request contained parameters which could not be accepted.
404 Not FoundThe documentId or the LocationId could not be found.
409 ConflictThe proof could not be added due to some other reason.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","proofs"],"host":[""],"query":[],"variable":[{"id":"802a6e0f-fa5d-4c7e-84cd-8471fd9d7801","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"0e61c6a6-fd11-4bcd-aabe-49dc9dace297","name":"Audit proof created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"94eca4e4-81e2-4f75-83bb-c1bcea27a6dd","name":"When the Content is not a valid Base64 string or the Type contains an invalid value","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"f4512f9c-ccd1-4ce4-bd0c-6a8325074d8e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f2b4bf01-12f8-45bb-a1b3-1c6b288595d8","name":"When the packageId could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"a236c0b6-8d72-4051-864b-a9d60e11d7ec","name":"When Audit Proofs are not enabled or package is in an invalid status.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"51fe1a48-d543-4cd7-b25a-37ac806d4029"},{"name":"Downloads the Audit Proofs of a package","id":"ca6aed7a-aa81-4cf6-b86d-d7f746af81b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download","description":"

Get Package or Document Audit Proofs Xml

\n

Description

\n

A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the package status is right).

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"130834e3-6e9c-4285-ae49-cd00a90d12bd","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"45cd3acc-7603-46b4-a4d5-9b7234db8c87","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"b2974911-e56e-45d5-8f33-d1da7cdd1ad9","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"78a2de42-5895-44a8-aaa4-cf5b02a81e2c","name":"When the packageId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"80f6e838-c6b6-4085-8560-4cf175464207","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"ca6aed7a-aa81-4cf6-b86d-d7f746af81b8"},{"name":"Downloads the Audit Proofs of a document","id":"ec1e4118-1de6-4a51-93ab-892d96728486","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download/:documentId","description":"

Downloads the Audit Proofs of a document

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"6a6615cd-d01e-4ca7-bcd9-2b6f58d2537d","type":"any","value":"","key":"packageId"},{"id":"3f1c2f0f-e359-414d-9d3b-d73365eead10","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"ae821c30-6392-4d53-b9c4-5655d4d4919a","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"b940484b-fce6-41d4-a188-ebda50b5a1f4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4ade6404-93bc-4e4e-9141-65776da278df","name":"When the document or package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"6cf72089-fd10-47d2-b01f-395280a9f3d9","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this document.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"ec1e4118-1de6-4a51-93ab-892d96728486"},{"name":"Downloads the Audit Proofs by packageCorrelationId","id":"86e1e601-2b91-4740-8027-0fcd80a1f766","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packagecorrelations/:correlationId/auditproof/download","description":"

Get Package or Document Correlation Audit Proofs Xml

\n

Description

\n

Correlation ids are used to track packages or documents across several passes through the eSignatures application. On a document it states the “external identity” of that document so that it can be established what happened to it, whereas for a package it depends on how you interpret the data.

\n

Either way, retrieving the audit proofs for such an identifier will combine all available audit proofs into one big XML. Items will be grouped into packages and documents to indicate how they were uploaded several times of the lifespan of the set.

\n

Important: combined audit proofs xmls should only be retrieved when all packages containing the package correlation id or all documents with the given correlation id are fully signed, or otherwise in a final state. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packagecorrelations/{correlationId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/documentcorrelations/{correlationId}/auditproof/download

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CorrelationId*Unique identifier that links related audit proofs together .String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the status of all items in the set is right). \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit proofs xml is returned.
404 Not FoundThe document/package id could not be found.
409 ConflictThe package is not fully signed.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packagecorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"5236174f-eac2-426c-9904-c0b893790911","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"e5a81adf-555e-4eaf-b285-b51813615cfc","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"f4ab65e7-8bf4-4d2f-949c-4d78cb04830c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e8073acb-e521-4268-bd0d-42accd4968c8","name":"When no package with given correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"c3b8fb0b-2e0f-4c32-a257-15e43ae68a3d","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"86e1e601-2b91-4740-8027-0fcd80a1f766"},{"name":"Downloads the Audit Proofs by documentCorrelationId","id":"d905d8c7-c556-480b-8c4e-00c0eedf5702","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/documentcorrelations/:correlationId/auditproof/download","description":"

Downloads the Audit Proofs by documentCorrelationId

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["documentcorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"9efb8a1a-4450-4826-99a8-da5c4e1be255","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"131c7160-1605-4820-b2b4-8ccef490ca30","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"42088e81-74ff-400d-9cc7-12bfc702f568","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"89e00a19-65c9-441a-8a10-71d9e3478d9d","name":"When the correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"09a987c4-aaa1-4fbc-8689-ef142995e66b","name":"When Audit Proofs are not enabled","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"d905d8c7-c556-480b-8c4e-00c0eedf5702"},{"name":"Deletes audit proof infos of a package","id":"c09c3542-f209-467a-a730-252b8a7c44a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/auditproof","description":"

Delete Audit Proof Info

\n

Description

\n

Audit proofs are no longer automatically deleted as soon as the corresponding package is deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can now be configured on environment level in the Configuration Index, or specified per package through the DelayedDeletionDate parameter in the Delete Package by ID call.

\n

If you want to delete audit proofs earlier than specified, you can also do a manual Delete audit proof info call and specify of which package the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentAll audit proofs are deleted successfully
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundNo audit proofs available for this package
409 ConflictCould not perform operation on package with id {id}
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","auditproof"],"host":[""],"query":[],"variable":[{"id":"5891e857-8b98-4fa5-a0ee-1ff35482d958","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"bc3f9a53-4a40-4c78-bd39-f7158d934fde","name":"Audit proofs of package were succesfully deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"50c88679-e092-4b6d-b939-4347a5996f06","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1c27ac60-9131-4c36-aa16-e7715c864f84","name":"No auditproofs were found for given packageId","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"444ae5a8-aec2-4b69-ba47-ed4fbc0e4897","name":"Package wasn't deleted yet","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c09c3542-f209-467a-a730-252b8a7c44a9"},{"name":"Gets audit proof infos of all packages","id":"a1a84734-f757-4e27-b0d1-4f32fc1048c3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","description":"

Get Audit Proof Info

\n

Description

\n

This calls allows to you retrieve the audit proof info of packages.

\n

Currently, you can retrieve the audit proof info of DELETED packages.

\n

You can narrow the search for specific audit proof info by adding the optional request parameters listed below. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproofinfo \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Status*Status of the package. Currently, you can only retrieve the audit proof info of packages that have the status DELETED.String (enum)
PackageIdUnique identifier of the package whose audit proof info you want to retrieve.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.String (GUID)
CreatedBeforeGets only the audit proof info of packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the audit proof info of packages created after this date. ISO 8601 date format.String (date-time)
DeletedBeforeGets only the audit proof info of the packages deleted before this date. ISO 8601 date format.String (date-time)
DeletedAfterGets only the audit proof info of the packages deleted after this date. ISO 8601 date format.String (date-time)
ExpiresBeforeGets only the audit proof info of the packages that expire before this date. ISO 8601 date format.String (date-time)
ExpiresAfterGets only the audit proof info of the packages that expire after this date. ISO 8601 date format.String (date-time)
SortFieldField on which the result is sorted.String
SortOrderDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
PageSizeMaximum number of records in the response Default value is 20.Integer
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.String (GUID)
PackageNameName of the package.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.
PackageCreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
PackageDeletionDateDate and time when the package was deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DelayedDeletionDateDate and time when the audit proofs of the package were deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DocumentsThe documents that the retrieved package contains.Array of objects
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
DocumentIdUnique identifier of the document.String (GUID)
CorrelationIdIdentifier that correlates this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll audit proof info is successfully retrieved.
400 Bad requestThe parameter Status does not support value 'xyz'. Supported value is 'Deleted' only.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","auditproofinfo"],"host":[""],"query":[{"description":{"content":"

(Required) The status of the packages to get the auditproof infos for

\n","type":"text/plain"},"key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items deleted before given date

\n","type":"text/plain"},"key":"deletedBefore","value":""},{"description":{"content":"

Select items deleted after given date

\n","type":"text/plain"},"key":"deletedAfter","value":""},{"description":{"content":"

Select items expires before given date

\n","type":"text/plain"},"key":"expiresBefore","value":""},{"description":{"content":"

Select items expires after given date

\n","type":"text/plain"},"key":"expiresAfter","value":""},{"description":{"content":"

Select items on given correlationId

\n","type":"text/plain"},"key":"correlationId","value":""},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field the result is sorted

\n","type":"text/plain"},"key":"sortField","value":"packageDeletionDate"}],"variable":[]}},"response":[{"id":"2416716b-d4d7-4440-86f2-7bb16fb41f21","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n },\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"b1c7ae31-4746-4344-b783-8d13e5c1edfa","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"11e2fee3-88ec-4392-9181-bb77ae59882c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a1a84734-f757-4e27-b0d1-4f32fc1048c3"}],"id":"a0b93e32-c6c0-4195-a079-cfb5df8ca0aa","description":"

Audit proofs

\n

When the Audit proofs setting is enabled in the Configuration Index, eSignatures keeps Audit proofs about each signature that is placed.

\n

The following information is collected in base64 format about each form filling:
Form filling events information

\n
    \n
  • Time when form fields on the package were filled out
    • \n
  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder
    • \n
  • Time when an invitation was sent to form fill the package, content of the invitation, recipient(s)
    • \n
  • For all form filling events mentioned above, the form filler’s IP address is added to the Audit proofs.
    • \n
\n

The following information is collected in base64 format about each approval:
Approval events information

\n
    \n
  • Time when package was approved
    • \n
  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder
    • \n
  • Time when an invitation was sent to approve the package, content of the invitation, recipient(s)
    • \n
  • For all approval events mentioned above, the approver’s IP address is added to the Audit proofs.
    • \n
\n

The following information is collected in base64 format about each reassignment:
Reassignment events information

\n
    \n
  • Time when package was reassigned
    • \n
  • Reason why the package was reassigned
    • \n
  • First name of previous and new approver or signer
    • \n
  • Last name of previous and new approver or signer
    • \n
  • Email address of previous and new approver or signer
    • \n
\n

The following information is collected in base64 format about each signature:
Signing events information

\n
    \n
  • Start time of signing, end time of signing
    • \n
  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder
    • \n
  • Time when an SMS OTP was sent, content of the SMS, recipient of the SMS
    • \n
  • Time when a mail OTP was sent, content of the mail, recipient of the mail
    • \n
  • Time when an invitation was sent to sign the package, content of the invitation, recipient(s)
    • \n
  • For the signing events mentioned above, the signer’s IP address is added to the Audit proofs
    • \n
\n

Signature information

\n
    \n
  • Signature certificate that was used to place the signature, its certificate chain and certificate revocation information (OCSP / CRL)
    • \n
  • Timestamp certificate, its certificate chain and certificate revocation information (OCSP / CRL)
    • \n
  • The signed PDF when the package is fully signed
    • \n
  • If the setting Intermediate States Saved is enabled in the Configuration Index, a copy of the document gets added in base64 format after each signature.
    • \n
  • Any extra proofs which were added by the client through the Post extra proof call.
    • \n
  • If the setting IsOneTimeUrlEnabled is disabled in the Configuration Index, the following value is added for every signature that was placed by means of an “unsecure” URL: “One-time URL was disabled when signing”.
    • \n
\n

All this data is stored in xml files which are signed at the end. The signed xml files can then be retrieved through one of the following four calls:

\n
    \n
  1. The Audit proofs of a specific document within a package, based on the document id
    2. \n
  2. The Audit proofs of a specific package, based on the package id.
    3. \n
  3. The Audit proofs of all packages containing a specific package correlation id.
    4. \n
  4. The Audit proofs of all documents containing a specific document correlation id.
    5. \n
\n

Important: If a package is deleted via the API or the eSignatures Portal then the audit proofs are deleted as well.

\n","_postman_id":"a0b93e32-c6c0-4195-a079-cfb5df8ca0aa","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"AuditTrails","item":[{"name":"Downloads the audit trail of the Package (PDF)","id":"8f4749db-1473-496e-b068-0fc18653bf0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/audittrail","description":"

Get Audit Trail

\n

Description

\n

This call allows you to retrieve the PDF Audit Trail representation of the specified package in a specified language.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/audittrail/{culture}

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/pdf

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to retrieve.String (GUID)
Culture*ISO 639-1 language code of the language.String
\n

Response parameters

\n

The API returns the Audit Trail in pdf format.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit Trail pdf is returned.
404 Not FoundThe package could not be found.
409 ConflictThe package is not in a final state.
401 UnauthorizedYou don't have the correct rights for this call
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","audittrail"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"152975f3-6064-46f1-9f46-64789a86df0a","name":"The signed Audit Trail in pdf file.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/pdf"}],"cookie":[],"responseTime":null,"body":""},{"id":"f91a3a6e-d900-4512-a7e1-37abcca1402c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7a609280-da64-4b58-94b9-f124e9a6fd74","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"02f4b7be-7bcd-4e2d-b611-7992f784b906","name":"When the package has not been fully signed, rejected or revoked","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"8f4749db-1473-496e-b068-0fc18653bf0d"},{"name":"Retrieve the audit trail of the Package (JSON)","id":"9803bf16-dc41-4097-9a3f-2df4dd3c66ff","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/audittrail","description":"

Get Audit Trail

\n

Description

\n

This call allows you to retrieve the Audit Trail of the specified package, consisting of a list of events

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/audittrail

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to retrieveString (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
RequestedOnDate of request for this audit trailString (date)
PackageInfoInformation about the packagePackageInfo
EventsA list of events that occured during the lifecycle of the packageArray of EventInfo
\n

PackageInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the packageString (GUID)
CreatedOnDate of package creationString (date)
InitiatorThe package initiator (user) email addressString
StatusThe status of the packageString (enum)
DocumentsThe documents in the packageArray of DocumentInfo
\n

DocumentInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the documentString (GUID)
NameThe name of the documentString
PagesCountsCount of pages in the documentInteger
SignedFieldsCountThe number of signed fields on the documentInteger
\n

EventInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of an eventString (GUID)
CreatedOnDate of event creationString (date)
IpAddressThe ip address of the user that made the event happenString
TypeUnique name defining the event typeString (enum): AuditEventType
UserThe email address of the logged in application user that made the event happenString
PackageDetailAdditional information about the package that is relevant for the package events.
Not empty for events that affect the package itself.		PackageAuditDetail
ActionDetailAdditional information about the actor that is relevant for the action events.
Not empty for events that affect an actor itself.		ActionAuditDetail
\n

PackageAuditDetail

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ApiSourceThe source of the API that initiated the event.String (enum):
- Unknown
- PortalApi
- WebPortalApiV3
- WebPortalApiV4
TemplateCodeIdentifier of the template from which the package was created.
Not empty when `PackageCreated` event indicates the package was created from a template.		String
DocumentsState of documents at time of the event.Array of DocumentInfo
\n

ActionAuditDetail

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActorIdAn actor's (action) unique identifierString (GUID)
PersonIdA person's (stakeholder) unique identifierString (GUID)
EmailAddressThe person's email addressString
SigningMethodsUsed signing methods for a `SignActionCompleted` eventArray of SigningMethod
DocumentsAffected documents during an action (Approved, FormFilled or Signed).Array of ActionDocumentInfo
\n

ActionDocumentInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the documentString (GUID)
NameThe name of the documentString
\n

AuditEventType

\n

Unique name defining the event type. The list is not exhaustive and subject to extension.

\n
    \n

  • PackageCreated

    \n
    • \n

  • PackageSubmitted

    \n
    • \n

  • PackageDeleted

    \n
    • \n

  • PackageEnded

    \n
    • \n

  • PackageExpired

    \n
    • \n

  • PackageExtended

    \n
    • \n

  • PackageRevoked

    \n
    • \n

  • PackageFinished

    \n
    • \n

  • PackageRejected

    \n
    • \n

  • PackageSentToReceiver

    \n
    • \n

  • PackageApprovalEnded

    \n
    • \n

  • PackageEnded

    \n
    • \n

  • PackageActionInvitationSent

    \n
    • \n

  • PackageActionReminderSent

    \n
    • \n

  • PackageViewedByPerson

    \n
    • \n

  • UnsignedPackageDownloadedByAnonymous

    \n
    • \n

  • UnsignedPackageDownloadedByPerson

    \n
    • \n

  • DocumentsRefusedBySigner

    \n
    • \n

  • FormFieldsRefused

    \n
    • \n

  • MailOtpAuthenticationCodeSent

    \n
    • \n

  • MailOtpAuthenticationSuccessful

    \n
    • \n

  • SmsOtpAuthenticationCodeSent

    \n
    • \n

  • SmsOtpAuthenticationSuccessful

    \n
    • \n

  • PhoneNumberVerified

    \n
    • \n

  • SmsOtpSent

    \n
    • \n

  • MailVerified

    \n
    • \n

  • MailOtpSent

    \n
    • \n

  • PackageActionRejected

    \n
    • \n

  • PackageActionInProgress

    \n
    • \n

  • PackageActionFailed

    \n
    • \n

  • ApproveActionCompleted

    \n
    • \n

  • FormFillActionCompleted

    \n
    • \n

  • SignActionCompleted

    \n
    • \n

  • PackageActionReassigned

    \n
    • \n

  • PackageActionReassignedByUser

    \n
    • \n

  • DocumentDownloadedByAnonymous

    \n
    • \n

  • DocumentDownloadedByPerson

    \n
    • \n

  • DocumentDownloadedByUser

    \n
    • \n

  • PackageDownloadedByAnonymous

    \n
    • \n

  • PackageDownloadedByPerson

    \n
    • \n

  • PackageDownloadedByUser

    \n
    • \n
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit Trail is returned
404 Not FoundThe package could not be found
409 ConflictThe package is in wrong state
401 UnauthorizedYou don't have the correct rights for this call
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","audittrail"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"beaa0709-97aa-4046-aaf8-a54b9299fb7e","name":"The audit events","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/","host":[""],"path":["packages",":packageId","audittrail",""],"variable":[{"key":"packageId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"RequestedOn\": \"2025-02-27T09:09:46Z\",\n \"PackageInfo\": {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example package\",\n \"CreatedOn\": \"2025-01-14T13:24:49Z\",\n \"Initiator\": \"hello@world.invalid\",\n \"Status\": \"Draft\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\",\n \"PagesCount\": 10,\n \"SignedFieldsCount\": 4\n }\n ]\n },\n \"Events\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"CreatedOn\": \"2024-08-14T13:24:49Z\",\n \"IpAddress\": \"127.1.0.0\",\n \"Type\": \"SignActionCompleted\",\n \"User\": \"hello@world.invalid\",\n \"PackageDetail\": {\n \"ApiSource\": \"Unknown\",\n \"TemplateCode\": \"string\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\",\n \"PagesCount\": 10,\n \"SignedFieldsCount\": 4\n }\n ]\n },\n \"ActionDetail\": {\n \"ActorId\": \"00000000-0000-0000-0000-000000000000\",\n \"PersonId\": \"00000000-0000-0000-0000-000000000000\",\n \"EmailAddress\": \"hello@world.invalid\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\"\n }\n ],\n \"SigningMethods\": [\n {\n \"Name\": \"MailOtp:MailOtp\",\n \"KeyPair\": \"MyKeyPair\"\n }\n ]\n }\n }\n ]\n}"},{"id":"45111117-9de8-4cf1-91a8-71605aef2132","name":"When the package is not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail","host":[""],"path":["packages",":packageId","audittrail"],"variable":[{"key":"packageId","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"9803bf16-dc41-4097-9a3f-2df4dd3c66ff"},{"name":"Verifies whether the audittrail is valid","id":"2226b312-235c-44ce-b6af-caeece22b93e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/audittrail/verify","description":"

Verify Audit Trail

\n

Description

\n

This call allows you to verify if a specified package's Audit Trail is valid. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/packages/{packageId}/audittrail/verify \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to verify.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA Boolean indicating if the Audit Trail is valid.
404 Not FoundThe package could not be found.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages",":packageId","audittrail","verify"],"host":[""],"query":[],"variable":[{"id":"1f3863ff-a16f-435d-aa75-fd7512189f4e","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"0dd6256a-caad-4e29-bf96-e6924f6846d6","name":"A boolean indicating if the Audit Trail is valid.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"6d450c0d-fbcc-4261-a616-2047fed8d89d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2226b312-235c-44ce-b6af-caeece22b93e"}],"id":"02bef8bc-2866-41cf-af49-588e4631953a","description":"

Audit trails

\n

Prior eSignatures versions already supported the Audit Proof, an XML that can be downloaded through the API that keeps track of all actions taken on a package.

\n

With eSignatures 6.1.0, we added the notion of the Audit Trail. The Audit Trail is a pdf that can be downloaded from the Document Portal or through the API. The Audit Trail contains the actions taken for that package and can be downloaded when the package is in a final state.

\n","_postman_id":"02bef8bc-2866-41cf-af49-588e4631953a","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Templates","item":[{"name":"Gets all package templates available","id":"f479abbe-bdf2-4bcf-8f78-779cfe5683e4","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","description":"

Get Templates

\n

Description

\n

This call retrieves all the templates, and their code, that are available in the eSignatures WebPortal.

\n

The Template code can be entered as a request parameter when doing a Create Package call. The package will then be created with all the information from the template. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/templates \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
pageNumberOptionalThe page to retrieve.Int
pageSizeOptionalMaximum number of recordsInt
documentGroupCodeOptionalFilter the records by the document group they are in.String
sortOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
createdAfterOptionalOnly show the templates that are created after a
specific date		DateTime
createdBeforeOptionalOnly show the templates that are created before a
specific date		DateTime
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
TotalNumber of total records for the given parametersInt
ItemsList of templatesArray of objects
NameName of the templateString
TemplateCodeUnique id of the templateString
PageSizeMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe templates list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["templates"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"4fd2630f-0d95-4b45-8313-94c37a009e7a","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","host":[""],"path":["templates"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n },\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n }\n ]\n}"}],"_postman_id":"f479abbe-bdf2-4bcf-8f78-779cfe5683e4"}],"id":"bd1af1cb-b2ef-4d3e-b3ba-10f74e09e8aa","description":"

Package templates module

\n","_postman_id":"bd1af1cb-b2ef-4d3e-b3ba-10f74e09e8aa","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"AbsencePeriods","item":[{"name":"Creates an absence period","id":"be21feea-3108-4e51-9b08-62dc9870016d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods","description":"

API v4: Create an absence period

\n

Set an absence period for a user and assign their substitutes.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods

\n

Method

\n

POST

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
User*The email address of a user for whom an absence period is created.String (email)
StartDate*

Absence start date and time.

For example:

2023-02-01T11:40:00Z 2024-12-20T08:00:00+0200

String ($date-time)
EndDateAbsence end date and time.String ($date-time)
SubstitutesSubstitutes for this absence period.
See the child parameters of this parameter.		Array of objects
\n

Child parameters of the Substitutes parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
Type*Possible values:String
person

A stakeholder who takes action on the package individually.		See the parameters for the person type.
group

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to fill out forms and approve or sign a package on behalf of the entire group. Each person in the group will receive a unique URL for the package.

As soon as one member of the group has taken action, the others no longer can.		See the parameters for the group type.
contactgroup

A contact group stakeholder can be used when a contact group has been created in the eSignatures Portal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the eSignatures Portal instead of defining each member in the call.

Note: The stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains.		See the parameters for the contactgroup type.
ActionTypes*

Possible values:

- approver
- receiver
- signer
- formFiller

String (enum)
AllowedToReassignIf enabled, the substitute can assign a package to another user.Boolean
\n

Parameters for the person type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
Language*User language.
A two-letter ISO 639-1 language code.

For example: en		String
TitleFor example: Ms.String
FirstNameThe first name of a substitute.

Maximum length: 150 characters.		String
LastName*The last name of a substitute.

Maximum length: 150 characters.		String
EmailAddress*The email address of a substitute.String (email)
PhoneNumberThe phone number of a substitute.String
BirthDateThe birth date of a substitute.String (date)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the group type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
GroupName*The name of the group.
Maximum length: 128 characters.		String
Members*The list of persons in this group.
Use the same parameters as described for the person type.		Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the contactgroup type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
ContactGroupCode*The contact group code in the eSignatures Portal.String
\n

Response parameters

\n

The response parameters will be the same as the request parameters. Additionally, the required response parameter Id*, which is the unique identifier of the string($guid) type, will be returned for:

\n
    \n
  • The absence period
    • \n
  • The substitutes (person, group, contact group)
    • \n
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
201The absence period has been created.
400

The request failed validation.

For example:

[ { \"Code\": \"Name.MinimumLength:6\", \"Message\": \"The minimum length for a name is 6\" } ]

401The caller is unauthorized to perform this operation.
403It is forbidden to perform this operation.
404

An exception has occurred.

For example:

{ \"Code\": \"User.NotFound\", \"Message\": \"No user found with email address [hello@world.test].\" }

409

The request conflicts with existing information and/or business rules.

For example:

{ \"Code\": \"AbsencePeriod.OverlapsWithExistingAbsencePeriod\", \"Message\": \"The provided absence period overlaps with an existing absence period.\" }

\n

Error codes

\n

|

HTTP code

|

Error code

|\n|

400

|

Json.DeserializationFailed

|\n|

400

|

Request.RequiredFieldIsMissing:{fieldName}

|\n|

400

|

Request.FieldMaxLength:{fieldName},{maxLength}

|\n|

400

|

EmailAddress.Invalid

|\n|

400

|

Request.DateInvalid:{date}

|\n|

400

|

Actor.TypeInvalid:{actorType}

|\n|

400

|

Person.UnsupportedLanguage:{language}

|\n|

400

|

Person.EmailAddressInvalid:{emailAddress}

|\n|

400

|

Person.BirthDayInvalid:{date}

|\n|

400

|

Person.BirthDayInFuture:{date}

|\n|

400

|

Person.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

ContactProperty.Invalid:{contactPropertyKey}

|\n|

400

|

ContactProperty.Duplicate:{contactPropertyKey}

|\n|

400

|

ContactProperty.MissingValue:{contactPropertyKey}

|\n|

400

|

ContactProperty.InvalidValue:{contactPropertyKey}

|\n|

400

|

GroupMember.UnsupportedLanguage:{language}

|\n|

400

|

GroupMember.EmailAddressInvalid:{emailAddress}

|\n|

400

|

GroupMember.BirthDayInvalid:{date}

|\n|

400

|

GroupMember.BirthDayInFuture:{date}

|\n|

400

|

GroupMember.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

PersonGroup.DuplicateEmailAddress

|\n|

400

|

AbsencePeriod.ShouldHaveStartDate

|\n|

400

|

AbsencePeriod.StartDateInThePast

|\n|

400

|

AbsencePeriod.EndDateBeforeStartDate

|\n|

403

|

ContactGroup.ViewNotAllowed

|\n|

403

|

OutOfOffice.Disabled

|\n|

404

|

User.NotFound:{emailAddress}

|\n|

404

|

ContactGroup.NotFound:{contactGroupCode}

|\n|

409

|

AbsencePeriod.OverlapsWithExistingAbsencePeriod

|\n|

409

|

AbsencePeriod.HasMoreThanOneSubstituteDefinedForActionType:{actionType}

|

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"71cff7e0-a1d8-47d8-b287-f14906cd0c76","name":"Absence period was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created absence period","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"8b54c3fa-53f5-475c-b086-55d20b041082","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4b3dd4cc-1a2d-49b2-96d1-269ef76ad8c9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"de19add6-85b6-4848-aabc-bb0ffadf9106","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"685a6383-82f4-461f-b7fb-f189129c5a57","name":"An exception has occured","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"3fa4d59d-4dcc-45d4-8752-86068e4e2ecc","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"be21feea-3108-4e51-9b08-62dc9870016d"},{"name":"Gets absence periods by email address","id":"a160f8a3-6b71-43f0-9b32-1ba334b38001","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods?email=","description":"

API v4: Get absence periods by email address

\n

Get the list of absence periods for a user by email address.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
email*The email address of a user for whom an absence period is created.String (email)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods"],"host":[""],"query":[{"description":{"content":"

(Required) The user email address to search on

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"a601fcb7-25e2-47a2-9138-5df2ff05fa39","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"approver\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"deserunt_18\": {},\n \"cupidatat_583\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"approver\",\n \"formFiller\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"nisi_c\": {},\n \"ea_3\": {}\n }\n }\n ]\n },\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"sint3a8\": {},\n \"voluptate_9\": {},\n \"euc90\": {},\n \"qui_7\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"eu_7a\": {},\n \"quis02c\": {}\n }\n }\n ]\n }\n]"},{"id":"5c802eb8-c29a-42d5-ae47-653bb8c51383","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"2998ffc3-db13-4940-8d43-102983467f80","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2593f42f-b384-4f8a-ae94-723b504cee70","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a160f8a3-6b71-43f0-9b32-1ba334b38001"},{"name":"Gets an absence period by id","id":"828bea3a-d967-4682-aa8c-1395ca377b51","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Get an absence period by ID

\n

Get the information about an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"f9b0a641-325b-4b82-8ce6-da86a61d842c","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"ee7bb228-3167-4d22-a778-d832b1b678b1","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"43525ea6-4eed-4a13-a5a6-a4f7436ed351","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8d129d13-0249-4e9b-9e5a-20f16fe21f2c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bb8363e9-6485-4082-b562-73537a222c7a","name":"An exception has occured","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"828bea3a-d967-4682-aa8c-1395ca377b51"},{"name":"Updates an absence period by id","id":"679035ed-cfb3-4042-8222-b98bafb0aed8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Update an absence period by ID

\n

Update the information in an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

PUT

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

Request parameters

\n

For the list of request parameters, refer to API v4: Create an absence period.

\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"5283921c-bf18-45d5-b705-c4d2e4e80c44","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"85f75a90-fb3a-4826-95ee-9c4a80cb5173","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"4073c829-0e83-47d3-b668-de0f0eedd1e2","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"6960c10a-1508-403b-a76c-291efd68b416","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"3f8a8cc6-1153-4b59-a957-1a5777c4b9db","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8ed9f1d1-c724-4f9b-8126-1ae0b6c7e8ff","name":"An exception has occured","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"b38d1717-069e-4489-afa8-819b48871fae","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"679035ed-cfb3-4042-8222-b98bafb0aed8"},{"name":"Deletes an absence period by id","id":"96fed32b-e9ef-4915-9688-a1fe2312c545","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Delete an absence period by ID

\n

Delete an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

DELETE

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
204The absence period was deleted.
\n

For other response codes, refer to API v4: Create an absence period.

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"bf141146-9b03-4661-add7-b8356b321b25","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"19271e9d-a491-4741-8dc3-2c1cce032638","name":"Absence period was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0e45b1b6-61fa-4ddb-a3f0-d6ea162c83cc","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c65277aa-7967-48c0-bc22-8dc2422726da","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"127b521f-5ca9-4241-891c-1ec30857eb04","name":"An exception has occured","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"96fed32b-e9ef-4915-9688-a1fe2312c545"}],"id":"07d67c72-ad69-4d09-ad96-95a67b6fbc78","description":"

API v4: Managing absence periods

\n

You can set absence periods for users and name their substitutes. In their absence, packages assigned to a user will be forwarded to these substitutes who will act as a form filler, approvers, signers and receivers. \n 

\n

By using API calls, you can:

\n\n","_postman_id":"07d67c72-ad69-4d09-ad96-95a67b6fbc78","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"BulkActions","item":[{"name":"Create a bulk signing session for given user","id":"d798431f-7a69-4b7c-ba86-14f1fe22721f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"EmailAddress\": \"\",\r\n \"Language\": \"\",\r\n \"Packages\": [\r\n \"\",\r\n \"\"\r\n ]\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk","description":"

API v4: Bulk sign packages

\n

Description

\n

This call allows you to sign multiple pending packages. When providing only the EmailAddress parameter, all available actors will be chosen for bulk signing.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/sign/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailAddress*The email address of the actor for whom you want to start a bulk signing session.String (email)
LanguageThe language of the current signing session.String (language code)
Packages

Collection of PackageIds; i.e., unique identifiers of the packages that must be signed.

Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.

Array of strings (GUID)
ActorsCollection of ActorIds; i.e., unique identifiers of the actors who must sign.
 Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.		Array of strings (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlThe link to a bulk signing session.String (URL)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAn ActionUrl is provided in the response body, this url will open the bulk signing session.
400 Bad RequestThe bulk sign session could not be created due to invalid data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","sign","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"a85d1dea-2234-492b-b96a-fcbbf914c997","name":"OK.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"ca26963e-863f-4cbb-ac8f-afeec8ac3b8f","name":"When the Content has an invalid value.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"c384d9d1-4f66-4dd2-af30-8d3556d53661","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d798431f-7a69-4b7c-ba86-14f1fe22721f"},{"name":"Updates the status of multiple packages in bulk","id":"ee39a10a-06c1-49ce-8d3c-ee566579d45c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk","description":"

Bulk update status of packages

\n

Description

\n

This call allows you to update the status of multiple packages simultaneously.

\n

The possible combinations are:

\n
    \n
  • Draft to pending
    • \n
  • Pending to revoked
    • \n
\n

Draft to pending

\n

When packages are ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the packages visible to each of the stakeholders in their Signer Portal. \n 

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been processed yet, or packages that have failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package.

\n

Important: For the bulk update to succeed for all packages, make sure that all packages you update are in the same original status. Updating both 'draft' and 'pending' packages to 'revoked' for instance will only succeed for the pending packages. The draft packages can only be updated to pending and will therefore fail when trying to update them to revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/status/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose status you want to update.String (GUID)
Status*Status to which the packages must be updated. The possible values are: pending and revoked.String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad requestThe packages could not be updated due to missing data or unsupported values in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400Request.RequiredFieldIsMissing: status
400Request.UnsupportedValue
401Authentication failed, username or password incorrect.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","status","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"43450006-78a0-4e95-8ebf-d6c1e237da51","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"a18bff89-bd8c-4fa0-bee2-5cdb636f35bd","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"ee39a10a-06c1-49ce-8d3c-ee566579d45c"},{"name":"Removes multiple Packages in bulk.","id":"af21afc2-9755-4747-8dcc-89a7c8cac1fb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk","description":"

Bulk delete packages

\n

Description

\n

This call allows you to delete multiple packages simultaneously from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use this Bulk delete packages call or the Delete package by ID call.

\n

Note: you can only delete packages that have status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be deleted.String (GUID)
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of the packages will be deleted, once the packages have been deleted. When this parameter is not passed, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400AuditProof.DelayedDeletionTimeNegative
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b48b371c-f12a-44de-bd74-c48eaa25ceee","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"3263d118-6411-4c3f-aedd-da4ab520d14d","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"af21afc2-9755-4747-8dcc-89a7c8cac1fb"},{"name":"Allows to download multiple Packages in bulk.","id":"6e6a4cba-28b9-4854-b549-2f94ad483043","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk","description":"

Bulk download packages

\n

Description

\n

This call allows you to download multiple finished packages. Note that bulk downloading packages works in two steps:

\n
    \n
  1. The Bulk download packages call downloads the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe packages could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"1d970543-5fc5-401f-ade9-5cf810619848","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"31bbeba0-59ff-4a42-aed5-3671247a1fbf","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"6e6a4cba-28b9-4854-b549-2f94ad483043"},{"name":"Allows to send reminders to the Actors of multiple Packages in bulk.","id":"7c7aa10f-55f9-44a4-b7b6-70588c0d9784","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk","description":"

Bulk send reminders

\n

Description

\n

The Bulk send reminders call sends a reminder to the actors of the specified packages.

\n

Company policy might require that a document is handled within a given timespan. Doing a Bulk send reminders call looks up all actors within the specified packages who haven't approved/signed/filled out their document and sends them an extra notification as a reminder.

\n

Note that only the next available actor(s) in the workflow are notified. This means approvers/signers/form fillers waiting for someone else to take action first in a serial workflow will not receive a notification. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/reminders/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe reminder could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","reminders","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5bfb6279-61d7-4268-af3b-43b43bb2da87","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"a66bcc5f-d83a-4519-bcac-6567fcbdaf70","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7c7aa10f-55f9-44a4-b7b6-70588c0d9784"},{"name":"Allows to extend expiry date of Packages in bulk.","id":"0a5d91b0-da8d-4918-b7dd-2300b7dd7eba","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk","description":"

Bulk extend the expiry date of packages

\n

Description

\n

This call allows you to extend the expiry date of multiple packages simultaneously. This way, you can make documents that were expired available again. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/expirydate/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose expiry date must be extended.String (GUID)
ExpirationTimeStampDate and time when these packages expire and are no longer accessible. Documents within the packages expire on the same date.

Format is ISO 8601 date-time.		String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe expiration date could not be extended due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","expirydate","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5bc2639f-4d29-4643-a884-81af67bdbee4","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"7ac53cd4-81f1-4308-9f26-43b078d9c23c","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0a5d91b0-da8d-4918-b7dd-2300b7dd7eba"},{"name":"Allows to skip a number of Actors of multiple Packages in bulk.","id":"50e57080-325f-41f0-a309-1a3b26134282","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk","description":"

Bulk skip actors of multiple packages

\n

Description

\n

This bulk action call allows you to skip the actors of the specified packages who haven't taken action on their package yet.

\n

With this call you can either skip approvers and form fillers, by sending the packages ToSigners. This way the packages become available for signing, and the approvers/form fillers can no longer take action. Or you can skip any signers who haven't signed yet, by sending the packages ToFinished. This way you can end the signing flow of multiple packages simultaneously. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/skip/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
Target

Target to which the packages must be sent.
Supported values:

- ToSigners
- ToFinished

String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","skip","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"842b845c-48c1-4e93-9cb3-c8fbbf582413","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"4298c192-250a-4a7b-8825-3ce127dda4b5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"50e57080-325f-41f0-a309-1a3b26134282"},{"name":"Removes audit proofs of deleted packages in bulk.","id":"57b7220d-7a0b-4117-a1bf-a677d07c4100","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk","description":"

Bulk delete audit proofs of deleted packages

\n

Description

\n

This call allows you to manually delete the audit proof info of multiple deleted packages simultaneously. As of eSignatures 6.4 it is no longer required to delete audit proofs one by one.

\n

Note that Audit proofs are not automatically deleted as soon as the corresponding packages are deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can be configured on environment level in the Configuration Index, or specified per package(s) through the DelayedDeletionDate parameter in the Delete Package by ID call or Bulk delete packages call.

\n

If you want to delete audit proofs earlier than specified, you can do a manual Delete audit proof info call or this Bulk delete audit proofs call and specify of which package(s) the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproof/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe audit proofs could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","auditproof","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b1f0abaa-4640-49af-af9e-cf0ce9a0353e","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"a27a7f10-3655-43b5-b1c3-9bb02f7663df","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"57b7220d-7a0b-4117-a1bf-a677d07c4100"},{"name":"Allows to download audit trails of multiple packages in bulk.","id":"77477a0b-e648-4f43-b078-fdc4d9a67619","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk","description":"

Bulk download Audit Trail PDFs

\n

Description

\n

This call allows you to download the audit trail PDFs of multiple packages.

\n

Note that the packages must be in finished, archived, rejected or revoked status to download their audit trail PDF.

\n

Note that bulk downloading audit trail PDFs works in two steps:

\n
    \n
  1. The Bulk download audit trails PDF call downloads the audit trails of the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/audittrails/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
CultureISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe Audit Trails could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","audittrails","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"66d1d3f0-ba92-46bd-9294-ba995ececa25","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"4bea84ee-412e-4485-b23d-b385e031bd52","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"77477a0b-e648-4f43-b078-fdc4d9a67619"},{"name":"Get all status information of a bulk package action session.","id":"67b89b83-7fe8-4dbf-bea8-1a3ced77cc74","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per package about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of packages that were processed in the bulk action.integer
SucceededThe number of packages that succeeded in the bulk action.integer
FailedThe number of packages that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info per package.Object
\n

BulkActionDetail (per package)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the package.string
ErrorMessageError message displayed when processing the package.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"id":"c76006fd-313b-4ea6-955d-16aa6b00cf0d","type":"any","value":"","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":""}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"RequestAuditTrails\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"f8856264-55b1-4895-9599-56c5fd10a368","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a36da9cd-5315-4cd1-b3f4-730ea4f4c7a9","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"67b89b83-7fe8-4dbf-bea8-1a3ced77cc74"},{"name":"Get all status information of a bulk action session.","id":"359fa53c-2f6b-4564-9651-404a8f857256","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each action in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified items. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per item about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of items that were processed in the bulk action.integer
SucceededThe number of requests that succeeded in the bulk action.integer
FailedThe number of requests that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info.Object
\n

BulkActionDetail (per item)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the item.string
ErrorMessageError message displayed when processing the item.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"id":"b5be6aef-5fbc-4d66-a5b0-c82840a599f9","type":"any","value":"","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"UserEmailInvitationNotification\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"b370728b-5ddd-40f4-8bad-657d1a2b495b","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ab53bd4f-a67b-488c-9f5f-e6137ab07281","name":"An exception is occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"359fa53c-2f6b-4564-9651-404a8f857256"},{"name":"Allows to download the result of a Bulk Action that creates a Zip archive.","id":"faceb7f6-4b6d-42e3-97e8-85680a32ae0d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/bulkactionsession/download/:bulkActionSessionId","description":"

Get bulk action result call

\n

Description

\n

This call allows you to retrieve the result of a Bulk download packages or Bulk download audit trails PDF call once those calls have been finished.

\n

The result is always downloaded as a .zip file. The .zip file contains a subfolder for each package. Each subfolder may contain the documents in .pdf or .xml, or the audit trails in .pdf format. The .zip file also contains a .json file with information about each package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/​/packages​/bulkactionsession​/download​/{bulkActionSessionId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe results of the requested bulk action are successfully downloaded as .zip file.
400 Bad RequestThe results could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"host":[""],"query":[],"variable":[{"id":"02a4d69d-c6c5-40be-b156-877f5d0cffc2","type":"any","value":""},{"id":"2e4cc7c2-4ae0-4b5e-b99f-98f155252766","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ea21119f-a1ca-44dd-8eff-117c8d7cde1d","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"faceb7f6-4b6d-42e3-97e8-85680a32ae0d"}],"id":"068a3bea-8665-4c6b-bc1e-63732b910ef2","description":"

API v4: Bulk actions

\n

You can perform actions on multiple packages at once.

\n

The following API calls for bulk actions are available:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CallAdded in version
Bulk sign packages7.4.0
Update the status of packages6.4.x
Bulk delete packages6.4.x
Bulk download packages6.4.x
Bulk send reminders6.4.x
Bulk extend the expiry date of packages6.4.x
Bulk skip actors6.4.x
Bulk delete the audit proofs info of deleted packages6.4.x
Bulk download audit trail PDFs of packages6.4.x
Get bulk action info about a specified bulk action session6.4.x
Get bulk action result call (to download the .zip files created by a Bulk download packages or Bulk download audit trails call)6.4.x
\n

Bulk action calls differ from regular API calls. When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session (BulkActionSessionId) is returned.

\n

This unique ID (BulkActionSessionId) can be used in:

\n
    \n

  • A Get bulk action info call to check whether the specified bulk action session is finished and what the results are.

    \n
    • \n

  • A Get bulk action result call to download the contents (as .zip file) of a Bulk download packages or Bulk download audit trails PDF call.

    \n
    • \n
\n","_postman_id":"068a3bea-8665-4c6b-bc1e-63732b910ef2","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}},{"name":"Users","item":[{"name":"Sends an user email invitation for given email addresses","id":"50647d57-4647-4d4a-8782-61875c426d2d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\",\n \"InvitationLanguage\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite","description":"

Invite users

\n

Description

\n

This call allows API users to invite other users to the eSignature environment and add them to the correct user groups.

\n

This call can be used to invite multiple users at the same time and create a shared contact from that user if needed.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/users/invite

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
EmailsMandatoryEmail addresses of all the users you want to invite.Array of Strings
UserGroupsOptionalThe user groups you want to assign the invited users toArray of Strings
CreationOptionsOptionalOptional options for the invited users.Object
\n

CreationOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
IsSharedContactOptionalOption to create a shared contact for the userBoolean
InvitationLanguage (as of 7.5.0)OptionalLanguage that will be used for the invitation. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 Request is acceptedThe users have been invited.
400 Bad RequestThe request contained parameters which could not be accepted.
\n
","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}},"urlObject":{"path":["users","invite"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5d720f29-8eaf-45df-a34c-8aaf195eb289","name":"Request is accepted.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Link\": \"\"\n}"},{"id":"aade15f4-e3bd-4997-a4f3-e7aedc2628fd","name":"Request failed validation.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"a571bc82-edd7-4ce5-9edf-91d72884be9f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"50647d57-4647-4d4a-8782-61875c426d2d"}],"id":"fd7ab793-dbeb-4641-80a6-3ce13c0e886d","_postman_id":"fd7ab793-dbeb-4641-80a6-3ce13c0e886d","description":"","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":true,"source":{"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","name":"v8.0 - v8.1 - Documentation","type":"folder"}}}],"id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9","description":"

Last updated 07/05/2025

\n

Introduction

\n

This document describes the technical specifications of the Nitro Sign Enterprise Verified API v4.

\n

The Nitro Sign Enterprise Verified API is a REST API. It is a web service that allows external systems to make requests for Nitro Sign Enterprise Verified sources through URL paths. More concretely, it allows external systems to interact with the Nitro Sign Premium platform and use its features to create and manage signing flows.

\n

Disclaimers

\n

Only the described use cases are supported. All other use cases, even though possibly technically feasible with the API, are explicitly not supported and should not be implemented as such.

\n

In case of discrepancies between examples and the description of the parameters section, the description of the parameters section prevails.

\n

The descriptions of error codes in this document or the actual error message fields returned by the API are subject to change. External applications should rely on the returned error code values, anything else is only for diagnostic purposes.

\n

All documents uploaded to the API must comply with the standards corresponding of that format. Conversions are based on a best-effort approach. The behavior of uploading non-compliant documents and / or conversions in an environment where required fonts, color profiles etc. are missing is undefined.

\n

The URLs of the REST API in this document were changed to v4 in Nitro Sign Enterprise Verified version 6.0. The support period for the API with v3 URLs outlined in the Nitro Sign Enterprise Verified version 5.x API Technical Documentation is governed by the Nitro Sign Premium support Contract.

\n

The API calls with v2 URLs are no longer supported since version 6.0.

\n

Be aware that the agile nature of JSON for the REST services supports adding optional parameters to the request or new parameters to the responses. The only actions that are considered breaking changes of the API are adding required parameters, changing existing parameters in the requests, or parameters missing from responses.

\n

Important: Always use conforming JSON data in the requests. When the Web Application Firewall in front of Nitro Sign Enterprise Verified is enabled, the firewall validates all JSON passing through it and does not accept invalid JSON (e.g. which contains embedded comments such as // or /* */ and extra commas).

\n

Optional fields that are not used must be left out of the request message. An empty string or dummy value for optional fields is also a value, and hence may trigger an error in the current version or a future version.

\n

There is no dedicated error code for packages which exceed a given file size other than HTTP code 404.13 returned by IIS. However, as a practical guideline a document must not exceed 30 MB. Packages must not be larger than 150 MB in total and should not contain more than 15 documents. Note that large files might affect signing performance, depending on the user's Internet connections.

\n

REST service

\n

The services are plain REST based services, maintaining no state whatsoever. All data exchanges, in and out, are handled in JSON data format and using UTF-8 encoding.

\n

The default URL is:

\n

https://[servername]:[port]/esig/webportalapi/v4/

\n

Important note about MTLS:

\n

When the setting IsMtlsEnabled is enabled in the Configuration Index, API users must make sure that an HTTP/1.1 connection is established and that the following header is sent in all Nitro Sign Premium API calls:

\n

Plain Text

\n
Expect: 100-continue\n\n

The client should then wait for the HTTP 100 Continue response before sending the actual payload.

\n

Failing to do so will cause problems with large payloads (e.g. when uploading PDF documents). In such a case the payload will fill the server’s receiving buffer before proper mutual authentication is finished, the connection will never be established and the request will time out as a result.

\n

If for some reason such HTTP/1.1 connection is not feasible, API users can also try to send a HEAD request using their HTTP client object before doing the actual file upload request with the same client. This workaround is not recommended however, since the client may decide to reset the connection in between the two different calls.

\n

HTTP statuses

\n

Below you find an overview of the HTTP statuses that are returned, and their meaning.

\n

Successful responses

\n

200 OK
The response body contains a representation of the requested / created resource.

\n

201 Created
The request led to the creation of a resource. The created resource is in the body of the response and its location is found in the Location header.

\n

204 No Content
The request was successful and there is no additional content to send in the response body.

\n

Client Error responses

\n

400 Bad Request
The server cannot or will not process the request due to something that is perceived to be a client error (e.g. failed validation).

\n

401 Unauthorized
The request has not been applied because it lacks valid authentication credentials for the target resource.

\n

404 Not Found
The origin server did not find a current representation of the target resource.

\n

409 Conflict
The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request.

\n

Server error responses

\n

500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.

\n

Concepts Overview

\n

This section explains the different concepts that are used in the Nitro Sign Enterprise Verified API.

\n

Package
Packages lie at the core of Nitro Sign Enterprise Verified . A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

Document
A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder.

\n

A document may contain multiple elements. This element could be a signing field or a form field (e.g. textbox field, checkbox field and radio buttons) and as of 7.0.0 it can also be a UnplacedElement (e.g. not attached to a document yet)

\n

Element
An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor or a form field that can be assigned to a form filler actor.

\n

Stakeholder
A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must do. For instance, form fill, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group.

\n

Actor
An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are: form filler, approver, signer and receiver.

\n

Process and process steps
A package's process defines which stakeholder will do their action at which moment in time. A process may consist of multiple process steps. This way, you can set up parallel, sequential or complex flows in which actors can form fill and approve or sign. All actors that are put in the same process step will be completed in parallel.

\n

Tip: Consult the Glossary section for an overview of more Nitro Sign Enterprise Verified related terms.

\n

Authentication and Security

\n

Authentication

\n

Basic authentication

\n

The Nitro Sign Enterprise Verified API supports ‘Basic Authentication’ via a username and password combination that must be placed in the header of every request.

\n

The default credentials, which must be changed through configuration at installation time should have been communicated to you by email or sms.

\n

Note: depending on the Configuration Index settings, the use of an Mtls Client certificate might be required.

\n

Authentication using JWT Access Token

\n

Authentication can be done using a JWT access token following the Oauth 2.0 protocol using the \"Client Credentials Grant\" flow.

\n

The access token can be retrieved by calling the token endpoint of the authentication server. The Url of the token endpoint can be retrieved from the discovery endpoint available at /.well-known/openid-configuration.

\n

The access token should be cached and reused for its lifetime. A new access token should be retrieved using the refresh token when it is expired.

\n

Getting the token with curl:

\n
curl -A \"ClientApplication/1.0\" -d \"grant_type=client_credentials&client_id=${client_id}&client_secret=${client_secret}&scope=${scope}\" \"${token_endpoint}\"\n\n

client_id is the value of the client id (also called application id) provided by Nitro client_secret is the \"password\" for the client id, provided by Nitro scope must contain \"https://connective.eu/scopes/esignatures\" for eSignatures token_endpoint is the token endpoint on the authentication server

\n

The response is a json document of the form:

\n

View Morejson

\n
{\n  \"access_token\": \"eyJhb.........A\",\n  \"expires_in\": 300,\n  \"refresh_expires_in\": 1800,\n  \"refresh_token\": \"eyJhb...........A\",\n  \"token_type\": \"bearer\",\n  \"not-before-policy\": 1591634674,\n  \"session_state\": \"0f65368c-90df-4e2f-b039-5320a0b34871\",\n  \"scope\": \"email https://connective.eu/scopes/esignatures profile\"\n}\n\n
\n

When calling the API, the access token must be placed in an Authorization HTTP Header of type “Bearer”. See https://tools.ietf.org/html/rfc6750

\n

NB: a valid User Agent string is required for calls. The default user agent for curl or wget can be blocked by the Web Application Firewall protecting the application.

\n

Security through one-time URLs

\n

The URL lifetime is by default limited to one-time use (unless the administrator disabled the IsOneTimeUrlEnabled setting in the Config Index, which is not recommended). It is therefore recommended to request the stakeholder's actor links just before redirecting them. This way, you make sure they receive the latest generated link.

\n

When end users open an action URL they already used, they will either see a warning or be redirected to a given URL (if available). The only way to achieve this is to request a new URL and provide it to the user. You can do this by retrieving the Actor information via any of the API status calls.

\n

When end users try to take action on a document that has been deleted, a 404 Not found error will occur. This cannot be recovered from, since all information has been purged from eSignatures.

\n

Error Handling Responses

\n

Nitro Sign Enterprise Verified API v4 uses HTTP error codes to give an idea of whether a call succeeded or failed, and a system of error codes in the response body to give more information in case things went wrong.

\n

The used error codes for each call are listed in that call’s section. The meaning of each error code is further explained in Error Code Descriptions.

\n

The error responses are JSON containing the following list of objects:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Errors (array of objects)List of the errorsArray
ErrorCodeError code with variable informationString
MessageError message detail text, not localizedString
\n

A Nitro Sign Premium error code is always displayed as follows:

\n

Resource.Error:parameter

\n

E.g. Package.NotFound:00000000-0000-0000-0000-000000000000. The GUID behind the colon is the packageId that wasn't found.

\n

Error codes can be reused: if the HTTP response code is HTTP 400 Bad Request, an error code like “Document.InvalidTargetFormat” indicates a value that is not supported by Nitro Sign Premium. If the HTTP response code is HTTP 409 Conflict, an error code like “Document.InvalidTargetFormat” means that the request value can currently not be used because the configuration forbids it.

\n

Note: any HTTP 500 Server Error or other 50x responses might deviate from the format described in this section as they are not part of the API.

\n

Full error code descriptions

\n

https://connectivegroup.my.site.com/s/article/API-v4-Error-code-descriptions

\n","auth":{"type":"basic","basic":{"basicConfig":[]},"isInherited":false},"event":[{"listen":"prerequest","script":{"id":"4db56c48-082b-4df9-974e-9bf6bca78399","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"0ef06439-6615-4d41-b8bb-544430eb6f33","type":"text/javascript","packages":{},"exec":[""]}}],"_postman_id":"6aa29a51-1bf2-41e2-a5b2-6f972bbe96e9"},{"name":"v8.2 - Documentation","item":[{"name":"Configuration","item":[{"name":"Gets all contact groups","id":"0cd66726-4b85-4458-a2b8-a6bb01e271df","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get ContactGroups

\n

Description

\n

This call retrieves all the contact groups, and their code, that are currently created in the eSignatures WebPortal.

\n

The ContactGroup code can be entered as a request parameter when doing a Create Package call. Any member of the requested contact group will be able to sign the package for the entire group.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/contactgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of contact groupsArray of objects
NameName of the contact groupString
CodeUnique id of the contact groupString
MaxQuantityMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe contact groups list gets returned successfully.
400 Bad requestA request parameter was invalid.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","urlObject":{"path":["contactGroups"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"1a24e6a2-80d1-4c20-a63b-12112c8f626c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"6cc1c381-aeba-41c0-877c-4bba06daeacc","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n },\n {\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n }\n]"},{"id":"9d435e0b-dce3-41e6-9a42-880e9e5826e0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/contactGroups?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["contactGroups"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"0cd66726-4b85-4458-a2b8-a6bb01e271df"},{"name":"Retrieves all document groups to which packages can be assigned","id":"09fc50aa-38e6-4a21-be1a-e1e3486c39c2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/documentGroups","description":"

Get DocumentGroups

\n

Description

\n

Some requests need to identify a Document Group in which a document is to be used. This request allows to list the names of document groups and most importantly their associated codes.

\n

There is always at least one document group: “My Documents” (the name could be different) with Code “00001”. This group is special because the documents in this group are only visible to the eSignatures Portal user who uploaded the document (in case of an upload made through the API from this document it will be the user whose email was given as Initiator).

\n

Please note that the Code field is a string. Its value may look numeric but its leading zeroes are part of the value.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/documentgroups

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurenceContent / DescriptionType
nameOptionalThe document group name (or part) to search forString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentGroupsList of all document groupsArray of objects
NameName or description of the document groupString
CodeA unique value identifying each document groupString
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document groups gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","urlObject":{"path":["documentGroups"],"host":[""],"query":[{"disabled":true,"description":{"content":"

The document group name (or part) to search for

\n","type":"text/plain"},"key":"name","value":""}],"variable":[]}},"response":[{"id":"7cdd6290-537a-4634-9ef4-50f79b3e81f1","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"DocumentGroups\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ]\n}"},{"id":"cec78bf4-3980-48ff-82a7-139a080462c6","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/documentGroups"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"09fc50aa-38e6-4a21-be1a-e1e3486c39c2"},{"name":"Retrieves all languages that are enabled in the application","id":"c8918cfc-ee8a-469f-95ce-a87587c9ed22","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/languages","description":"

Get Enabled Languages

\n

Description

\n

This call retrieves the list of languages that have been enabled in the eSignatures Configuration Index and are thus available in the eSignatures Portal.

\n

This call is useful for integrators who need to know which languages are currently enabled in a given eSignatures installation.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/languages

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EnabledLanguagesList of enabled languagesArray of objects
DisplayNameDisplayName of the language as defined in the Config Index.String
NativeNameNativeName of the language as defined in the Config Index. The NativeName is the name of the language in its actual language. E.g. français for French.String
IsoCultureCodeISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe EnabledLanguages list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","urlObject":{"path":["languages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0f446045-21bb-4ba4-ad66-54f5e4490abe","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"EnabledLanguages\": [\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n },\n {\n \"DisplayName\": \"\",\n \"NativeName\": \"\",\n \"IsoCultureCode\": \"\"\n }\n ]\n}"},{"id":"09a48af1-9a3a-4f8b-8c9e-17838f710c66","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/languages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c8918cfc-ee8a-469f-95ce-a87587c9ed22"},{"name":"Retrieves all themes that can be assigned to a packages","id":"a44a92b3-d5d6-497a-b670-e8763e7f4c76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","description":"

Get Themes

\n

Description

\n

This call retrieves all the Themes, and their code, that are currently created in the Configuration Index.

\n

The theme code can be entered as a request parameter when doing a Create Package call. The packages in question will then have the requested theming.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/themes

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Query parameters

\n

View More

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
ContinuationTokenOptionalToken which holds information about which set of records needs to be returned.String
MaxQuantityOptionalMaximum number of recordsInt
SortFieldOptionalSort the returned records by the field which is specified. Possible values: 'code' or 'name'.String
SortOrderOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
ContinuationTokenToken which holds information about which set of records needs to be returned.String
ItemsList of themesArray of objects
NameName of the themeString
CodeUnique id of the themeString
MaxQuantityMaximum number of recordsInt
TotalTotal number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe themes list gets returned successfully.
400 Bad requestA request parameter was invalid
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","urlObject":{"path":["themes"],"host":[""],"query":[{"description":{"content":"

The token to return to request the next page

\n","type":"text/plain"},"key":"continuationToken","value":""},{"description":{"content":"

The maximum number of results to return

\n","type":"text/plain"},"key":"maxQuantity","value":"20"},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field to sort

\n","type":"text/plain"},"key":"sortField","value":"code"}],"variable":[]}},"response":[{"id":"06fba45f-87cd-4103-9427-8fbd0bcc0188","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ContinuationToken\": \"\",\n \"Items\": [\n {\n \"Code\": \"\",\n \"Name\": \"\"\n },\n {\n \"Code\": \"\",\n \"Name\": \"\"\n }\n ],\n \"MaxQuantity\": \"\",\n \"Total\": \"\"\n}"},{"id":"ca06b00e-3438-4de8-a9c3-39bd970ba1dd","name":"When the MaxQuantity value was too large or the ContinuationToken invalid","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"caad6cda-081f-44f5-8dbf-bee117fb5006","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/themes?continuationToken=&maxQuantity=20&sortOrder=desc&sortField=code","host":[""],"path":["themes"],"query":[{"description":"The token to return to request the next page","key":"continuationToken","value":""},{"description":"The maximum number of results to return","key":"maxQuantity","value":"20"},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field to sort","key":"sortField","value":"code"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"a44a92b3-d5d6-497a-b670-e8763e7f4c76"},{"name":"Retrieves the version of the WebSigner application","id":"04d93bd4-d3b0-47ed-9d82-1fc70a67c8ac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/version","description":"

Get Version

\n

Description

\n

This call checks the version and build number of eSignatures.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/version

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ProductVersionNumber of the versionString
FileVersionNumber of the file (build)String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe version and build number get returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
NoneNo error messages possible
\n
","urlObject":{"path":["version"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0fa9e0f2-3acd-4aa7-9dbb-48018da49d7e","name":"OK","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ProductVersion\": \"\",\n \"FileVersion\": \"\"\n}"},{"id":"fba8e31f-ff89-46af-8d5a-e412ddc6abdf","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":"/version"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"04d93bd4-d3b0-47ed-9d82-1fc70a67c8ac"}],"id":"90052b52-4b7d-451e-89a3-4bc10f86971e","description":"

Retrieving information about the configuration

\n","_postman_id":"90052b52-4b7d-451e-89a3-4bc10f86971e"},{"name":"Packages","item":[{"name":"Gets all packages","id":"faa39f34-7d14-40df-92e0-2803ad9621c1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc&detailed=true","description":"

Get packages

\n

Description

\n

This call retrieves all packages that currently exist within eSignatures, and their current status.

\n

Packages are always sorted on creationDate.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.Integer
PageSizeMaximum number of records in the response Default value is 20 when Detailed, otherwise 100Integer
CreatedBeforeGets only the packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the packages created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
DocumentGroupCodeGets items that have given documentGroupCode. An admin may configure document groups in eSignatures to which users can upload their documents. The documentGroupCode is the identifier of the document group to which the package has been uploaded.String
InitiatorGets only the packages created by the specified initiator email address.String
PackageNameGets packages that have the specified name as package name.String
ExternalReferenceGets packages with the specified value as external package reference. Note this only applies for external package references, not external document/field references.String
SortDetermines how the result is sorted. Available values are asc, desc.

Default value: desc		String (enum)
DetailedSpecifies whether to return a detailed (true) or a simplified (false) list of packages.

Default value: true		Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. Default value is 20 when Detailed, otherwise 100Integer
TotalTotal number of items.Integer
ItemsThe packages that are retrieved.Obects
\n

With the Detailed flag set to true , the Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Whereas the simplified Response parameters per package are described below.

\n

Item (simplified) response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the package.String (GUID)
NameName of the package. Minimum length: 1 Maximum length: 150String
StatusStatus of the package.String (enum)
IsActionNeededIndicates that actions are required to keep or remove signature, form or signing fields in a not fully processed document.
Presented only for the status of the package is Draft.		Boolean
CreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00:00ZString (date-time)
ExpiryDateDate and time when the package will expire. Format is ISO 8601 date-time. E.g. 2020-01-25T13:00:00:00ZString (date-time)
RevocationDateDate and time when the package was revoked. Format is ISO 8601 date-time. E.g. 2020-01-25T13:00:00:00ZString (date-time)
InitiatorEmail address of the user who sent the package. This must be a known user of the WebPortal.String (email)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
DocumentGroupCodeIdentifier of the document group to which the package will be added.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

Select items that have given initiator email address

\n","type":"text/plain"},"key":"initiator","value":""},{"description":{"content":"

Select items that have given package name

\n","type":"text/plain"},"key":"packageName","value":""},{"description":{"content":"

Select items that have given external reference

\n","type":"text/plain"},"key":"externalReference","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"},{"description":{"content":"

Specifies whether to return a detailed (true) or a simplified (false) list of packages.

\n","type":"text/plain"},"key":"detailed","value":"true"}],"variable":[]}},"response":[{"id":"be41051b-49fe-4c8a-b719-fd9a692f15fd","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Processing\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"document\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n },\n {\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"InProgress\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Rejected\",\n \"Elements\": [\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"ProcessingFailed\",\n \"Elements\": [\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n }\n ]\n}"},{"id":"f6d093a3-1ea5-4281-b8ee-02266e4febe0","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&status=&documentGroupCode=&initiator=&packageName=&externalReference=&sort=desc","host":[""],"path":["packages"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have a specific status","key":"status","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"Select items that have given initiator email address","key":"initiator","value":""},{"description":"Select items that have given package name","key":"packageName","value":""},{"description":"Select items that have given external reference","key":"externalReference","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"faa39f34-7d14-40df-92e0-2803ad9621c1"},{"name":"Creates a new package","id":"219204dd-cf67-4c24-a898-e996971132b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\r\n \"Name\": \"\",\r\n \"Initiator\": \"\",\r\n \"Status\": \"pending\",\r\n \"ExpiryDate\": \"\",\r\n \"DefaultLegalNotice\": {\r\n \"Name\": \"\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Name\": \"\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"PdfOptions\": {\r\n \"TargetFormat\": \"pdfa1a\"\r\n },\r\n \"Base64data\": \"\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n }\r\n ],\r\n \"Stakeholders\": [\r\n {\r\n \"Type\": \"person\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\",\r\n \"PhoneNumber\": \"\",\r\n \"AdditionalProperties\": {\r\n \"BeId\": \"\",\r\n \"BeLawyer\": \"\"\r\n },\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 0,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 0,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"Type\": \"group\",\r\n \"GroupName\": \"\",\r\n \"Members\": [\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n },\r\n {\r\n \"Language\": \"en\",\r\n \"FirstName\": \"\",\r\n \"LastName\": \"\",\r\n \"EmailAddress\": \"\",\r\n \"BirthDate\": \"\"\r\n }\r\n ],\r\n \"Actors\": [\r\n {\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 1,\r\n \"Elements\": [\r\n {\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 1,\r\n \"signingMethods\": [\r\n {\r\n \"name\": \"Manual:handwritten\",\r\n \"keypair\": \"\"\r\n }\r\n ],\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"ThemeCode\": \"string\",\r\n \"CallBackUrl\": \"https://callback.test\",\r\n \"NotificationCallBackUrl\": \"https://notifications.test\",\r\n \"DefaultRedirectUrl\": \"\",\r\n \"F2fRedirectUrl\": \"\",\r\n \"IsUnsignedContentDownloadable\": true,\r\n \"IsReassignEnabled\": false,\r\n \"ExternalReference\": \"myFirstPackage\",\r\n \"ActionUrlExpirationPeriodInDays\": 7,\r\n \"ProofCorrelationId\": \"\",\r\n \"AddInitiatorAsReceiver\": false,\r\n \"MustBeArchived\": true,\r\n \"ArchiveAuditProofs\": false,\r\n \"ArchiveAuditTrail\": false,\r\n \"AutomaticReminder\": {\r\n \"IsSendAutomaticRemindersEnabled\": true,\r\n \"DaysBeforeFirstReminder\": 2,\r\n \"IsRepeatRemindersEnabled\": true,\r\n \"RepeatReminders\": 3\r\n },\r\n \"ExpirationReminder\": {\r\n \"IsSendExpirationRemindersEnabled\": true,\r\n \"DaysBeforeExpirationReminder\": 2\r\n },\r\n \"OtpAuthenticationSetting\": {\r\n \"IsSmsOtpAuthenticationEnabled\": false,\r\n \"IsMailOtpAuthenticationEnabled\": true\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages","description":"

API 4: Create package

\n

Description

\n

The POST package call creates an empty package, to which documents can be added later on.

\n

In its simplest form, this method contains only two request parameters: the package name and the initiator, which is the user who will be sending the packages. Afterwards you can build on this method by adding additional resources. You can add documents, elements, stakeholders, actors, etc. by using their respective calls.

\n

You can also choose to define all parameters in a single POST package call, making it a so-called \"super call\".

\n

Size limitations

\n

Consider the following size limitations when creating packages.

\n
    \n

  • A package must not exceed 150 MB.

    \n
    • \n

  • A package must not contain more than 15 documents and each document must not exceed 30 MB.

    \n
    • \n

  • An .xml file must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.

    \n
    • \n

  • Large files might affect signing performance depending on the user's Internet connection.

    \n
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n

The parameters with an asterisk are mandatory. All others are optional.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the package. The name is displayed in the eSignatures WebPortal, and used as file name when you download the package as .zip file from the WebPortal. Note: do not add an extension to the Name value Important: Pay attention when choosing a package name. Don’t use forbidden file name characters such as slash (/), backslash (), question mark (?), percent (%), asterisk (*), colon (:), pipe (), quote (‘), double quote (\"), less than (<), greater than (>). Note however, that is list is not exhaustive. Don’t use characters that are HTML-sensitive such as ampersand (&) or apostrophe (‘). Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150
Initiator*The email address of the user who will send the package. The user must be a known user in the eSignatures WebPortal.String (email)
StatusThe status the package will be in when created. The possible values are: draft or pending. By default, a package is in draft after creation.String (enum)
DocumentGroupCodeThe documentGroupCode is the identifier of the document group to which the package must be uploaded. In a default configuration, an initiator uploads packages to their personal MyDocuments folder, which cannot be shared with others. To enable collaboration however, an eSignatures admin can configure multiple document groups to which different users may have access. This way, they can collaborate on one another's' documents. To upload packages to the MyDocuments folder, do not use this parameter, or specify value 00001. To upload packages to a specific document group, enter its documentGroupCode. Tip: to know which document groups have been configured in eSignatures, use the Get document groups call.String
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time. E.g. 2018-01-23T12:34:00.000ZString (date-time)
DocumentsDocuments in base64 encoded format that must be added to the package. The request parameters regarding documents are identical to those of the Add document call and are described here.Array of objects
StakeholdersStakeholders that must be added to the package. A stakeholder is an object that provides information about any person who is involved with the package. The request parameters regarding stakeholders are identical to those of the Create stakeholder call and are described here.Array of objects
DefaultLegalNoticeThe default legal notice that will be added to a signer when no legal notice is specified. See the section defaultLegalNotice below for more info.Object
ThemeCodeDefines which themeCode must be applied to the package. An eSignatures admin can rebrand the look and feel of the eSignatures WebPortal by creating and configuring new themes. Each theme has a themeCode to identify it. When this parameter is not used, the theme that has been configured on environment level in the Configuration Index, or on document group level if applicable will be applied.String
CallBackUrlThe Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place. See Callback URL details below.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URL. Since eSignatures by default uses one-time URLs, the link to sign a package only works once. As soon at is has been clicked, the link expires and a new signing link must be requested.String (url)
DefaultRedirectUrlDefault URL to which stakeholders will be redirected after completing their actions. Set on package submit, when actor has no RedirectUrl. New since eSignatures 7.0.String (url)
F2fRedirectUrlURL to which the end user is redirected after all fields have been signed or rejected face to face in the Document Portal. See the F2fRedirectUrl Details section below for more information.

Attention: Don't confuse the f2fRedirectUrl with the regular RedirectUrl. The f2fRedirectUrl only applies when signing face to face in the Document Portal. The redirect occurs after signing or rejecting. This field must be a valid absolute url.

Note: during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new url after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.		String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting. Enter ‘true’ if you want actors to be able to download the package before form filling/approving/signing. This way they can print it and read it on paper for instance. Enter ‘false’ to hide the download icon and prevent actors to be able to download packages from the WYSIWYS. When this parameter is not used, the value from the Config Index setting IsDownloadUnsignedFilesEnabled under Customization Settings is used.Boolean
IsReassignEnabledDetermines whether a stakeholder may reassign their action to another party. Enter ‘true’ if you want actors to be able to reassign the package. Enter ‘false’ to hide the reassign button and prevent actors to be able to reassign packages from the WYSIWYS. When no value is entered, this parameter takes it value from the Config Index setting IsReassignEnabled under Customization Settings.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String (GUID)
AddInitiatorAsReceiverThis parameter is available as of eSignatures 6.5.0. It determines whether the initiator is added by default as receiver of the package. This way, you no longer need to do this manually in a Create actor call.

This parameter allows to override the default environment level setting IsAddInitiatorAsReceiverEnabled set in the Configuration Index.
Note however that when that setting is set to true, it is unnecessary to pass the AddInitiatorAsReceiver parameter, since each initiator is then added as receiver by default.		Boolean
MustBeArchivedAvailable as of eSignatures 6.6.0, this parameter enables you to determine whether the package should be archived or not.
Note: The value will be ignored if archiving is not configured on an environment level in the Config Index.
When archiving is configured, it is unnecessary to pass the MustBeArchived parameter, since each package is then archived by default.		Boolean
ArchiveAuditProofsAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit proofs must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit proofs are disabled in the audit tools settings or in the archive settings.		Boolean
ArchiveAuditTrailAvailable as of eSignatures 6.6.0, this parameter indicates whether the audit trail must be archived.
Note: The parameter will be ignored if archiving is not configured or if audit trail is disabled in the audit tools settings or in the archive settings.		Boolean
TemplateCodeDefines which template will be used for the package. When using a template code the package will have all the information from the predefined template already implemented, You can still add or change information using additional api calls.
Note: When using a templateCode the only other mandated parameter is the \"Initiator\", the following are optional: \"name\", \"ExternalReference\" and \"ProofCorrelationId\" all others will be overwritten by the template itself.		String
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:

- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer). The minimum value: 1.
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer). The minimum value: 1.

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:

- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer). The minimum value: 1.

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that will be applied to the signer when no legal notice is specified.

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive*.

\n

*When using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

When defining a defaultLegalNotice, you can choose from two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LEGALNOTICE1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

The maximum length of the text value is 1000 characters (including fill-in values). When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable.

\n

Instant Package

\n

API v4 allows to mimic the 'Instant Package' functionality available within API v3. This is possible by combining all different objects within one call (not applicable when using a templateCode)

\n
    \n

  • Create Package

    \n
    • \n

  • Add document(s)

    \n
    • \n

  • Add element(s)

    \n
    • \n

  • Add stakeholder(s)

    \n
    • \n

  • Add actor(s)

    \n
    • \n

  • Add process

    \n
    • \n
\n

This does bring one additional concept to take into account when adding multiple documents, as you will need to define for which document you are adding the stakeholder(s) / actor(s). As at this point you have not yet received the documentId, the concept of documentIndex has been introduced on element level. The documentIndex is being used to identify the document for which the actor is being added, 0 being the first document in the call, 1 the second and so on.

\n

Response parameters

\n

The Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe package was created successfully.
400 Bad requestRequest validation failed. The package could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
409 ConflictThe package could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP codeCode
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Package.InitiatorInvalid
400Url.Invalid
400Request.UnsupportedValue
400Document.UnsupportedLanguage
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400LegalNotice.NameAndTextUsedSimultaneously
401Authentication failed, username or password incorrect
404DocumentGroup.NotFoundWithCode
404Theme.NotFoundWithCode
404User.NotFound
404Actor.NotFound
404Stakeholder.NotFound
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
409Document.DataMissing
409SigningField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
409Package.UnassignedElements
\n

CallbackUrl Details

\n

The Callback URL is used to contact external systems. When certain status changes happen, the given URL will be used to send an HTTP POST request, informing the external system that a change has taken place.

\n

A callback happens in the following cases:

\n
    \n

  • A user has changed the status of the package created via API from Draft to Pending through the Document Portal.

    \n
    • \n

  • A user has clicked confirm in a Drag and drop editor window.

    \n
    • \n

  • A user has revoked the package through the Document Portal.

    \n
    • \n

  • One of the signers has completed all their signing fields.

    \n
    • \n

  • All signers signed the package.

    \n
    • \n

  • One of the signers has rejected the package.

    \n
    • \n

  • The approver approved the package.

    \n
    • \n

  • The form fillers completed the fields.

    \n
    • \n

  • The status of the package has been changed to Failed by the system.

    \n
    • \n
\n

Note: API requests explained in this document will never trigger a callback. A callback will happens only when an end user triggers an action in the eSignatures Portal or Signer application. Other triggers might be added in the future.

\n

The callback URL must contain a valid, absolute URL with no parameters.

\n

eSignatures 6.4.1 to current:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"Finished\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

As of eSignatures 6.0, the base URL CallbackURL only contains PackageId as parameter. The PackageStatus is passed in the application/json body. Prior to 6.0, the base URL contained both the packageId and the packageStatus - also notice the difference in casing. If you're upgrading from eSignatures 5.x and have an existing integration you don't want to break, make sure to select the legacy or both option under API Settings in the Config Index. That way, the PackageId and PackageStatus parameters are still appended to the base URL. The body uses parameters starting with a lower case, such as 'packageId', while the CallbackURL uses parameters that start with a capital letter, such as 'PackageId'.

\n

Until eSignatures 6.3.x:

\n

The POST request by default uses an application/json body containing:

\n
    \n

  • packageId

    \n
    • \n

  • packageStatus

    \n
    • \n
\n

E.g. {\"packageId\":\"d2912916-c555-47af-b666-1e8cf2eb9dfa\",\"packageStatus\":\"FullySigned\"}

\n

If the external system requires extra information, then a Get package by ID call can be used.

\n

Important:

\n
    \n
  • If you are upgrading from eSignatures 5.x, and you want to append the PackageId and PackageStatus to the base URL, as was the standard behavior in eSignatures prior to version 6.0, make sure to select the legacy or both option under API Settings in the Config Index.
    • \n
\n

However that there is a difference in casing between the two eSignatures versions. As of version 6.0, camel casing in used. If your integration is case-sensitive, it will fail on the callback verification, since it expects the parameters \"PackageId\" and \"PackageStatus\" in the CallbackURL instead of \"packageId\" and \"packageStatus\". This casing issue has been solved in eSignatures 6.4.1.

\n
    \n
  • For performance and scalability purposes, a Callback timeout has been introduced and is set to 100 seconds. This way, if the driving application doesn’t respond to eSignatures’ callback, a timeout will be forced, and the rest of the flow will be finished as if the expected 200 OK message were received. If eSignatures were to wait indefinitely for a response to finish the package, its performance would drop drastically.
    • \n
\n

For this reason, it’s highly recommended that the client’s callback service is developed in such a way that it sends its response as soon as possible. Any other actions done by the callback service must not depend on the response being sent but should function asynchronously.

\n

In case a Callback error should occur, eSignatures by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See the Installation Documentation for more information.

\n

Notification Callback Details

\n

The Notification Callback parameter, if specified, will in certain cases override the usual behavior of sending out emails and triggers a remote service instead. The remote service must then retrieve information about the package and choose what to do.

\n

While the normal callback is called for major state changes, the notification callback can be called multiple times without any apparent change. For that reason, the callback includes information about the type of notification which was requested.

\n

The remote server is called only once per user action; there is no retry unless the end user requests a new notification.

\n

This callback system may at one point be superseded by a more generic extension mechanism for notifications. At that point only the more generic mechanism will receive improvements.

\n

eSignatures waits for this remote service to complete its job before returning control to the end user. Therefore the remote service needs to give a response within seconds.

\n

A callback consists of a POST request to the specified URL with content-type application/json. The following parameters are available in the JSON body:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the packageString (GUID)
actorIdIdentifier of the actor for which the notification was triggeredString (GUID)
languageThe language which the end user was told to use (see the Language parameter in the Stakeholder object of the Set Process Information call).String
notificationTypeKeyWhich kind of notification was requestedString
\n

A callback may currently happen in the following cases:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
notificationTypeKeyUse Case
SendActionUrlThe single-use action (form filler, approver, signer) link has been used already and the end user requested a new link.
SendDownloadUrlThe single-use download link has been used already and the end user requested a new link.
\n

Since this list may grow in the future, the remote service will need to ignore other types without returning an error response.

\n

Other use cases will not send a callback until explicitly listed in the table above. The existing emails sent when a package is created, revoked, etc. will depend on the SuppressNotifications parameter which is separate from the NotificationCallbackUrl.

\n

In case a callback error should occur, eSignatures now by default retries to do the callback 3 times, during 3 retry cycles. System administrators may customize this retry mechanism in the Worker config file. See Installation Documentation of the latest released version for more information.

\n

F2FRedirectUrl Details

\n

The F2FRedirectUrl is used to redirect the end user after all fields have been signed or rejected face to face in the Document Portal.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create Package call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. PackageId)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • Within the RedirectUrl, the ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly distinguish it within the generated RedirectUrl.
    For consistency, the F2FRedirectUrl response parameter is also named PackageExternalReference.

    \n
    • \n
\n

The F2FRedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.

\n

For example, if the F2FRedirectUrl parameter contains the following redirect URL:

\n

https://myserver.example.org/rental/services/testredirect

\n

Then, the effective F2FRedirectUrl will be:

\n

https://myserver.example.org/rental/services/testredirect??PackageExternalReference=DemoReference&Status=SIGNED&SessionID=38bb590e-1eca-4c98-bf0c-bf1af2347000

\n

The end user can counterfeit the F2FRedirectUrl because the redirection happens client-side.
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

During asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a F2FRedirectUrl however is to redirect the signer to a new URL after the signing has finished. Therefore, when a F2FRedirectUrl is configured, the Close button will be unavailable, and a message is displayed informing the signers they will be redirected.

\n","urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"f59c25ec-ee1b-47ee-9127-e28a0c04789d","name":"Package was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"Name\": \"example package\",\n \"Initiator\": {\n \"value\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"SingleMarkerMatchPerElement\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages","description":"

API 4: Create package from template

\n

Description

\n

The POST package call creates a package based on an existing template.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n

The parameters with an asterisk are mandatory. All others are optional.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameName of the package. The name is displayed in the eSignatures WebPortal, and used as file name when you download the package as .zip file from the WebPortal. Note: do not add an extension to the Name value Important: Pay attention when choosing a package name. Don’t use forbidden file name characters such as slash (/), backslash (), question mark (?), percent (%), asterisk (*), colon (:), pipe (), quote (‘), double quote (\"), less than (<), greater than (>). Note however, that is list is not exhaustive. Don’t use characters that are HTML-sensitive such as ampersand (&) or apostrophe (‘). Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150
Initiator*The email address of the user who will send the package. The user must be a known user in the eSignatures WebPortal.String (email)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
TemplateCode*Defines which template will be used for the package. When using a template code the package will have all the information from the predefined template already implemented, You can still add or change information using additional api calls.
Only other mandated parameter is the \"Initiator\", the following are optional: \"name\", \"ExternalReference\" all others will be overwritten by the template itself.		String
SingleMarkerMatchPerElementControls the lifecycle of unplaced elements (originating from template) identified by document markers. Defaults to 'false'.
- 'false' (or 'null'): Allows an element definition to be matched by markers in multiple documents; cleanup of remaining unplaced elements is deferred.
- 'true': Each element definition can only be matched by one marker during document confirmation; the definition is removed after being placed.		Boolean
\n

Response parameters

\n

The Response parameters are identical to the ones of the Get package by ID call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe package was created successfully.
400 Bad requestRequest validation failed. The package could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
409 ConflictThe package could not be created.
\n
","urlObject":{"path":["packages"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"428a4d86-7fb2-4fc1-ab03-66edbb1b81e3","name":"Package was created.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":"{\r\n \"Id\": \"CD758AE3-5382-48B2-A4F3-DD76C7200EE0\",\r\n \"Name\": \"example pending package\",\r\n \"Initiator\": \"hello@world.test\",\r\n \"Status\": \"pending\",\r\n \"ExpiryDate\": \"2020-01-17T12:33:47.923Z\",\r\n \"DefaultLegalNotice\": {\r\n \"Name\": \"LegalNotice1\"\r\n },\r\n \"Documents\": [\r\n {\r\n \"Id\": \"1E501B99-9F0F-4F12-9AD9-6C737C6394E8\",\r\n \"Name\": \"my first document\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"doc0\",\r\n \"ProofCorrelationId\": \"correlation identifier\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"PdfOptions\": {\r\n \"TargetFormat\": \"pdfa1a\"\r\n },\r\n \"Base64data\": \"string\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n },\r\n {\r\n \"Id\": \"1BAE1A85-BF29-426C-A9B6-D7BD330CF4CD\",\r\n \"Name\": \"my second document\",\r\n \"Language\": \"en\",\r\n \"ExternalReference\": \"doc1\",\r\n \"DocumentOptions\": {\r\n \"TargetType\": \"application/pdf\",\r\n \"Base64data\": \"string\",\r\n \"ContentType\": \"application/pdf\"\r\n }\r\n }\r\n ],\r\n \"stakeholders\": [\r\n {\r\n \"Id\": \"C2CEBEEF-A9BB-4BF8-9FD9-7F78EBC80CC2\",\r\n \"Type\": \"person\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"EmailAddress\": \"john@doe.test\",\r\n \"BirthDate\": \"1990-01-16\",\r\n \"PhoneNumber\": \"+32xxxxxxxxx\",\r\n \"AdditionalProperties\": {\r\n \"BeId\": \"12345678900\",\r\n \"BeLawyer\": \"b459d74c-1f90-4d63-9f4a-6de9cead8c5e\"\r\n },\r\n \"Actors\": [\r\n {\r\n \"Id\": \"5D197888-8660-4374-BB42-102A4F6E35C4\",\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 0,\r\n \"Elements\": [\r\n {\r\n \"Id\": \"F77A4B19-ADEB-495B-A098-1E99DB0E42FD\",\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 0,\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ],\r\n \"Links\": [\r\n \"https://api.example.test/signinit?packageSignId=cd758ae3-5382-48b2-a4f3-dd76c7200ee0&token=123\"\r\n ]\r\n }\r\n ]\r\n },\r\n {\r\n \"Id\": \"57274DC0-2B9F-4A1E-B9FD-CFD1C1893683\",\r\n \"Type\": \"group\",\r\n \"GroupName\": \"Great mates\",\r\n \"Members\": [\r\n {\r\n \"Id\": \"750FC8F4-00D0-4247-AA5A-9323A1E1F740\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"John\",\r\n \"LastName\": \"Doe\",\r\n \"EmailAddress\": \"john@doe.test\",\r\n \"BirthDate\": \"1990-01-16\"\r\n },\r\n {\r\n \"Id\": \"BE89E158-4278-41E7-BF33-7EE6F8B2ECFB\",\r\n \"Language\": \"en\",\r\n \"FirstName\": \"Zu\",\r\n \"LastName\": \"Li\",\r\n \"EmailAddress\": \"zu@li.test\",\r\n \"BirthDate\": \"1991-03-14\"\r\n }\r\n ],\r\n \"Actors\": [\r\n {\r\n \"Id\": \"F62C2D0D-42E2-48E9-BA4B-C9825290C474\",\r\n \"Type\": \"signer\",\r\n \"ProcessStep\": 1,\r\n \"Elements\": [\r\n {\r\n \"Id\": \"E62DB347-5ED1-48DA-91A3-90A660AA18CC\",\r\n \"Type\": \"signingField\",\r\n \"DocumentIndex\": 1,\r\n \"Location\": {\r\n \"Page\": 2,\r\n \"Top\": 200,\r\n \"Left\": 200\r\n },\r\n \"Dimensions\": {\r\n \"Width\": 200,\r\n \"Height\": 200\r\n }\r\n }\r\n ],\r\n \"Links\": [\r\n \"https://api.example.test/signinit?packageSignId=cd758ae3-5382-48b2-a4f3-dd76c7200ee0&token=321\"\r\n ]\r\n }\r\n ]\r\n }\r\n ],\r\n \"ThemeCode\": \"string\",\r\n \"CallBackUrl\": \"https://callback.test\",\r\n \"NotificationCallBackUrl\": \"https://notifications.test\",\r\n \"IsUnsignedContentDownloadable\": true,\r\n \"ExternalReference\": \"myFirstPackage\",\r\n \"MustBeArchived\": true,\r\n \"ArchiveAuditProofs\": false,\r\n \"ArchiveAuditTrail\": false\r\n}"},{"id":"0853992f-912d-4073-984d-560f42ee3d66","name":"The package could not be created.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Name\": \"\",\n \"Initiator\": \"\",\n \"TemplateCode\": \"\",\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3358eba7-6150-459a-bbfe-777a98598fee"},{"name":"Gets a package by id","id":"fc8ecd7b-06d7-406d-b66c-7e1a2ddaa872","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId","description":"

Get package by ID

\n

Description

\n

This call allows you to retrieve a package by its ID.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the package.String (GUID)
NameName of the package. Minimum length: 1 Maximum length: 150String
StatusStatus of the package.String (enum)
CreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00:00ZString (date-time)
ExpiryDateDate and time when the package will expire. Format is ISO 8601 date-time. E.g. 2020-01-25T13:00:00:00ZString (date-time)
InitiatorEmail address of the user who sent the package. This must be a known user of the WebPortal.String (email)
UnplacedElementsDetails of each of the elements that have not been placed or sized in a document. The unplaced element response parameters are the same as the element response parameters listed in the tables below, except that they do not have a location and dimension.Array of objects
DocumentsThe documents that were added to the package. The document response parameters are listed in the table below.Array of objects
StakeholdersThe stakeholders that were added tp the package. The stakeholder response parameters are listed in the table below.Array of objects
DefaultLegalNoticeDefault legal notice that has been added for the signer(s). The default legal notice response parameters are listed in the table below.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
DocumentGroupCodeIdentifier of the document group to which the package will be added.String
ThemeCodeIdentifier of the themeCode that has been applied to this package.String
CallBackUrlLink that will be called upon each status change. See CallbackUrl Detailsbelow for more info.String (url)
NotificationCallBackUrlURL that will be called each time the signer requests a new signing URLString (url)
F2fSigningUrlLink to the package which allows to start a face to face signing session.String (url)
PreviewUrlLink to access the preview for a pending package.String (url)
F2fRedirectUrlLink to which the end user is redirected when all fields have been signed, or when a field has been rejected. Attention: not to be confused with a \"regular\" redirectUrl.String (url)
IsUnsignedContentDownloadableDetermines whether an actor can download the package from the WYSIWYS page (What You See Is What You Sign), before form filling, approving, signing or rejecting.Boolean
ActionUrlExpirationPeriodInDaysThis parameter determines after how many days the action URLs must expire when they are not used. When no value is entered, this parameter takes its value from the Config Index setting IsActionUrlExpirationEnabled under Customization Settings.Integer
ProofCorrelationIdIdentifier to correlate this package to other resources in the proofs system.String
AddInitiatorAsReceiverWhether or not the initiator has been added as receiver of this package.
Note: This parameter is only returned for draft packages.		Boolean
WarningsWarning about the package, e.g., missing data. The warning response parameters are listed in the table below.Object
MustBeArchivedWhether or not the package will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditProofsWhether or not the audit proofs will be sent to the external archive when the package status is Finished.Boolean
ArchiveAuditTrailWhether or not the audit trail will be sent to the external archive when the package status is Finished.Boolean
AutomaticReminderIf enabled, reminders are automatically sent to stakeholders who have not completed their tasks yet.

Child parameters:
- IsSendAutomaticRemindersEnabled (boolean).
- DaysBeforeFirstReminder (integer).
- IsRepeatRemindersEnabled (boolean).
- RepeatReminders (integer).

Note: Even if the SuppressNotifications parameter is set to true for an actor, this actor still gets automatic reminders.		Object
ExpirationReminderAvailable if the parameter ExpiryDate has a value.

If enabled, stakeholders are automatically notified that the link to a package will expire.

Child parameters:
- IsSendExpirationRemindersEnabled (boolean).
- DaysBeforeExpirationReminder (integer).

Note: Even if the parameter SuppressNotifications is set to true for an actor, this actor still gets the expiration reminder.		Object
OtpAuthenticationSetting (as of 7.5.0)Contains settings for the package OTP authentication on WYSIWYS.

Enables or disables the ability to authenticate an actor with SMS or Mail code when entering to the WYSIWYS, before taking action on the package.

Child parameters:
- IsSmsOtpAuthenticationEnabled (boolean).
- IsMailOtpAuthenticationEnabled (boolean).

Note: If only IsSmsOtpAuthenticationEnabled is true, all stakeholders will be required to have a phone number.		Object
\n

Document response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. The element response parameters are listed in the tables below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Further information regarding documents is identical to those of the Add document call and is described here.

\n

Element response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document. The location response parameters are listed in the table below.Object
DimensionsDimensions of the element. The dimensions response parameters are listed in the table below.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field. The legal notice response parameters are listed in the table below.Object
MarkerType (as of 7.5.0)The type of marker of an unplaced element. Possible values: None, Text, PdfFormField. Note: Only viable for unplaced elements of a package.String (enum)
MarkerId (as of 7.5.0)A piece of text or PDF field identifier of the corresponding MarkerType. Note: Only viable for unplaced elements of a package.String (date)
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Further information regarding elements is identical to those in the Create element call and is described here .

\n

Stakeholder response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. The actor response parameters are listed in the table below.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Further information regarding stakeholders is identical to those of the Create stakeholder call and is described here.

\n

Actor response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers. The result response parameters are listed in the table below.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
Links/MemberLinksThis parameter defines links for interacting with the package.String (url)
ActionUrlsThis parameter will lead to the download for a Receiver, for other actors it will lead to the WYSIWYS or the Preview.Array of objects
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByThe actor information see table belowObject
CompletedDateDate when the action was completed.String (date-time)
RejectReasonReason why a document was rejected.String
\n

CompletedBy

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

ActionUrls

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
UrlLinks to interact with the package.String (url)
TypeType of the ActionUrl.String
\n

Further information regarding actors is identical to those of the Create actor call and is described here.

\n

DefaultLegalNotice

\n

The defaultLegalNotice object defines the default legal notice that is applied to the signing field. A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive. However, when using legal notices in which the signer must enter variable values, these values are not case-sensitive.

\n

There are two defaultLegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Warning schema

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage is successfully retrieved.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId"],"host":[""],"query":[],"variable":[{"id":"b9489a97-4bed-4c51-9277-d6d9587aaf75","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c2913317-41af-4bf7-852b-173d22961690","name":"Package was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Name\": \"\",\n \"Status\": \"Finished\",\n \"IsActionNeeded\": \"\",\n \"CreationDate\": \"\",\n \"ExpiryDate\": \"\",\n \"RevocationDate\": \"\",\n \"Initiator\": \"\",\n \"UnplacedElements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"Documents\": [\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"InProgress\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Processing\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n ],\n \"Stakeholders\": [\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Finished\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n ],\n \"DefaultLegalNotice\": {\n \"Text\": \"\"\n },\n \"ExternalReference\": \"\",\n \"DocumentGroupCode\": \"\",\n \"ThemeCode\": \"\",\n \"CallBackUrl\": \"\",\n \"NotificationCallBackUrl\": \"\",\n \"F2fSigningUrl\": \"\",\n \"PreviewUrl\": \"\",\n \"DefaultRedirectUrl\": \"\",\n \"F2fRedirectUrl\": \"\",\n \"IsUnsignedContentDownloadable\": \"\",\n \"IsReassignEnabled\": \"\",\n \"ActionUrlExpirationPeriodInDays\": \"\",\n \"ProofCorrelationId\": \"\",\n \"AddInitiatorAsReceiver\": \"\",\n \"MustBeArchived\": \"\",\n \"ArchiveAuditProofs\": \"\",\n \"ArchiveAuditTrail\": \"\",\n \"Warnings\": [\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"archiving\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n ],\n \"AutomaticReminder\": {\n \"IsSendAutomaticRemindersEnabled\": \"\",\n \"DaysBeforeFirstReminder\": \"\",\n \"IsRepeatRemindersEnabled\": \"\",\n \"RepeatReminders\": \"\"\n },\n \"ExpirationReminder\": {\n \"IsSendExpirationRemindersEnabled\": \"\",\n \"DaysBeforeExpirationReminder\": \"\"\n }\n}"},{"id":"4fc3f516-bd98-4602-bd97-b040934f5852","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2909e8a1-2d83-4bc1-b4d7-6dc884def2e7","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId","host":[""],"path":["packages",":packageId"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"fc8ecd7b-06d7-406d-b66c-7e1a2ddaa872"},{"name":"Deletes a package by id","id":"cb2ee4a4-9c8c-4bd0-ab01-a1d9b6eea770","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId?delayedDeletionTime=","description":"

Delete package by ID

\n

Description

\n

This call allows you to delete a package from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use the DELETE packages by ID call.

\n

Note: you can only delete a package that has status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package that must be deleted.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of this package will be deleted, once the package has been deleted. When this parameter is not sent, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictPackage could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId"],"host":[""],"query":[{"description":{"content":"

The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.

\n","type":"text/plain"},"key":"delayedDeletionTime","value":""}],"variable":[{"id":"6e1c09e0-6baa-4c69-93cc-c27fc762cdd9","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"cea2b808-5ecc-4d20-aedb-76b1dfd7df68","name":"Package was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c434c07a-ecef-4167-8681-b88c57ff9859","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"840019a3-2ebd-4af1-b017-1941fa6a6805","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"958c2417-b8a8-4b8e-8154-15246faa4923","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d48bb5c6-adb2-420c-8df6-f90b28e0f7c8","name":"Package could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId?delayedDeletionTime=","host":[""],"path":["packages",":packageId"],"query":[{"description":"The audit proof info will be kept this many additional days, therefore the number needs to be positive. The default value from the config is used if left unspecified.","key":"delayedDeletionTime","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"cb2ee4a4-9c8c-4bd0-ab01-a1d9b6eea770"},{"name":"Gets a package's expiry date by","id":"cc1bf5e1-7a54-4637-950b-8c1a9849fb40","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/expirydate","description":"

Get package expiry date

\n

Description

\n

This method allows you to retrieve the expiry date of a package.

\n

The only template parameter you need to use is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKPackage expiry date was successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"5be91ff4-0258-4382-8160-f778ce2dee59","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"d2f66d1f-25b7-4461-ad55-f6fd42bfdf50","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"0c7a19cb-a623-4ea1-9d07-e48ba79cbb63","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d06faa2e-e86b-4866-bcfe-f5e75135a5af","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"cc1bf5e1-7a54-4637-950b-8c1a9849fb40"},{"name":"Updates a package's expiry date","id":"ac017858-4470-4d93-8c13-c0e5349d8de5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/expirydate","description":"

Update package expiry date

\n

Description

\n

This call allows you to update the expiry date of a package. This way, you can make a document that was expired available again.

\n

The only template parameter you need is packageId. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/expirydate \n 

\n

HTTP Method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose expiry date you want to update.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ExpiryDateDate and time when this package expires and can no longer be form filled/approved/signed. Documents within the package expire on the same date. Format is ISO 8601 date-time.String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage expiry date was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","expirydate"],"host":[""],"query":[],"variable":[{"id":"a28a1aa6-35a5-4ea4-9084-8b582c231ac0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"47afb258-5c8f-4e12-9af6-07cab6125d08","name":"package's expiry date was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c328f175-aeb2-421e-a601-8c9f6eccfe52","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"69b2159d-d515-4fc9-b192-06f577449395","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e83450cc-9e54-4c18-88b1-95e6e30eab57","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"10a8bfa0-b8c3-4f80-8b99-5cd2c9488140","name":"Exiry date of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/expirydate","host":[""],"path":["packages",":packageId","expirydate"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"ac017858-4470-4d93-8c13-c0e5349d8de5"},{"name":"Gets a package's status","id":"c9080b13-e153-49d8-86ea-94cf064419b7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/status","description":"

Get package status

\n

Description

\n

This method allows you to retrieve the status of a package.

\n

The only template parameter you need to use is packageId.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusThe possible values are: DraftActionNeeded, Draft, Pending, InProgress, Ending, Finished, Rejected, Revoked, Expired, Failed, Processing, ProcessingFailedString (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStatus was successfully retrieved.
401 UnauthorizedThe caller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"id":"f29cba5a-78b5-42fa-8eeb-8c9ace20ddaf","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"3a200bf8-b384-4279-a7f6-8f57b6ecea2c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c9080b13-e153-49d8-86ea-94cf064419b7"},{"name":"Updates a package's status","id":"e3da057c-4755-4ee0-b7c6-547657c6342d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/status","description":"

Update package status

\n

Description

\n

This call allows you to update the status of a package.

\n

Possible combinations:

\n
    \n

  • Draft to pending

    \n
    • \n

  • Pending to revoked

    \n
    • \n
\n

Draft to pending

\n

When the package is ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the package visible to each of the stakeholders in their Signer Portal.

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been form filled/approved/signed yet, or packages of which the signing has failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/status

\n

HTTP Method

\n

PUT

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose status you want to retrieve.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusStatus to which the package must be updated. The possible values are:

- pending
- revoked.

Please note: the status parameter is part of the URL and must be omitted from the body, because you only need the value in the body, such as “pending”, and not the parameter, such as “status”:”pending”, which is the case for all other calls.		String (enum)
\n

Example

\n
\"pending\"\n\n

Response parameters

\n

None.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentPackage status was successfully updated.
400 Bad requestThe package could not be updated due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundThe package could not be found.
409 ConflictPackage status could not be updated.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","status"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"1529c504-8ffe-4329-93f3-f0b3130b329b","name":"package's status was updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"\"revoked\"","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId","value":""}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0cfddffc-b8bb-485f-9137-6b5df91f1a96","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"bf4895e5-5fad-490d-9318-0f429c029177","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5fef225c-5a01-4edd-a2ac-dec7fb06a35a","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e7cfb5cd-58a9-4cc8-bbdd-48660a3df8b9","name":"Status of package couldn't be updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"revoked","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/status","host":[""],"path":["packages",":packageId","status"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"e3da057c-4755-4ee0-b7c6-547657c6342d"},{"name":"Updates a package's documents order indices","id":"afbd0f46-85e3-4d10-8200-b10792cbd3bf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/orderindices","description":"

API v4: Reorder documents in a package

\n

This call updates the order of the documents in a Draft package.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/orderindices

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package you want to retrieve.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentsThe documents from the draft package you want to change in order.

Child parameters:

- DocumentId (String (Guid)).
- OrderIndex (Integer). The order of the document		Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentThe order of the documents has been updated.
400 Bad RequestCould not update the order.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not FoundThe package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Package.InvalidStatus
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","urlObject":{"path":["packages",":packageId","documents","orderindices"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"a7bd073f-abb4-4a62-a424-5ae0798cc0ee","name":"Order indices were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"197dbaee-5fc6-4733-8ced-f07d6c8543e2","name":"Bad request","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"069048eb-c86b-42fb-b48a-59fd21dc4a7b","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ef41cc56-4c3d-4efc-a903-a12f899eccd1","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Documents\": [\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"DocumentId\": \"\",\n \"OrderIndex\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/orderindices","host":[""],"path":["packages",":packageId","documents","orderindices"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"afbd0f46-85e3-4d10-8200-b10792cbd3bf"},{"name":"Gets a package's warnings","id":"a44b86a1-adda-4597-a505-7cf02478be5f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/warnings","description":"

Get package warnings

\n

Description

\n

This call retrieves all warnings there might be about a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/warnings \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose warnings you want to retrieve.String (GUID)
\n

Response parameters

\n

The response is a list of warnings.

\n

Warning schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
ResourceTypeThe subject of the warning e.g. \"process\"String
CodeThe warning code, Follows the format of an eSignatures errorCode.String
MessageA human-readable explanation of the warning.String
\n

When resourceType is \"process\" these properties are added:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
PropertyContent / DescriptionType
StakeholderThe stakeholder involvedStakeholder
ActorThe actor involvedActor
\n

Stakeholder schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe stakeholder’s idString (GUID)
ExternalReferenceThe stakeholder’s external referenceString
\n

Actor schema:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe actor’s idString (GUID)
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","warnings"],"host":[""],"query":[],"variable":[{"id":"15ed1b74-578e-44d2-b2e3-5307d215d0e1","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"7ac03708-3924-485e-99fb-d5fad223c7d0","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"ResourceType\": \"process\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n },\n {\n \"ResourceType\": \"package\",\n \"Code\": \"\",\n \"Message\": \"\",\n \"Stakeholder\": {\n \"Id\": \"\",\n \"ExternalReference\": \"\"\n },\n \"Actor\": {\n \"Id\": \"\"\n }\n }\n]"},{"id":"c1bd1c18-93aa-4f9e-98ea-1437e8aeb7fb","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f1e9ef30-eaf1-4686-a6d2-a8f8c70d031a","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/warnings","host":[""],"path":["packages",":packageId","warnings"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"a44b86a1-adda-4597-a505-7cf02478be5f"},{"name":"The actors in the current process step will be notified","id":"2941c47e-3c16-4af4-abd1-d15eaf37c86f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/reminders","description":"

Send reminders

\n

Description

\n

The POST reminders call sends a reminder to the actors of the current process step.

\n

Company policy might require that a document is handled within a given timespan. Doing a POST reminders call looks up all actors within the current process step who haven't form filled/approved/signed their document and sends them an extra notification as a reminder.

\n

Note that only the next available form filler(s)/approver(s)/signer(s) in the workflow are notified. This means form fillers/approvers/signers waiting for someone else to form fill/approve/sign first in a serial workflow will not receive a notification.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/reminders

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must receive a reminderString (GUID)
\n

Response parameters

\n

Empty response body

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentThe reminders have been sent.
404 Not foundThe package with the given id could not be found.
409 ConflictThe package did not have status Pending.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","reminders"],"host":[""],"query":[],"variable":[{"type":"any","value":"","key":"packageId"}]}},"response":[{"id":"6720b77c-58f2-4ab7-ad33-a14005c95156","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0b487c4b-04d5-4564-a841-eaf06183ad20","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d2d3ac85-1192-44fb-9491-d501daa2ef2a","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"09731f00-82fc-4ed4-96bb-98a4c0257d6f","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/reminders","host":[""],"path":["packages",":packageId","reminders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2941c47e-3c16-4af4-abd1-d15eaf37c86f"},{"name":"Approvers that are not finished yet will get the status Skipped","id":"5815f40c-aea8-45e9-952b-f3cd448acbe8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipapprovers","description":"

API v4: Skip approvers

\n

A package that has been approved by at least one of multiple approvers can be sent to the signers by doing a Skip Approvers call. This call skips all approvers that haven’t approved yet and sets their status to “Skipped”, which results in the complete package being marked as “Pending”.

\n

This way, the package becomes available to the signers and it is no longer necessary to wait for all approvers to complete their task before anyone can sign.

\n

If the package was created with the SendNotifications parameter set to true, then all approvers will get a notification that the packages has been sent to the signers.

\n

Attention: when you skip approvers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipapprovers \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdUnique identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll approvers that hadn’t approved yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
\n
","urlObject":{"path":["packages",":packageId","skipapprovers"],"host":[""],"query":[],"variable":[{"id":"1dc92b55-8835-423a-86f4-3cad0ea6f58b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"dd0a3010-2d6a-44c6-9561-5a3cfe61e613","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"26e6edd8-34ad-464c-8833-4d9486180c76","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"c5061cc4-c5a4-4134-99f5-b5653987192c","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"632eeb92-fa0c-41d5-86b5-70280db3ef38","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipapprovers","host":[""],"path":["packages",":packageId","skipapprovers"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"5815f40c-aea8-45e9-952b-f3cd448acbe8"},{"name":"Signers that are not finished yet will get the status Skipped","id":"7c4d3ef0-caf4-4247-89e4-e8a137773ca9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/skipsigners","description":"

API v4: Skip signers

\n

Description

\n

A package that has been signed by at least one party, but still has some unsigned fields, that must be signed by others can now be finished by doing a Skip Signers call. This call skips all signers that haven’t signed yet and sets their status to “Skipped”, which results in the complete package being marked as “Finished”.

\n

This way, the package becomes available for download and it is no longer necessary to wait for all parties to sign before everyone can download the document.

\n

If the package was created with the SendNotifications parameter set to true, then all signers will get a notification that they can download the ended package.

\n

Attention: when you skip signers through the API, no info is added to the Audit proofs about who skipped them. This info can be added by means of the Add Proof from External Source call. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/skipsigners \n 

\n

HTTP Method

\n

POST \n 

\n

Template parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
packageIdUnique Identifier of the PackageString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/Description
NoneEmpty object
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll signers that hadn’t signed yet were successfully skipped.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Caller is unauthorized to perform this operation
404Package.NotFound:{packageId}
409Package.ContainsNoDocuments:{packageId}
409Package.InvalidStatus:{packageStatus}
409Package.NotSigned:{packageId}
\n
","urlObject":{"path":["packages",":packageId","skipsigners"],"host":[""],"query":[],"variable":[{"id":"d7f0297c-cbb8-47fc-b846-e5ba5da7d138","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"92d55a53-bcc9-4dcd-8663-e312ec31c291","name":"OK","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9395fadb-b5ea-439d-a924-ef548be8b259","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4c899728-5917-4195-afb3-f8a9d9c08996","name":"Untitled Response","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"7750b567-4514-4af1-b3e5-6632be3b9a7c","name":"Package has the wrong status","originalRequest":{"method":"POST","header":[],"url":{"raw":"/packages/:packageId/skipsigners","host":[""],"path":["packages",":packageId","skipsigners"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"7c4d3ef0-caf4-4247-89e4-e8a137773ca9"},{"name":"Creates template from given package","id":"b18f9ac6-a5fc-4a5c-94bd-609eb77e7f0e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/template","description":"

Create template

\n

Description

\n

This POST call saves a draft package as a template. Everything that defines the package, such as its documents and stakeholders, is saved as part of the template, enabling you to quickly create templates on the fly as part of an automated process through the API.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/template \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
packageIdThe unique identifier of the package that you want to save as a template.String (GUID)
\n

Request body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateNameThe name of the template, which must be unique in its document group.String (GUID)
\n

Response body

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
templateCodeThe unique identifier created for the template.String (GUID)
\n

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","template"],"host":[""],"query":[],"variable":[{"id":"fcf0b93f-4921-4ba9-84d6-59d1d85e0a7f","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"15868a60-f041-4485-a8db-3caf1de81d26","name":"The template has been created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"TemplateCode\": \"\"\n}"},{"id":"4d04048f-90aa-42bd-8809-4d0c1182b1d3","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7d5383f1-c1df-4bbe-a9e0-b6c18e2e7390","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"TemplateName\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/template","host":[""],"path":["packages",":packageId","template"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"b18f9ac6-a5fc-4a5c-94bd-609eb77e7f0e"},{"name":"Used for downloading all documents in a certain package as a Zip file.","id":"054623e5-5f5f-4073-8127-91799647f6ce","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/:packageId/download","description":"

Download package

\n

Description

\n

This call retrieves all documents of a specified package as a .zip file.

\n

Note that only finished and archived packages can be downloaded. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose documents you want to download as .zip file.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe package's contents are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","download"],"host":[""],"query":[],"variable":[{"id":"996a5b35-9a0c-479e-b0d7-07f755ef65b0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c66b6af7-4086-4b0a-95c7-20bfa6735279","name":"The package's contents in a zip file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/zip"}],"cookie":[],"responseTime":null,"body":""},{"id":"9124edb1-cc00-430b-abd1-8c5d15e5ae46","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"42d13aa6-52a0-4989-95b8-83e771536d84","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"c0aea122-0193-4f38-9b2a-9da7777248db","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download","host":[""],"path":["packages",":packageId","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"054623e5-5f5f-4073-8127-91799647f6ce"},{"name":"Get all Actors for the specified person EmailAddress","id":"4a498297-8e2b-4301-b7db-0327319a9eac","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","description":"

API v4: Get actors for a user

\n

This call retrieves all actors for a specific user email address. 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/actors \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
emailAddress*The email address from the user you want to filter on.String
(email)
PageNumberThe page to retrieve. The default value is 0.Integer
PageSizeMaximum number of records in the response Default value is 20.Integer
CreatedBeforeGets only the actors created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the actors created after this date. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, and failed.		String (enum)
type

The type of actors you want to filter on. 

Values are: Signer, Receiver, Approver, FormFiller

String
(enum)
SortDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PageSizeMaximum number of records in the response. The default value is 20.Integer
TotalTotal number of items.Integer
ItemsThe actors that are retrieved. See the child parameters of this parameter.array of
Objects
\n

Items

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActorIdUnique identifier of the actorString
(GUID)
StakeholderIdUnique identifier of the stakeholderString
(GUID)
StatusThe status of the actor.
Values: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped		String
(GUID)
PackageIdUnique identifier of the package the actor is part ofString
(GUID)
PackageNameThe name from the packageString
CreationDateReturns the date the actor was created. ISO 8601 date format.String (date-time)
StatusGets items that have a specific status.
Supported status values are: Available, finished, rejected, failed.		String (enum)
type

The type of the actor. 

Values are: Signer, Receiver, Approver, FormFiller.

String
(enum)
InitiatorThe email address of an initiator who created the package.String (email)
Documents

All the documents this actor is assigned to.

Child parameters:

- Id (String (GUID))
- Name (String)

Array of Objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll packages are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","actors"],"host":[""],"query":[{"description":{"content":"

(Required) The email address of the person

\n","type":"text/plain"},"key":"emailAddress","value":""},{"description":{"content":"

The status of actors to retrieve

\n","type":"text/plain"},"key":"status","value":"Finished"},{"description":{"content":"

The type of actors to retrieve

\n","type":"text/plain"},"key":"type","value":"Approver"},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"cd54903a-2a9e-423e-a40d-a24fe9fde052","name":"List of actors across packages for given person.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"InProgress\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n },\n {\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"ActorId\": \"\",\n \"Status\": \"Skipped\",\n \"Type\": \"Receiver\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n },\n {\n \"ActorId\": \"\",\n \"Status\": \"Available\",\n \"Type\": \"FormFiller\",\n \"StakeholderId\": \"\",\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CreationDate\": \"\",\n \"Initiator\": \"\",\n \"Documents\": [\n {\n \"Id\": \"\",\n \"Name\": \"\"\n },\n {\n \"Id\": \"\",\n \"Name\": \"\"\n }\n ]\n }\n ]\n }\n]"},{"id":"d774d803-5940-4863-a322-ced4253e4ffa","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"46615f72-2c1e-433a-8ceb-d6b21bbc028f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/actors?emailAddress=&status=Finished&type=Approver&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&sort=desc","host":[""],"path":["packages","actors"],"query":[{"description":"(Required) The email address of the person","key":"emailAddress","value":""},{"description":"The status of actors to retrieve","key":"status","value":"Finished"},{"description":"The type of actors to retrieve","key":"type","value":"Approver"},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4a498297-8e2b-4301-b7db-0327319a9eac"}],"id":"b990e8a4-a0b7-4259-81cc-e6aaedfad113","description":"

API v4: Packages

\n

What is a package?

\n

Packages lie at the core of eSignatures. A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

API calls for managing packages

\n

With API calls, you can do the following:

\n\n","_postman_id":"b990e8a4-a0b7-4259-81cc-e6aaedfad113"},{"name":"Documents","item":[{"name":"Gets all documents of a package","id":"32eb649b-5804-47b5-818b-16c8efcb5cfe","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents?status=","description":"

API v4: Get documents

\n

Description

\n

This call retrieves all documents that currently exist within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/ \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose documents must be retrieved.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StatusGets items that have a specific status. Supported status values are: draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll documents are successfully retrieved.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

Select items that have a specific status

\n","type":"text/plain"},"key":"status","value":""}],"variable":[{"id":"94cb399e-8902-4094-9f51-a56f2c456bfe","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"846cf6c8-6dc6-47bc-9692-dc413072a03d","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Ending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Rejected\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n },\n {\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Pending\",\n \"Elements\": [\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Finished\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n }\n]"},{"id":"a88aaf2c-a67a-47b9-8e03-f32919d5a6b3","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents?status=","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"Select items that have a specific status","key":"status","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"32eb649b-5804-47b5-818b-16c8efcb5cfe"},{"name":"Adds a document to a package","id":"f4441a67-2064-4b6f-9ce3-4d5f2b24d254","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n }, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=false","description":"

Add document to package synchronously

\n

Before you start | URL | HTTP method | MIME type | Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package. Once the status of a package is Draft, you can continue working on them. The asynchronous upload method offers extra parameters to keep existing signatures, form and signing fields. For more details, refer to API v4: Add document to package asynchronously.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n
 \n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
  • Parameters marked with an asterisk are required.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents \n 

\n

HTTP method

\n

POST \n 

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request parameters

\n

The parameters with an asterisk are mandatory.
​​​​​​​

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. See section 'PDF Error Handling' below for more info. Values:
-Ignore                    -DetectWarn
-DetectFail              -DetectFixWarn             -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the document.String (GUID)
PackageIdUnique identifier of the package.String (GUID)
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
CreationDateDate and time when the document was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
IsOptionalWhether the document is optional.Boolean
MediaTypeMediaType of the document within the package. Possible values: application/pdf or application/xmlString (enum)
LanguageLanguage that will be used in signature texts and for legal notices when the LegalNoticeCode is filled for an Actor.String (enum)
StatusStatus of the document within the package. The possible values are draft, pending, inProgress, ending, finished, archived, rejected, revoked, expired, failed.String (enum)
ElementsDetails of each of the elements within the document. In the current version, an element can be a form field or signing field. The elements parameters are identical to those in the Create element call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail\n When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

​​​​​​​Before you start | URL | HTTP method ​​​​​​​| MIME type ​​​​​​​| Request parameters ​​​​​​​| Response parameters ​​​​​​​| Response codes ​​​​​​​| Error codes ​​​​​​​| PDF error handling details ​​​​​​​

\n","urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"false"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"e2eec0cb-77ef-47c0-af29-7f057ad9a4b7","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"c035cf18-16a4-46e3-8cb4-de83403664bd","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"ad748626-ad01-471a-8a2a-23601eaabfe9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"8b2da5dd-2029-4489-9ad4-b244cdb1bc72","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ccda3fa9-7823-44c6-bffd-bcd591524d91","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"c2557091-b9cc-4bc5-9d51-0a1f40f4fe2b","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"f4441a67-2064-4b6f-9ce3-4d5f2b24d254"},{"name":"Adds a document to a package asynchronously","id":"2fa11344-0211-4a30-9d11-57986c73c849","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"name\": \"\",\r\n \"language\": \"en\",\r\n \"externalReference\": \"\",\r\n \"documentOptions\": {\r\n \"targetType\": \"application/pdf\",\r\n \"contentType\": \"application/pdf\",\r\n \"pdfOptions\": {\r\n \"targetFormat\": \"pdf\",\r\n \"pdfErrorHandling\": \"detectfixwarn\"\r\n },\r\n \"KeepSignatures\": false, \r\n \"KeepSigningFields\": false,\r\n \"KeepFormFields\": false, \r\n \"base64data\":\"\"\r\n }\r\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents?async=true","description":"

API v4: Add document to package asynchronously

\n

As of version 7.4.0, you can upload documents asynchronously. This means that instead of waiting till the upload is completed, you can check the status of your package and, once the status of a package is Draft, you can continue working on it.

\n

The POST document call adds a document to an existing package.

\n

Once a document has been added, you can build on this method by adding additional resources, such as elements (i.e. SigningFields, CheckBoxFields, TextBoxFields and RadioGroups). You can also choose to define all this in a single POST document call, by passing all necessary parameters.

\n

As of eSignatures 6.3 documents may be marked as optional. This allows you to create packages that contain both mandatory and optional documents. End users may then choose not to form fill/sign the optional documents within the package, while still form filling/signing the mandatory ones.

\n

Before you start

\n

Before you start adding documents to a package, review the information below.

\n

Size limitations

\n

Consider the following size limitations when creating documents.

\n
    \n
  • A package must not exceed 150 MB.
    • \n
  • A package must not contain more than 15 documents and each document must not exceed 30 MB.
    • \n
  • An .xml must not contain more than 2 million characters per file. A package must not contain more than 15 .xml files.
    • \n
  • Large files might affect signing performance depending on the user's Internet connection.
    • \n
  • A PDF document’s physical dimensions must not exceed 3.99 m by 3.99 m.
    • \n
\n

Technical information

\n
    \n
  • Uploading PDF/A documents is only allowed if the format is pdfa1a or pdfa2a. When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected.
    • \n
  • Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF.As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.
    • \n
  • Rotated PDFs should not be used together with text markers. Detected signature locations will not be rotated to match the PDF text direction but will be placed near the text marker on a best-effort approach.
    • \n
  • When you upload PDF documents that contain Text Fields of which the name/id complies with the Text Field format you have configured in the Configuration Index, the Text Fields will be converted to empty signature fields in the output document and the original Text Field will not be displayed. This is intended behavior.This does not apply in case you upload a document that already contains one or more signatures – whether they have been created in eSignatures or another signing application.
    • \n
  • When uploading PDF documents that already contain signature fields - which you created in a PDF solution such as Adobe Acrobat Pro DC - make sure the signature field names only contain letters and numbers, or a combination of both. Any special characters such as accented letters, slashes, dots, etc. are not supported and must not be used. The same limitations apply when uploading PDF documents that contain text fields.
    • \n
  • Packages currently can't contain both XML documents and PDF documents on which signatures will be placed. The type of package is determined by the first uploaded document.
    • \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents?async=true

\n

HTTP method

\n

POST

\n

MIME type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Used forMIME type
JSON + Base64application/json
Multiformmultipart/form-data

This call expects the same input and will deliver the same output as the non-multipart version above, but the document variable in the JSON must not contain a base-64 encoded pdf file. Instead, the call will expect the document to be included as a different “part” of the request.
\n

Request and query parameters

\n

Parameters marked with an asterisk are required.

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document will be added.String (GUID)
\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
async*To use the asynchronous upload method, you must set this parameter to true.String
\n

Request parameters for multipart/form-data

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersContent typeDescription
Parameters*application/json;charset=utf 8 The supported parameters are identical to those of application/json described in the table below, except for contentType and base64data.Parameters for creating a document
Document*Supported values: application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, application/pdf, text/plain, application/xmlMultipart attached document that needs to be signed.
Representationapplication/pdfMultipart attached representation. A PDF to be shown together with the document to be signed
\n

Request parameters for application/json

\n

These parameters apply when creating a document with Base64 document.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Name*Name of the document. The name is displayed in the eSignatures WebPortal. Note: do not add an extension to the name value. Important: The name must not contain any special characters such as slash, backslash, question mark, percent, asterisk, colon, pipe, quote, double quote, less than, greater than. Note: when using itsme signing, only use characters that are supported by ISO 8859-15. This character set supports most usual characters, but some software-generated characters like curly apostrophes and long dashes are not supported. Minimum length: 1 Maximum length: 150String (GUID)
Language*Language that will be used in signature texts and for legal notices when LegalNoticeCode is filled for an Actor. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
IsOptionalDetermines whether the document is optional. Default value is false. When set to true, actors may choose not to form fill/sign the document.Boolean
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ElementsThe elements that will be added to the document. An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor. The elements parameters are identical to the ones in the Create element call and are described here.Array of objects
ProofCorrelationIdIdentifier to correlate this document to other resources in the proofs system.String (GUID)
DocumentOptions*Contains a document's base64 data and media type. See the child parameters of this parameter.Object
RepresentationOptionsContains a document's base64 data and media type. See the child parameters of this parameter.Object
\n

DocumentOptions

\n

Contains a document's base64 data and media type.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetTypetargetType to which the document will be converted. Possible values are application/pdf and application/xmlString (enum)
PdfOptionsThis only applies when application/pdf is set as targetType. It defines optional pdf parameters. See the child parameters of this parameter.Object
KeepSignaturesThis parameter is available from version 7.4.0 onwards.

Determines whether to keep the existing signatures of the document. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.
Boolean
KeepSigningFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.		Boolean
KeepFormFieldsThis parameter is available from version 7.4.0 onwards.

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepFormFields is set to true, you cannot set KeepSignatures to true.
Boolean
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200000000String (base64)
ContentType*contentType of the document you will be sending. Supported values are: application/pdf, application/xml, application/msword, application/vnd.openxmlformats-officedocument.wordprocessingml.document, text/plainString (mediaType)
\n

PdfOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TargetFormatDefines if an extra conversion to needs to be done before signing. Supported values are: pdf, pdfa1a, pdfa2a. Notes: This parameter will only work if the Document Conversion settings have been enabled in the Configuration Index. Existing signatures will be removed unless the PDF is of the specified type. Important: When using itsme as signing method, it is mandatory to use pdfa1a or pdfa2a as TargetFormat. Note however that Connective does not perform any checks whether this TargetFormat has been selected. Important: Uploading PDF/A documents to which you add form fields using eSignatures API v4 breaks the \"/A\" part of the PDF. As a result, the documents end up a regular PDF. As a workaround, you can set the TargetFormat parameter in the POST document call to pdfa1a or pdfa2a (depending on the source format). The breaking will still happen but after all form fields have been filled or saved, the document will be converted to the set target format, resulting in a PDF/A document again.string (enum)
PdfErrorhandlingHow to deal with PDFs containing minor flaws. For more details, see the section PDF error handling details.

Values:
-Ignore -DetectWarn
-DetectFail -DetectFixWarn -DetectFixFail		string (enum)
\n

RepresentationOptions

\n

Contains a document's base64 data and media type.

\n

These parameters only apply when application/xml is set as ContentType.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Base64database64 data of the document you will be sending. Minimum length: 1 Maximum length: 200.000.000String (base64)
ContentType*contentType of the document you will be sending. Supported value: application/pdfString (mediaType)
\n

Response parameters

\n

This call doesn't return any response parameters. Use the Get package by ID call to see the status of your package. Once the status is Draft, you can continue working on the package. For more details, refer to API v4: Get package by ID.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 CreatedThe document was created successfully.
400 Bad requestRequest validation failed. Document could not be created due to invalid parameters in the request or due to conflicting actions.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictDocument could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Document.ConflictingActions
400Document.NameLengthIncorrect
400Document.UnsupportedLanguage
400Request.UnsupportedValue
400Base64Data.InvalidLength
400Document.InvalidTargetFileType
400PdfErrorHandling.InvalidType
400Document.DataInvalid
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Document.DataInvalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Package.ApiVersionMismatch
409User.NotFound
409Document.CorrelationIdAlreadyExists
409Document.Xml.UploadNotWellFormed
409Package.PackageAcceptsDocumentType
409Document.Xml.AlreadySignedNotAllowed
\n

PDF error handling details

\n

Some PDFs might have minor flaws which prohibit signing. Depending on the request parameters and the configuration settings, PDFs are either only checked or also modified to remove those flaws.

\n

Note: The PDF will never be fixed if it already contains signatures, otherwise these signatures would become invalid. The presence of signatures and a PDF flaw might then trigger an error or warning depending on the choices below.

\n

The PdfErrorHandling parameter defines the behavior, though the configuration settings might define the behavior if this parameter is not specified. Here are the different actions for the parameter:

\n
    \n
  • IgnoreIgnore means no checks or fixes will be done. Any document will be accepted but later it might be impossible to sign or result in a PDF with signature validation errors should a PDF flaw be present. This is the default value if the parameter is not specified and if the eSignatures configuration has no different value.
    • \n
  • DetectWarnWhen there is an issue, it will be detected and a warning is added to the eSignatures log file. The upload will still proceed.
    • \n
  • DetectFailWhen there is an issue, an error is added to the response and the upload is stopped.
    • \n
  • DetectFixWarnWhen there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, a warning is added to the eSignatures log and the upload will still proceed.
    • \n
  • DetectFixFail
    When there is an issue, the system will detect and try to fix it. When it’s not possible to fix the issue, an error is added to the response and the upload is blocked.
    • \n
\n

Note: these actions, except for ‘Ignore’, influence the speed of the system in different ways. See appendix II of the eSignatures Configuration Guide for an overview of the steps a document goes through when the other options are selected.

\n

Before you start | URL | HTTP method | MIME type | Request and query parameters | Response parameters ​​​| Response codes​​​​​​​ ​​​​​​​| Error codes ​​​​​​​| PDF error handling details​​​​​​​

\n","urlObject":{"path":["packages",":packageId","documents"],"host":[""],"query":[{"description":{"content":"

This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.

\n","type":"text/plain"},"key":"async","value":"true"}],"variable":[{"id":"74621bc7-14ac-49a5-b643-dc08c1a4b618","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"14edee3e-f725-47ec-9a50-59ee885e13ef","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Revoked\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"RadioGroup\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"e48a7b09-18e0-49fd-b5fb-354356d6186c","name":"Accepted, the document will be processed asynchronously","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Accepted","code":202,"_postman_previewlanguage":"text","header":[{"description":{"content":"The package information location","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":""},{"id":"e6ff4a4a-f107-466b-ac1f-dab8782e3a99","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"fdc301f1-4a0c-4e1d-8f0c-4fa26629aeba","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"17bceb63-ef12-43bc-944c-861942352fcc","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"8f1c4db8-647a-4eaa-909b-8543d010fcca","name":"Document could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"multipart/form-data"}],"body":{"mode":"formdata","formdata":[{"description":"(Required) Multipart attached document","key":"Document","value":"","type":"text"},{"description":"(Required) Parameters for creating a document","key":"Parameters","value":"[object Object]","type":"text"},{"description":"Multipart attached representation","key":"Representation","value":"","type":"text"}]},"url":{"raw":"/packages/:packageId/documents?async=false","host":[""],"path":["packages",":packageId","documents"],"query":[{"description":"This parameter allows to upload and process the document asynchronously. If set to true the location header will contain a uri that allows to monitor the process.","key":"async","value":"false"}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2fa11344-0211-4a30-9d11-57986c73c849"},{"name":"Gets a document by id","id":"ee5a61d5-d072-4b63-9679-b48dd5179aa6","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Get document by ID

\n

Description

\n

This call allows you to retrieve a document by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document you want to retrieve.String (GUID)
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Add document call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
400 Bad requestRequest failed validation.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"057558b0-302f-4a07-acf8-c1744b001053","type":"any","value":"","key":"packageId"},{"id":"2f9be465-5903-43f3-a66d-ccb16d55248c","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"228518ee-5727-4665-b11e-dbaf889eeeef","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"18e36dfb-47d2-4ffa-bb19-f79d23b5f748","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4167e044-5810-459c-a322-52c41ff0ac7d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a31072cf-1cd3-4b5e-aaab-3836c518abbc","name":"Target package or document could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"ee5a61d5-d072-4b63-9679-b48dd5179aa6"},{"name":"Deletes a document by id","id":"fe245111-958c-4b93-948e-68a0b21508ad","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId","description":"

Delete document by ID

\n

Description

\n

This call allows you to delete a specified document from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
DocumentId*Unique identifier of the document that must be deleted.String (GUID)
PackageId*Unique identifier of the package to which the document belongsString (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentDocument was successfully deleted.
404 Not foundTarget package or document could not be found.
409 ConflictDocument could not be deleted.
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId"],"host":[""],"query":[],"variable":[{"id":"e6e62e6d-47e9-4d14-b024-54ea79901a8a","type":"any","value":"","key":"packageId"},{"id":"4803c397-76bf-458f-9c05-57e502746d8b","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"c54c207e-4735-4f16-b2f7-bd940d66c9d4","name":"Document was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e47d8a36-cf1d-4ea2-98e3-7d7495d944c0","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"762c2db3-6289-4aae-af2b-69b33610ec37","name":"Target package or document with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"837e9413-991b-475b-ba4d-b54ba611f046","name":"Document could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId","host":[""],"path":["packages",":packageId","documents",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"fe245111-958c-4b93-948e-68a0b21508ad"},{"name":"Performs actions (keep/remove signatures, form fields, signing fields) on the not fully processed document.","id":"9df7d2c3-7586-4664-85f8-bbd122210c4e","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/actions","description":"

API v4: Perform actions on a not fully processed document

\n

Description

\n

Use this call to perform the following actions on a not fully processed document: keep and remove existing signatures, form and signing fields.

\n

For example, a document was uploaded via the Document Portal and it has existing signatures, form or signing fields. If you get the package containing this document by ID: \n 

\n
    \n
  • The IsActionNeeded parameter is set to true.
    • \n
  • Depending on the data that exists in the document, the following parameters are set to true: HasSigningFields, HasSignatures and HasFormFields.
    • \n
\n

You can use this API call to decide which data to keep so that the document is fully processed.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/actions \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package.String (GUID)
DocumentId*The unique identifier of the document.String (GUID)
\n

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
KeepSignaturesDetermines whether to keep the existing signatures of the document. The default value is false.Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.Boolean
KeepSigningFieldsIf it is set to true, detected signing fields will be converted to actual signing fields. The default value is false.Boolean
KeepFormFields

If it is set to true, detected form fields will be converted to actual form fields. The default value is false.

Important: You cannot keep signatures and use form fields at the same time. If KeepSignatures is set to true, you cannot set KeepFormFields to true.If KeepFormFields is set to true, you cannot set  KeepSignatures to true.

boolean
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No ContentDocument is put in Draft status
400 Bad requestBad request, Action could not be performed.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Document.ConflictingActions
401Authentication failed, username or password incorrect
404Package.NotFound
404Document.NotFound
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","actions"],"host":[""],"query":[],"variable":[{"id":"9a5bd2a9-d0ac-4031-bd76-cf0ef753fc29","type":"any","value":"","key":"packageId"},{"id":"4941f80f-6521-40f7-b814-3019d6f0dd3a","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"8b0a0eb0-824d-41f3-816e-907dcc5516a6","name":"Document is in Draft status, no action required","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"8c078fab-02d0-46d1-b89e-4e2f61ce3645","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"230207df-be08-4828-aea6-a9f3185c6b6b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"98ffe2bd-f726-447e-96e8-e5da29b757b7","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"1ece8243-83bf-4770-a55c-3dd82bda77a7","name":"Unable to perform actions on the document","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"KeepSignatures\": false,\n \"KeepSigningFields\": false,\n \"KeepFormFields\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/actions","host":[""],"path":["packages",":packageId","documents",":documentId","actions"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"9df7d2c3-7586-4664-85f8-bbd122210c4e"},{"name":"Download a signed document from a package.","id":"39273890-fb6b-4983-aee4-cb12094a6492","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/download/:documentId","description":"

Download document

\n

Description

\n

This call downloads a specified document from a specified package as PDF or XML file.

\n

Note that you can only download documents from fully finished packages. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}download/{documentId} \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package of which you want to download a document.String (GUID)
DocumentId*The unique identifier of the document you want to download.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe document is successfully downloaded.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundSpecified package /document could not be found.
409 ConflictThe specified package has not been fully signed.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"7820f9ba-4883-423d-91bd-1ec6bdad58e2","type":"any","value":"","key":"packageId"},{"id":"942d747e-f49e-4fb0-a55b-38e8fe5a15c9","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"458e1e5e-7315-46e6-b633-134089eb3566","name":"The specified document in a pdf or xml file","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"920c50b2-fd3e-49d8-9194-670410ddc3d2","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2bdfef9e-38ee-4ae2-a458-263731b639a1","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d4c463a5-9c99-4dfa-b540-c51ad4758c9c","name":"When the package has not been fully signed","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/download/:documentId","host":[""],"path":["packages",":packageId","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"39273890-fb6b-4983-aee4-cb12094a6492"},{"name":"Gets a document by its index within a package","id":"54ef6185-f744-4fce-813f-6d4703ede095","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:orderIndex","description":"

Get document by orderIndex

\n

Description

\n

This call allows you retrieve a document within a specified package based on its OrderIndex.

\n

The OrderIndex defines the order in which documents should be sorted within a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{orderIndex} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the target package.String (GUID)
OrderIndex*Order of the document within the package. Value must be positive.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKDocument is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages",":packageId","documents",":orderIndex"],"host":[""],"query":[],"variable":[{"id":"2299dc73-073b-41e3-8b82-acff55cf16d0","type":"any","value":"","key":"packageId"},{"id":"be9ca9b4-d441-43f7-be02-12f614449ffd","type":"any","value":"","key":"orderIndex"}]}},"response":[{"id":"71c88133-af46-4981-b0a2-29ee42b9fec6","name":"document was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Name\": \"\",\n \"CreationDate\": \"\",\n \"MediaType\": \"\",\n \"Language\": \"\",\n \"Status\": \"Draft\",\n \"Elements\": [\n {\n \"Type\": \"TextBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n ],\n \"ExternalReference\": \"\",\n \"ProofCorrelationId\": \"\",\n \"OrderIndex\": \"\"\n}"},{"id":"276eda31-e524-45b9-86dc-a7d2ebcd15b3","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4392817d-2c8c-4bec-abab-190778f3ed1c","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:orderIndex","host":[""],"path":["packages",":packageId","documents",":orderIndex"],"variable":[{"key":"packageId"},{"key":"orderIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"54ef6185-f744-4fce-813f-6d4703ede095"}],"id":"e58e92e8-9901-4f06-9a73-16305dfde15a","description":"

API v4: Documents

\n

What is a document?

\n

A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder. Note that as of eSignatures 6.3, a document may also be marked as optional. In that case, the end user may choose not to sign it.

\n

A document may contain multiple elements. As of eSignatures 6.3, there are three types of elements: SigningField elements, CheckBoxField elements, TextBoxField elements and RadioGroup elements. \n 

\n

API calls for managing documents

\n\n","_postman_id":"e58e92e8-9901-4f06-9a73-16305dfde15a"},{"name":"Elements","item":[{"name":"Gets the package elements editor url","id":"4644aaa6-d3e1-4b3f-9d97-c0a560ba53b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","description":"

Get Package Elements Editor ActionUrl

\n

Description

\n

The GET element call retrieves a one-time ActionUrl that can be used by end-users to drag-n-drop (un)placed elements.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/elements/actionurl

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
RedirectUrlThe URL to call upon cancellation or confirmation.URL
LanguageThe Package Elements Editor language.String
IsIFrameShould the Package Elements Editor open in an IFrame.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlA one-time link that can be used by end-users to drag-n-drop (un)placed elements.URL
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe URL was created successfully.
\n
","urlObject":{"path":["packages",":packageId","elements","actionurl"],"host":[""],"query":[{"description":{"content":"

Indicates whether the package elements editor opens in an iframe.

\n","type":"text/plain"},"key":"isIframe","value":""},{"description":{"content":"

The URL to call upon cancellation or confirmation.

\n","type":"text/plain"},"key":"redirectUrl","value":""},{"description":{"content":"

The package elements editor language.

\n","type":"text/plain"},"key":"language","value":""}],"variable":[{"id":"f89e4d8f-1c49-4b42-9872-29288d869ef8","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"c0d384cd-08ae-4333-b8a3-ea2470c19b56","name":"The package elements editor url was created","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"abf9a326-c58d-4101-8923-a79d1327496d","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"3339797c-e730-4ab8-a313-02361798daeb","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fa62da6e-b621-42f1-b083-1c68de14f800","name":"Target package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"27c3e5a6-c9aa-4693-a2f4-cb83e8799226","name":"Unable to create action url","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/elements/actionurl?isIframe=&redirectUrl=&language=","host":[""],"path":["packages",":packageId","elements","actionurl"],"query":[{"description":"Indicates whether the package elements editor opens in an iframe.","key":"isIframe","value":""},{"description":"The URL to call upon cancellation or confirmation.","key":"redirectUrl","value":""},{"description":"The package elements editor language.","key":"language","value":""}],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4644aaa6-d3e1-4b3f-9d97-c0a560ba53b8"},{"name":"Gets a package's elements that are not placed yet","id":"6990b904-f0e8-4e85-b7c7-40ea6d88b092","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements","description":"

Get unplaced elements

\n

Description

\n

This call retrieves all unplaced elements within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"30f475b3-a2a1-4cd8-beb3-2ce50ce9df7a","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"92fb71e1-3064-4139-aeba-cd0668250c1c","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"ce8dd84f-cccc-4fe3-b862-9df3bd7ca78e","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f39c6594-92b8-429c-8325-5b873a4f2818","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"6990b904-f0e8-4e85-b7c7-40ea6d88b092"},{"name":"Creates unplaced elements for a package","id":"3493bd45-0a7e-4318-a099-a9557d63cd47","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/unplacedElements","description":"

Create unplaced element

\n

Description

\n

The POST element call adds an element to an existing package. This section covers the unplaced element parameters.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package.String (GUID)
\n

Request parameters

\n

These are the parameters to create an unplaced element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
\n

Extra parameters are needed depending on the type of unplaced element. More details can be found on the designated page, listed below.

\n\n

\n

Response parameters

\n

The response parameters depend on the element type, see the references above for details.

\n

Response codes

\n

The response codes depend on the element type, see the references above for details.

\n

Error codes

\n

The error codes depend on the element type, see the references above for details.

\n","urlObject":{"path":["packages",":packageId","unplacedElements"],"host":[""],"query":[],"variable":[{"id":"331caa61-f053-4946-ab62-1a9191c257be","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"015c168c-2de4-4aa2-9409-a7aecd3397d5","name":"Ok","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Failed\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"de81b3c4-5c3f-446e-a3b3-7ee139c561a4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"9433d043-435c-4488-8dab-5e12344c27cf","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"85a0b8c8-3ab5-44ab-bf6a-620caf11161b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"0dee13aa-0926-41cc-a2ae-9f06581c6592","name":"Unplaced elements could not be created for the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"SigningMethods\": [\n \"\"\n ],\n \"Type\": \"SigningField\",\n \"ExternalReference\": \"\",\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/unplacedElements","host":[""],"path":["packages",":packageId","unplacedElements"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3493bd45-0a7e-4318-a099-a9557d63cd47"},{"name":"Gets a package's unplaced element","id":"1e4b2ba3-34f8-4b4a-893f-9d3ceb8171a9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Get unplaced elements by ID

\n

Description

\n

This call retrieves a specified unplaced element within a specified package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/unplacedelements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described here .

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"d142081e-dc6a-4b34-a938-57d8ada8f7e7","type":"any","value":"","key":"packageId"},{"id":"a126ba19-66dc-4683-a291-d2ba6676007c","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"9b9d0102-4f24-421e-ad0e-c5b37d822558","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"SigningField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Status\": \"Pending\",\n \"ExternalReference\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"507fcc4d-5b37-4358-986e-2883d848e03e","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1b6fff84-4c6d-40ae-b2c9-326e60236c74","name":"Target package or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"1e4b2ba3-34f8-4b4a-893f-9d3ceb8171a9"},{"name":"Deletes a package's unplaced elements","id":"f7eedd34-b863-4e97-b0a4-5d5d2c377a16","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/unplacedElements/:elementId","description":"

Delete unplaced element by ID

\n

Description

\n

This call allows you to delete a specified unplaced element from a specified draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}//elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","urlObject":{"path":["packages",":packageId","unplacedElements",":elementId"],"host":[""],"query":[],"variable":[{"id":"6ecd33ce-9c27-4982-99bf-14e2b3a88e39","type":"any","value":"","key":"packageId"},{"id":"a523903a-8356-42f2-8c7e-371218df18af","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"ba44be48-2e04-475c-a633-909cfd5c7bfd","name":"UnplacedElement was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7e14fd9e-6ad1-4827-bb3b-715693160e64","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0adc01b2-4b57-40e5-aee8-bf4424b6c92f","name":"Target package or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"e791f14f-5788-40c5-8bb2-869f116467c5","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/unplacedElements/:elementId","host":[""],"path":["packages",":packageId","unplacedElements",":elementId"],"variable":[{"key":"packageId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"f7eedd34-b863-4e97-b0a4-5d5d2c377a16"},{"name":"Gets the elements on a document","id":"d39c5b8c-e5fc-433b-875e-ced7a4a4d294","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements","description":"

Get elements

\n

Description

\n

This call retrieves all elements within a specified document. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose elements you want to retrieve.String (GUID)
DocumentId*Unique identifier of the document whose elements you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll elements are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document id could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"0b800569-49b0-412c-b6f9-a7e7e7ba7362","type":"any","value":"","key":"packageId"},{"id":"3d52352b-f1d6-4652-8289-b740d39b8e4f","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"1df35476-2260-4130-a542-3b25a2814dd2","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n },\n {\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"InProgress\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n }\n]"},{"id":"578360ec-ff89-470a-bd72-60847e1f3245","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"17f68a41-ab41-4ff0-b4bb-29d9f10632ba","name":"Target package or document with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"d39c5b8c-e5fc-433b-875e-ced7a4a4d294"},{"name":"Creates a new SigningField element on a document","id":"2b698f02-2d5a-465e-a225-ad269fe93b0a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"Type\": \"\",\r\n \"ExternalReference\": \"\",\r\n \"Location\": {\r\n \"Page\": \"\",\r\n \"Left\": \"\",\r\n \"Top\": \"\"\r\n },\r\n \"Dimensions\": {\r\n \"Width\": \"\",\r\n \"Height\": \"\"\r\n },\r\n \"signingMethods\": [\r\n {\r\n \"Name\": \"\",\r\n \"KeyPair\": \"\"\r\n },\r\n \"\"\r\n ],\r\n \"LegalNotice\": \"\"\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateSigningField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the SigningField element parameters.

\n

A SigningField element can be created in four different ways:

\n\n

Important: A single document must not contain more than 30 signing fields.

\n

Note: Parameters marked with an asterisk are required.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a SigningField element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case SigningField element.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SigningMethodsThe SigningMethods that may be used to sign this signing field. Note: When using a single SigningMethod, it must also be placed in an array.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

LegalNotice

\n

A legal notice is a text the signer must retype before they are able to place their signature. Note that legal notices are case-sensitive.

\n

When defining a LegalNotice, you can choose from two LegalNotice types: name or text.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextUse the text parameter to use a custom legal notice, i.e. one that is not configured in the Config Index. The legal notice should be written in the same language as the documents of the package. Maximum length: 1000.String
NameThe name of the legal notice that will be added to the signing field. To correctly use this parameter, you need to know the name of the different legal notices that are configured in the Config Index. E.g. LegalNotice1. The value of the legal notices is also set in the Config Index. Note that the language in which the legal notice is displayed depends on the language of the document. Maximum length: 20String (enum)
\n

Note: When using big legal notices, the initiator is recommended to adjust signing field sizes accordingly, otherwise the legal notice may not be readable within the signing field text field. For example, a small signing field with a big legal notice may cause a font adjustment whereby the legal text becomes unreadable. \n 

\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 70. Maximum value is 999999_._Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons, it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains the location and dimensions of the element. Pattern: #[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat DC for instance), and you want to convert those input fields into signing fields.

\n

Attention: For performance reasons, it's recommended to do this at document upload time. It may happen that after a document conversion the field with the given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Invisible Signing Fields

\n

When the SigningMethod parameter is set to server signing for all signers, it is possible to sign the document without adding a visible signing field. In this case, the PDF will be signed, and the signature can be checked but it will not be visible on the document.

\n

To leave the visible signing field out, the following parameters must be omitted:

\n
    \n
  • Location
    • \n
  • Dimensions
    • \n
  • FieldId
    • \n
  • Marker
    • \n
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case SigningField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
StatusThe status of the document element. Possible values: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
CompletedDateDate and time on which this element was completed.String (date-time)
UsedSigningMethodSigningMethod that was used to sign this SigningField.String
SigningMethodsThe SigningMethods that may be used to sign this signing field.Array of strings
LegalNoticeLegal notice that will be added to the signing field.Object
\n

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 112. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 70. Maximum value is 999999Number (float)
\n

\n

LegalNotice

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
TextText of the legal notice.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
401Authentication failed, username or password incorrect
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409Element.FieldIdNotUnique
409Package.InvalidStatus
409Document.NotFoundInPackage
409SigningField.InvalidPage
409LegalNotice.NotFound
409SigningField.MarkerOrFieldIdNotFound
409SigningField.MultipleMarkersFound
409SigningField.MarkerAlreadySigned
409SigningField.InvalidWidthMarker
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"92bbac6c-92fb-4d4e-99a0-42d1b2f852ac","type":"any","value":"","key":"packageId"},{"id":"d6cd0d90-a1f6-4bd4-8c70-cf69d4086d11","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"930b6088-aec4-450d-888e-87364b33faea","name":"New element was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created element","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"c0eb3830-b9ad-4702-8e22-bf2f2f52af04","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"840a66ee-1f31-41aa-b8b5-b96cb58b8d2e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"73fa60fa-fc84-4371-a946-e897ac787e9c","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"ae88559d-9d71-44a2-ba87-a94fc53f2447","name":"element could not be added","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"2b698f02-2d5a-465e-a225-ad269fe93b0a"},{"name":"Creates a new TextBoxField element on a document","id":"c4824725-d1d8-4473-87e9-f060ebc83b3f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"textBoxField\",\n \"Marker\": \"TXT01\",\n \"Name\": \"\",\n \"externalReference\": \"\",\n \"DefaultValue\": \"\",\n \"ToolTipLabel\": \"\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateTextBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This section covers the TextBoxField element parameters.

\n

A TextBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a TextBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a TextBoxField element.

\n

Important: The parameters Name, IsMultiline and CharLimit must only be used to create TextBoxField elements using element location and element dimensions. As of eSignatures 6.8.0, it is also possible to use these parameters when creating TextBoxField elements with markers. They must not be used when creating TextBoxField elements when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of TextBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case TextBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the TextFieldBox is mandatory or optional. When set to true, the text field is mandatory. The default value is false. Note: If you're sending a document that already contains a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDefault value prefilled in the TextBoxField. Note: If you're sending a document that already contains a prefilled form field and enter a DefaultValue parameter, the value of this parameter will overwrite the original value. To avoid overwriting the original value, the DefaultValue parameter must be null.String
IsMultiLineDetermines whether the TextBoxField has multiple lines. Default value is false. Wen set to true, the TextBoxField will be scrollable.Boolean
CharLimitDetermines the maximum number of characters that may be entered in the TextBoxField.Integer
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used for documents that already contain input fields (created in Adobe Acrobat Pro for instance), and when you want to show those input fields as textbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case TextBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the TextFieldBox is mandatory or optional.Boolean
DefaultValueDefault value prefilled in the TextBoxField.String
IsMultiLineWhether the TextBoxField has multiple lines.Boolean
CharLimitMaximum number of characters that may be entered in the TextBoxField.Integer
ValueValue of the completed TextBoxField.String
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n    \"type\": \"textBoxField\",\n    \"name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"100\",\n        \"top\": \"50\"\n    },\n    \"dimensions\": {\n        \"width\": \"150\",\n        \"height\": \"50\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"textboxfield\",\n    \"DefaultValue\": \"Hello\",\n    \"IsMultiline\": true,\n    \"CharLimit\": 100,\n    \"Value\": null,\n    \"Name\": \"Textbox1\",\n    \"ToolTipLabel\": \"Enter text here\",\n    \"IsRequired\": false,\n    \"Id\": \"54e6d471-17ad-44e0-9798-b27c04da13d4\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 50.0,\n        \"Left\": 100.0\n    },\n    \"Dimensions\": {\n        \"Width\": 150.0,\n        \"Height\": 50.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
400TextBoxField.InvalidCharLimit
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"c6044418-4cab-4440-95aa-25aff5693dd4","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"de4cf531-e4c1-4e73-843c-e4aac8d61303","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"cbd5c8e0-942e-4090-b2ed-39d0fa9753f9","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"8069e7f0-1cb8-4e27-a881-5b50d937a8ef","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"8fa414f8-2b65-4530-874d-bfb32b4a28b5","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"c4824725-d1d8-4473-87e9-f060ebc83b3f"},{"name":"Creates a new CheckBoxField element on a document","id":"01a794bb-eecf-4b49-aa5c-601d26b61f0b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"checkBoxField\",\n \"Marker\": \"CHK01\",\n \"Name\": \"Checkbox1\",\n \"Type\": \"checkboxfield\",\n \"DefaultValue\": false,\n \"ToolTipLabel\": \"Check Me\",\n \"externalReference\": \"Checkbox1\",\n \"IsRequired\": false,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

CreateCheckBoxField element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the CheckBoxField element parameters.

\n

A CheckBoxField element can be created in three different ways:

\n\n

Note that the three ways of creating a CheckBoxField element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a CheckBoxField element.

\n

Important: The Name parameter must only be used to create CheckBoxField elements using element location and element dimensions. It must not be used when creating CheckBoxField elements using markers, or when specifying existing form fields (created in Adobe for instance) by means of the FieldId parameter.

\n

Note however, that it is supported to create different types of CheckBoxField elements within a single POST element call.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case CheckBoxField.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the checkbox is mandatory or optional. When set to true, the checkbox is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
DefaultValueDetermines whether the checkbox is checked or unchecked by default. When set to true, the checkbox is checked. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the DefaultValue parameter is set to false. Otherwise the original value will be overwritten.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

Element with marker

\n

Use this when a marker has been placed on the documents you will be uploading.

\n

Attention: For performance reasons it's recommended to do this at document upload time.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
MarkerA marker is a piece of text inside the document where an element must be. It contains location and dimensions of the element. Pattern: @[a-zA-Z]+(?:\\d*.)?\\d+.String
\n

See Detecting markers for more info.

\n

Element with field identifier

\n

The FieldId parameter must only be used documents that already contain input fields (created in Adobe Acrobat Pro for instance), and you want to show those input fields as checkbox fields.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
TypeType of element that was created. In this case CheckBoxField.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the checkbox is mandatory or optional.Boolean
DefaultValueWhether the checkbox is by default checked or unchecked.Boolean
CheckedThe value of the completed checkbox field.Boolean
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
 {\n    \"type\": \"checkBoxField\",\n    \"name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"DefaultValue\": false,\n    \"location\": {\n        \"page\": \"1\",\n        \"left\": \"300\",\n        \"top\": \"230\"\n    },\n    \"dimensions\": {\n        \"width\": \"12\",\n        \"height\": \"12\"\n    },\n    \"documentIndex\": 0\n},\n\n

Example response

\n
{\n    \"Type\": \"checkboxfield\",\n    \"DefaultValue\": false,\n    \"Checked\": false,\n    \"Name\": \"Checkbox10\",\n    \"ToolTipLabel\": \"Optional\",\n    \"IsRequired\": false,\n    \"Id\": \"c4577ad0-fcca-43b3-bb39-465c6e0a27f5\",\n    \"ActorId\": \"b2954765-0a50-4015-9287-abb2629dee0f\",\n    \"Location\": {\n        \"Page\": 1,\n        \"Top\": 230.0,\n        \"Left\": 300.0\n    },\n    \"Dimensions\": {\n        \"Width\": 12.0,\n        \"Height\": 12.0\n    },\n    \"Status\": \"Pending\",\n    \"ExternalReference\": null,\n    \"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409FormField.InvalidWidthMarker
409FormField.InvalidHeightMarker
409FormField.MarkerOrFieldIdNotFound
409FormField.MultipleMarkersFound
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"bec9d7dc-af1f-46d2-8e4d-5b5f092b6c04","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"7f9097f2-8549-4ea4-84cf-3cd8f67f82a7","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"69ad020c-02c0-475b-8d66-7689b8f683a2","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"b2e03dad-8ad8-405f-9b24-0781ba395d01","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"1f9f077c-2789-411c-be5f-289ec995cbd7","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"01a794bb-eecf-4b49-aa5c-601d26b61f0b"},{"name":"Creates a new RadioGroup element on a document","id":"4a8218bd-33e4-448e-bc26-53a08978af29","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"type\": \"RadioGroup\",\n \"name\": \"\",\n \"Label\": \"\",\n \"Options\": [\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 233.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"OptionLabel\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 293.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n },\n {\n \"Name\": \"\",\n \"IsSelected\": false,\n \"Location\": {\n \"Page\": 1,\n \"Top\": 685.0,\n \"Left\": 263.0\n },\n \"Dimensions\": {\n \"Width\": 18.0,\n \"Height\": 18.0\n }\n }\n ],\n \"ToolTipLabel\": \"\",\n \"IsRequired\": true,\n \"documentIndex\": 0\n}","options":{"raw":{"language":"json"}}},"url":"/packages/:packageId/documents/:documentId/elements","description":"

Create RadioGroup element

\n

Description

\n

The POST element call adds an element to an existing document.

\n

This sections covers the RadioGroup element parameters. A RadioGroup may contain multiple RadioGroup buttons.

\n

A RadioGroup element can be created in different ways: either the RadioGroup was already added to the document(s) you're sending, via an application such as Adobe Pro DC, or you create it using the eSignatures API.

\n

If the RadioGroup already exists, you must use the FieldId parameter

\n

If the RadioGroup is to be created through API, you need to add RadioGroupOptions to the RadioGroup. A RadioGroupOption represents a single radio button within a RadioGroup. RadioGroupOptions can be created by using specific dimensions and a specific location.

\n

Note that the different ways of creating a RadioGroup element can be combined within a single POST element call.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the package to which the element must be added.String (GUID)
\n

Request parameters

\n

These are the parameters to create a RadioGroup element.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of element that must be created. In this case RadioGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
NameName of the form field. Note that the name must be unique per document. Important: The Name parameter must not be used when specifying an existing RadioGroup (created in Adobe Pro DC for instance) by means of the FieldId parameter.String
LabelThe label or alternative name of the form field.String
ToolTipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor. Note: If you're sending a document that already contains a prefilled form field with a tooltip, and enter a ToolTipLabel parameter, the value of this parameter will overwrite the original value. To avoid overwritten the original value, the ToolTipLabel parameter must be null.String
IsRequiredDetermines whether the RadioGroup is mandatory or optional. When set to true, the RadioGroup is mandatory. The default value is false. Note: If you're sending documents that already contain a prefilled form field, make sure the IsRequired parameter is null. Otherwise the original value will be overwritten.Boolean
\n

CreateRadioOption

\n

A RadioOption represents a single radio button within a RadioGroup.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name/choice of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedDetermines whether the radio button is selected by default.Boolean
\n

Element with specific dimensions and specific location

\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page of the document on which the element is placed. The paging works as follows: '1' is the first page of the PDF, '2' the second, and so on. '0' must not be used as page value. To count backwards from the last page, use negative integers: '-1' for the last page, '-2' for the second to last, and so on.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element in pixels. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element in pixels. Minimum value is 10. Maximum value is 999999Number (float)
\n

RadioGroup with field identifier

\n

The FieldId parameter must only be used if the documents you're sending already contain radio buttons (created in Adobe Pro DC for instance), and you want those radio buttons to be kept.

\n

Attention: For performance reasons it's recommended to do this at document upload time. It may happen that after a document conversion the field with given identifier doesn't exist anymore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
FieldIdThe name of an input field on the document. Note that the FieldId must be unique per document.String
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdElement IDString (GUID)
ActorIdActor to which the element is linked.String (GUID)
Type*Type of element that was created. In this case RadioGroup.String (enum)
LocationLocation of the element within the document.Object
DimensionsDimensions of the element.Object
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
StatusThe status of the document element. The possible values are: Pending, InProgress, Rejected, Failed, Finished, Refused.String (enum)
CompletedDateDate and time on which this element was completed.String (date-time)
NameName of the form field.String
LabelThe label or alternative name of the form field.String
TooltipLabelThe value that will be shown as tooltip when a user hovers over the form field with the cursor.String
IsRequiredWhether the RadioGroup is mandatory or optional.Boolean
SelectedThe name of the selected RadioOption.String
OptionsThe RadioOptions (i.e. the different radio buttons within the group)Object
\n

RadioOption

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameThe name of the radio button.String
LabelThe label or alternative name of the radio button.String
IsSelectedWhether the radio button is selected.Boolean
LocationLocation of the radio button within the document.Object
DimensionsDimensions of the radio button.Object
\n

Location

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Page*The page within the document the element is on. Minimum value is 0.Integer
Top*How far from the top edge of the document the element is placed. Minimum value is 0.Number (float)
Left*How far from the left edge of the document the element is placed. Minimum value is 0.Number (float)
\n

Dimensions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Width*Width of the element. Minimum value is 10. Maximum value is 999999.Number (float)
Height*Height of the element. Minimum value is 10. Maximum value is 999999Number (float)
\n

Example request

\n
{\n\"type\": \"RadioGroup\",\n\"name\": \"Radio group\",\n\"Options\": [\n    {\n        \"Name\": \"one\",\n        \"ToolTipLabel\": \"RadioGroup one tooltip\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"ToolTipLabel\": \"RadioGroup two tooltip\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"three\",\n        \"ToolTipLabel\": \"RadioGroup three tooltip\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"documentIndex\": 0\n},\n\n

Example response

\n
{\n\"Type\": \"radiogroup\",\n\"Selected\": \"one\",\n\"Options\": [\n    {\n        \"Name\": \"three\",\n        \"Label\": \"RadioGroup three label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 50.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"one\",\n        \"Label\": \"RadioGroup one label\",\n        \"IsSelected\": true,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 10.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    },\n    {\n        \"Name\": \"two\",\n        \"Label\": \"RadioGroup two label\",\n        \"IsSelected\": false,\n        \"Location\": {\n            \"Page\": 1,\n            \"Top\": 700.0,\n            \"Left\": 30.0\n        },\n        \"Dimensions\": {\n            \"Width\": 18.0,\n            \"Height\": 18.0\n        }\n    }\n],\n\"Name\": \"Radio group\",\n\"Label\": null,\n\"ToolTipLabel\": \"Make a choice\",\n\"IsRequired\": true,\n\"Id\": \"035aec8f-a559-43ce-8fd7-f91ddd51f68f\",\n\"ActorId\": \"87fad4ea-d39d-435b-94fe-48072fd5a15f\",\n\"Location\": null,\n\"Dimensions\": null,\n\"Status\": \"Pending\",\n\"ExternalReference\": null,\n\"CompletedDate\": null\n},\n\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe element was created successfully.
400 Bad requestRequest validation failed. Element could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
409 ConflictElement could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
400Request.FieldMaxLength
400FormField.ShouldBeEmpty:{field}
401Authentication failed, username or password incorrect
409Element.FieldIdNotUnique
409Element.ExternalReferenceNotUnique
409Element.UsedFieldId
409FormField.NameNotUnique
409FormField.InvalidPage
409FormField.InvalidWidthCoordinate
409FormField.InvalidHeightCoordinate
409Package.InvalidStatus
409Document.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements"],"host":[""],"query":[],"variable":[{"id":"e53fa9e6-c342-4b9e-a698-64912b78f7d0","description":{"content":"

(Required) The target package's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"packageId"},{"id":"8d06eb6f-ef04-42e0-94f5-e647022ed10a","description":{"content":"

(Required) The target document's unique identifier

\n","type":"text/plain"},"type":"any","value":"00000000-0000-0000-0000-000000000000","key":"documentId"}]}},"response":[{"id":"deb3b55a-0eab-4b50-9e9c-fe3494206c93","name":"New element was created","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"disabled":false,"key":"Location","value":"","description":""},{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"\",\n \"Id\": \"\",\n \"ActorId\": {\n \"value\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"71e12c07-f579-4624-b43a-4a34b6479a42","name":"Request failed validation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"882cb34d-4b78-4638-904c-d7d34b567c0b","name":"Caller is unauthorized to perform this operation","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"text/plain"}],"cookie":[],"responseTime":null,"body":""},{"id":"1cfa7a15-972c-4b4f-8651-e6cd6689891c","name":"Target package or document with id could not be found","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"3b66453d-9433-4619-8726-64af8a94fd57","name":"element could not be added","originalRequest":{"method":"POST","header":[],"body":{"mode":"raw","raw":"{\n \"UnplacedElementId\": \"\",\n \"ExternalReference\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": {\n \"value\": \"\"\n },\n \"Height\": {\n \"value\": \"\"\n }\n }\n}","options":{"raw":{"language":"json"}}},"url":{"raw":"/packages/:packageId/documents/:documentId/elements","host":[""],"path":["packages",":packageId","documents",":documentId","elements"],"variable":[{"key":"packageId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target package's unique identifier"},{"key":"documentId","value":"00000000-0000-0000-0000-000000000000","description":"(Required) The target document's unique identifier"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4a8218bd-33e4-448e-bc26-53a08978af29"},{"name":"Gets an element by id","id":"b7e80f65-ff67-4fcc-a242-d07f55b3bbd0","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Get element by ID

\n

Description

\n

This call allows you to retrieve an element by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to those of the Create element call and are described there. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKElement is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or document could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Document.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"892f2dec-a2c6-404f-8e07-bedcecca5d0e","type":"any","value":"","key":"packageId"},{"id":"19849e73-2ad6-4a8f-9364-0542ebb432f5","type":"any","value":"","key":"documentId"},{"id":"3e48cc9b-4261-493a-9394-ad4eb052683e","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"956b9954-472d-4772-8ae0-6b326e598d31","name":"elements was found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"CheckBoxField\",\n \"Id\": \"\",\n \"ActorId\": \"\",\n \"Location\": {\n \"Page\": \"\",\n \"Left\": \"\",\n \"Top\": \"\"\n },\n \"Dimensions\": {\n \"Width\": \"\",\n \"Height\": \"\"\n },\n \"Status\": \"Refused\",\n \"ExternalReference\": \"\",\n \"CompletedDate\": \"\",\n \"UsedSigningMethod\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"KeyPairMappings\": [\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n },\n {\n \"SigningMethodName\": \"\",\n \"KeyPair\": \"\"\n }\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n }\n}"},{"id":"f7c87045-6fa2-43b9-ae9b-f262a081e3bf","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2071ba22-0e23-45a7-80aa-375693cbb6f5","name":"Target package, document or element with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"b7e80f65-ff67-4fcc-a242-d07f55b3bbd0"},{"name":"Deletes an element by id","id":"3a9e768b-cc2d-4c9f-bdf3-ec834111279a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/documents/:documentId/elements/:elementId","description":"

Delete element by ID

\n

Description

\n

This call allows you to delete a specified element from a specified document of a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/documents/{documentId}/elements/{elementId} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the document belongs.String (GUID)
DocumentId*Unique identifier of the document to which the element belongs.String (GUID)
ElementId*Unique identifier of the element that must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentElement was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, document or element could not be found.
409 ConflictElement could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Document.NotFound
404Location.NotFound
\n
","urlObject":{"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"host":[""],"query":[],"variable":[{"id":"593ceb83-3519-4e4a-b7f9-914ad1edb19d","type":"any","value":"","key":"packageId"},{"id":"d2102585-26e7-4146-a463-6222d717291e","type":"any","value":"","key":"documentId"},{"id":"9caaad5c-cfbd-4b3b-94fc-455cff5ee126","type":"any","value":"","key":"elementId"}]}},"response":[{"id":"977907b4-2988-4091-9a49-34933758f892","name":"Element was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"24773876-0547-4466-bfed-ef489d43efcb","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"570338d0-fdde-47dc-86e1-8d1e16021c05","name":"Target package, document or element with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"c69eafd6-9719-4903-9d1c-e5f0e0e91c89","name":"Element could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/documents/:documentId/elements/:elementId","host":[""],"path":["packages",":packageId","documents",":documentId","elements",":elementId"],"variable":[{"key":"packageId"},{"key":"documentId"},{"key":"elementId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"3a9e768b-cc2d-4c9f-bdf3-ec834111279a"}],"id":"d8d12c4d-0b14-473b-8eeb-ab9e7d7c36cb","description":"

Elements

\n

The Elements collection contains all resources and methods for creating and managing elements. \n 

\n

What is an element?

\n

An element is an item that is placed on a document and may be assigned to an actor.

\n

An element cannot exist on its own, it is always part of a document.

\n

Currently, four types of elements can be added to a document:

\n
    \n
  • SigningField elements
    • \n
  • TextBoxField elements
    • \n
  • CheckBoxField elements
    • \n
  • RadioGroup elements
    • \n
\n
 \n

SigningField elements determine where on the document a signature must be placed. SigningFields are always mandatory. \n 

\n

TextBoxField elements determine where on the document a textbox field will be placed. A textbox may contain a default, prefilled value, which can be modified afterwards by the end user. A textbox may be mandatory or optional. \n 

\n

CheckBoxField elements determine where on the document a checkbox field will be placed. A checkbox may be already checked by default, but can still be modified by the end user. Like textboxes, checkboxes may also be mandatory or optional. \n 

\n

RadioGroup elements determine where on the document a radio group will be placed. A radio button may be already checked by default, but can still be modified by the end user. Radio groups may also be mandatory or optional. \n 

\n

Element methods

\n\n","_postman_id":"d8d12c4d-0b14-473b-8eeb-ab9e7d7c36cb"},{"name":"Stakeholders","item":[{"name":"Gets all stakeholders of a package","id":"999dcab8-fb84-4f65-8b14-19fd345911cc","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders","description":"

Get stakeholders

\n

Description

\n

This call retrieves all stakeholders that currently exist within a specified package.

\n

The results are ordered by date on which the stakeholders were added to the package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

GET \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose stakeholders you want to retrieve.String (GUID)
\n

\n

Response parameters

\n

The response parameters are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll stakeholders are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"ff8d146c-7a9d-4c11-9429-7e220dd358e0","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"03ccc4ba-00fe-46ce-9d20-2c5eea692df4","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n },\n {\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n }\n]"},{"id":"a6e6ae9f-5e52-4bc9-a870-1cfae410d02c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6d2efab4-6022-4279-bddc-32cf2c4933b4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"999dcab8-fb84-4f65-8b14-19fd345911cc"},{"name":"Adds a stakeholder to a package","id":"835ee30f-b956-44ff-a8d9-45a4e133fac5","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"person\",\n \"Language\": \"en\",\n \"FirstName\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"BirthDate\": \"\",\n \"PhoneNumber\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders","description":"

Create stakeholder

\n

Description

\n

The POST stakeholders call creates a stakeholder and adds it to a specified package.

\n

A stakeholder is an entity that has an interest in a package.

\n

Three types of stakeholders can be created:

\n
    \n
  • a person stakeholder
    • \n
  • a group stakeholder
    • \n
  • a contactGroup stakeholder
    • \n
\n

A person stakeholder is a single person. Only that person will be able to take action on the package.

\n

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. Each person of the group will receive a unique URL to form fill/approve/sign their document.
Attention: as soon as one member of the group has taken action, the others no longer can.

\n

A contactGroup stakeholder can be used when a contact group has been created in the eSignatures WebPortal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the WebPortal instead of defining each member in the call.
Note: the stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder will be added.string (GUID)
\n

Request parameters

\n

Actor parameters

\n

The Actor parameters are identical to those of the Create actor call and are described here. \n 

\n

Create Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created. Supported values: person, group and contactGroup.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
Language*UI language of this stakeholder, expressed in a 2 letter ISO 639-1 code. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastName*Last name of the stakeholder Maximum length: 150String
EmailAddress*Email addressString (email)
BirthDate*Date of birth in format: YYYY-MM-DD Note: activating mandated signer validation in the Config Index might make this parameter required.String (date)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
\n

Create Group stakeholder

\n

Note that iDIN signing currently doesn't support Group stakeholders.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupName*Name of the group Maximum length: 128String
Members*Members that must be added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*Type of stakeholder that must be created.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCode*Code that was generated when creating a contact group in the eSignatures WebPortal.String
\n

Response parameters

\n

Person stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

\n

Create Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
GroupNameName of the groupString
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Create Contact Group stakeholder

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that must be created.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described here.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
ContactGroupCodeAn eSignatures contactGroup identifier.String
MembersMembers that are added to the group. The parameters are identical to those of a Person Stakeholder, except for type.Array of objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
201 CreatedThe stakeholder was created successfully.
400 Bad requestRequest validation failed. The stakeholder could not be created due to invalid parameters in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
409 ConflictStakeholder could not be created.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.FieldMaxLength
400Stakeholder.UnsupportedLanguage
400Stakeholder.EmailAddressInvalid
400Stakeholder.BirthDayInvalid
400Stakeholder.BirthDayInFuture
400Stakeholder.InvalidPhoneNumber
400GroupMember.RequiredFieldIsMissing
400GroupMember.UnsupportedLanguage
400GroupMember.EmailAddressInvalid
400GroupMember.BirthDayInvalid
400GroupMember.BirthDayInFuture
400GroupMember.InvalidPhoneNumber
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ContactGroup.NotFound
409Package.ContainsEmptyContactGroup
409Stakeholder.TypeInvalid
\n
","urlObject":{"path":["packages",":packageId","stakeholders"],"host":[""],"query":[],"variable":[{"id":"eaf858a3-57cc-4d86-8cbf-396411d35f51","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"4492c711-bbc3-4b8d-b202-871b972123de","name":"Stakeholder was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created stakeholder","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"4a5c14d9-97df-4f29-8f57-4f7e7acbe46e","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"51d8b878-24e7-4aa1-b855-4e06b643b7e4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a11aceeb-763f-4629-b011-14a125270a0a","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"6f0957e3-1610-4df1-9b14-a64702fdfb8d","name":"Stakeholder could not be added to the package","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Person\",\n \"ExternalReference\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders","host":[""],"path":["packages",":packageId","stakeholders"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"835ee30f-b956-44ff-a8d9-45a4e133fac5"},{"name":"Gets a stakeholder by id","id":"f0ccea8a-a4fd-4732-be48-5fc9acaed018","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Get stakeholder by ID

\n

Description

\n

This call allows you to retrieve a stakeholder by its ID.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to retrieve.String (GUID)
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

GET \n 

\n

Response parameters

\n

The response parameter are identical to the ones of the Create stakeholder call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKStakeholder is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b081d3a4-c04b-411a-9f64-37b846ddd6ef","type":"any","value":"","key":"packageId"},{"id":"8ac7398f-4211-4038-9d58-38b26c2b3cb8","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"c77c0a0c-30db-470d-b80c-2cfab0d78392","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Undecided\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Draft\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"},{"id":"0dc7e79a-c632-48d0-ac01-19a62ad26d09","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"bb8c8e12-dafb-424c-ba6d-378ee3151988","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"f0ccea8a-a4fd-4732-be48-5fc9acaed018"},{"name":"Deletes a stakeholder by id","id":"b75ee674-fecf-4061-a691-1d866e4d2d5d","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId","description":"

Delete stakeholder by ID

\n

Description

\n

This call allows you to delete a specified stakeholder from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId} \n 

\n

HTTP method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentStakeholder was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
409 ConflictStakeholder could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
409Stakeholder.CannotRemoveUndecided
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId"],"host":[""],"query":[],"variable":[{"id":"b725df35-5d70-4cb1-9d4a-86f72a30070d","type":"any","value":"","key":"packageId"},{"id":"16c34cea-4070-41fe-8e71-4658f664a4fa","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"484224b5-9322-4d18-a34b-06f4de369c28","name":"stakeholder was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6c84ee8c-44fa-4ba7-8452-bec9a588d721","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1ac1565c-3cb0-4bc3-9146-7506fa828ce3","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"d37f9c34-e8f7-4e02-ad96-d173a6e213e5","name":"Stakeholder could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"b75ee674-fecf-4061-a691-1d866e4d2d5d"}],"id":"bdb2dddc-b548-43b9-8e4e-932da46b4632","description":"

Stakeholders

\n

The Stakeholders collection contains all resources and methods for creating and managing stakeholders. \n 

\n

What is a stakeholder?

\n

A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must take. For instance, fill out forms, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group. \n 

\n

Stakeholder methods

\n\n","_postman_id":"bdb2dddc-b548-43b9-8e4e-932da46b4632"},{"name":"Actors","item":[{"name":"Gets a stakeholder's actors","id":"b41aa5a4-5e2b-49b9-8f20-9115919cbd76","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Get actors

\n

Description

\n

This call retrieves all actors of a specified stakeholder. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors \n 

\n

HTTP method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors you want to retrieve.String (GUID)
StakeholderId*Unique identifier of the stakeholder whose actors you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actors are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or stakeholder could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"80c7390c-5530-4da3-ab49-53106f15161f","type":"any","value":"","key":"packageId"},{"id":"a62e66cd-4252-46c0-8c62-b70ecbf46417","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"d78dd6d4-dba5-45e0-aeb3-ada97168bedc","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"ef2f3e51-2543-4e12-b41c-b3d1d90ae746","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"af0c8f67-e366-4400-8836-a46d6c230583","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"b41aa5a4-5e2b-49b9-8f20-9115919cbd76"},{"name":"Creates an actor for a stakeholder","id":"77bffc18-26bf-458d-8ac5-b58cf1f97807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors","description":"

Create actor

\n

Description

\n

The POST actors call creates an actor and adds it to the stakeholder you specify.

\n

An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are:

\n
    \n

  • FormFiller (as of eSignatures 6.3)
    A FormFiller must fill in TextBoxFields, CheckBoxFields and/or RadioGroups on a document. FormFiller actors do not sign or approve documents.

    \n
    • \n

  • Approver
    An Approver must approve the document before it is sent to any signer.
    Note that the approval may occur before or after the filling of forms.

    \n
    • \n

  • Signer
    A Signer must sign the document.

    \n
    • \n

  • Receiver
    A Receiver receives a a copy of the document when it has been signed by all signers. A Receiver does not take action on the document.

    \n
    • \n
\n

Important:

\n
    \n

  • All FormFillers/Approvers must be added to the first step of the process. This is because they must first take action on a package before it is sent to any signers. All receivers must be added to the last step of the process, since a package is only sent to receivers once it has been signed by all signers.

    \n
    • \n

  • If you do not define the process steps manually, all FormFiller actors are also added to the first step, together with the Approvers. As a result, the approval action may happen before, during or after the filling of forms.

    \n
    • \n
\n

Attention: All other process steps may only contain one type of actor. It's not supported to mix actor types, with the exception of FormFillers and Approvers, within an array.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor must be added.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor must be added.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. TextBoxField, CheckBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. Currently, four element types are supported: SigningField, TextBoxField, CheckBoxField and RadioGroup. This parameter does not apply to Receivers, since this actor type does not take action on documents. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action.
See the RedirectUrl Details section below for more information.		String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the actor.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
StatusStatus of an action. Available statuses are: Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor is linked. This parameter only applies to form fillers and signers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to approvers and receivers.String (url)
RedirectTypeThis parameter defines when exactly actors of the type FormFiller or Signer, when using an asynchronous signing method, are redirected.String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service. This parameter only applies to signers.String
CompletedDateDate when the action was completed.String (date-time)
SigningMethodSigning method the actor used to sign the document. This parameter only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.String (url)
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was created
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or stakeholder could not be found
409 ConflictActor could not be added to the stakeholder
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400Actor.TypeCantHaveFormFields
400Actor.InvalidOrder
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. ActorId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED*, REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592<;

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"host":[""],"query":[],"variable":[{"id":"a04ef99b-37ce-437b-af82-23306c060898","type":"any","value":"","key":"packageId"},{"id":"a5bb2a38-4009-4a83-b776-0499ca4cf998","type":"any","value":"","key":"stakeholderId"}]}},"response":[{"id":"69ab35c1-b6d2-4561-9b48-ba075eefd49f","name":"Actor was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"c9526862-37a8-4602-89e1-635b4a9c0d9b","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"d9feb695-5553-4eb1-aaee-2e83d6e655e4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a943085e-6df0-430e-a408-9c4ba442b43a","name":"Target package or stakeholder with id could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"b3b0f91b-e653-4f52-a787-bc4d6c7f5a49","name":"Actor could not be added to the stakeholder","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors"],"variable":[{"key":"packageId"},{"key":"stakeholderId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"77bffc18-26bf-458d-8ac5-b58cf1f97807"},{"name":"Gets an actor by id","id":"cdea1d45-ec67-4ad7-9e78-52cf6fcc32b8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Get actor by ID

\n

Description

\n

This call allows you to retrieve an actor by its ID. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to retrieve.String (GUID)
\n

Response parameters

\n

The Response parameter are identical to the ones of the Create actor call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKActor is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
404Stakeholder.NotFoundInPackage
404Actor.NotFound
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"410162f5-7175-495d-9371-a602ba1c0d79","type":"any","value":"","key":"packageId"},{"id":"b7ede867-a3cc-4e33-8b2a-7e71927b9ce4","type":"any","value":"","key":"stakeholderId"},{"id":"56c018c4-bb52-4abc-9e66-66bfbfe4c88f","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"dfb6c2c2-a022-4b8f-bf17-3931df770280","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"919d7b3b-fee5-4505-849e-5deb05eb2d88","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0cc9bdc6-84f7-48c1-b70f-74122e817e5e","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"cdea1d45-ec67-4ad7-9e78-52cf6fcc32b8"},{"name":"Deletes an actor by id","id":"fa4da2b3-8f8a-4657-9d9e-af04ae76d807","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","description":"

Delete actor by ID

\n

Description

\n

This call allows you to delete a specified actor from a draft package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId} \n 

\n

HTTP Method

\n

Delete \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the stakeholder belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
ActorId*Unique identifier of the actor you want to delete.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentActor was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package, stakeholder or actor could not be found.
409 ConflictActor could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
409Package.InvalidStatus
404Stakeholder.NotFound
404Actor.NotFound
409Actor.CannotRemoveUndecided
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"host":[""],"query":[],"variable":[{"id":"02c1160f-3597-4ce5-9267-8dfc254341b4","type":"any","value":"","key":"packageId"},{"id":"b41a3677-e93c-4815-bdb4-216756910dd6","type":"any","value":"","key":"stakeholderId"},{"id":"a5f66176-39cc-46cc-9a02-c8232126a69d","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"5c5fb36a-102d-440b-bacf-68cc5c9eb7f6","name":"Actor was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"22c92a27-c9dd-4c97-84ca-b7bbd90d5f49","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"21884054-af69-4ba2-b530-8617c2442d54","name":"Target package, stakeholder or actor with id could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"7e7f285b-89e8-4502-ba9a-50df58e78b1d","name":"Actor could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"fa4da2b3-8f8a-4657-9d9e-af04ae76d807"},{"name":"Actors Reassign Actor","id":"5e28775e-678e-47ae-a85e-dce6a07f4dbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","description":"

Reassign actor

\n

Description

\n

The POST reassign actor call reassigns an actor from the package towards a new actor .

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/stakeholders/{stakeholderId}/actors/{actorId}/reassign

\n

HTTP Method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the actor belongs.String (GUID)
StakeholderId*Unique identifier of the stakeholder to which the actor belongs.String (GUID)
actorId*Unique identifier of the actor which needs to be reassinged.String (GUID)
\n

Request parameters

\n

The request parameters are the same for all four types of actors, with the exception of AdditionalProperties. AdditionalProperties is only needed when reassigning a signing actor that has mandated signing and needs extra data therefore.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Stakeholder*The stakeholder the actor needs to be reassigned too.Object
Type*Type of stakeholder that must be created. When reassigning the only supported value is personString
(enum)
FirstName*First name of the stakeholder, Maximum length: 150String
LastName*Last name of the stakeholder, Maximum length: 150String
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length 256.String
EmailAddress*Email address.String (email)
PhoneNumberPhone number to receive an SMS OTP. Note: always add the country code in front of the phone number. E.g. +32xxxxxxxxx. It is recommended to use the plus sign as international dialing prefix instead of using “00”. Important: never use spaces in the phone number format.String
AdditionalPropertiesIn this array you can pass the additional properties that have been configured in the Contact Properties Settings of the Config Index. Additional properties may contain any additional stakeholder information the administrator deemed necessary. For instance, the stakeholder's maiden name, their nationality, etc. By default two additional properties are configured in every environment: BeID and BeLawyer. In the BeID property you can pass the stakeholder's national security number and in the BeLawyer property you can pass their lawyerID. As of eSignatures 6.2.1, mandated signing rules can be configured in the Config Index and applied to any additional property. When a mandated signing rule has been applied, the additional property to which it is applied becomes mandatory. Their value will be checked against the external data extracted from the signing certificate or returned by the signing service. If the data matches, the stakeholder will be mandated to sign. Tip: To know which additional properties are mandatory for which SigningMethod, do a Get SigningMethods call. To know which additional properties are supported but not mandatory, you need to check the Config Index or contact your administrator.Array of strings
ReassignmentReason*The reason behind this reassignmentString
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the stakeholder.String (GUID)
PackageIdUnique identifier of the package to which the stakeholder is added.String (GUID)
TypeType of stakeholder that is created. Supported values: person, group and contactGroup.String (enum)
ActorsActors that are added to the stakeholder. Their parameters are identical to those of the Create actor call and are described there.Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
LanguageUI language of this stakeholder, expressed in a 2 letter ISO 639-1 code.String (enum)
FirstNameFirst name of the stakeholder Maximum length: 150String
LastNameLast name of the stakeholder Maximum length: 150String
EmailAddressEmail addressString (email)
PhoneNumberPhone number to receive an SMS OTP.String
BirthDateDate of birth in format: YYYY-MM-DDString (date)
AdditionalPropertiesThe additional properties that have been passed for the stakeholder. E.g. \"BeId\": \"12345678900\" or \"Nationality\": \"Belgian\"Array of strings
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 OKActor was reassigned
400 Bad requestRequest failed validation
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package, stakeholder or actor could not be found
409 ConflictActor could not be reassigned
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400Request.FieldMinimumValue
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Stakeholder.NotFound
409Stakeholder.TypeInvalid
409Stakeholder.NotFoundInPackage
409Actor.TypeInvalid
409MandatedSigner.MissingRequiredProperty
\n
","urlObject":{"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"host":[""],"query":[],"variable":[{"id":"b382298f-c060-4c46-ba62-9aa90bcdb0c7","type":"any","value":"","key":"packageId"},{"id":"8500e907-53dc-427e-abfd-04a3dbfaff78","type":"any","value":"","key":"stakeholderId"},{"id":"8c0cff7a-df85-4423-a7b1-d70934e61d62","type":"any","value":"","key":"actorId"}]}},"response":[{"id":"4bcc57eb-8a8f-404a-9202-3055c1dfbc85","name":"Actor was reassigned","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Stakeholder\": {\n \"Type\": \"Person\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"EmailAddress\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"AdditionalProperties\": {\n \"officiaf\": {}\n },\n \"ExternalReference\": \"\"\n },\n \"ReassignmentReason\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/stakeholders/:stakeholderId/actors/:actorId/reassign","host":[""],"path":["packages",":packageId","stakeholders",":stakeholderId","actors",":actorId","reassign"],"variable":[{"key":"packageId"},{"key":"stakeholderId"},{"key":"actorId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Type\": \"Person\",\n \"Id\": \"\",\n \"PackageId\": \"\",\n \"Actors\": [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"InProgress\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n }\n ],\n \"ExternalReference\": \"\"\n}"}],"_postman_id":"5e28775e-678e-47ae-a85e-dce6a07f4dbb"}],"id":"bfe35f36-441f-4e2d-85fa-f1653b3df617","description":"

Actors

\n

The Actors collection contains all resources and methods for creating and managing actors.

\n

What is an actor?

\n

An actor is a single action a stakeholder needs to take on a package.

\n

There are four types of actors: form fillers, approvers, signers and receivers.

\n

Actor methods

\n\n","_postman_id":"bfe35f36-441f-4e2d-85fa-f1653b3df617"},{"name":"Process","item":[{"name":"All process steps","id":"6b11dd34-8d9f-4525-b9bf-933722b805cf","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process","description":"

Get all process steps

\n

Description

\n

This call retrieves all actions that must be done on a specified package.

\n

The actions are displayed in a 2D array where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process steps you want to retrieve.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"494c8e84-52c8-4683-9b6d-ceb2af2ad93b","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"04e04e9a-28f3-4bda-8983-ffb7314ee846","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Skipped\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n }\n ],\n [\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n }\n ]\n]"},{"id":"3ac16888-9346-47f5-9488-d5214341ceac","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"cdcec5a4-a0fd-4f15-8773-f87f9df3aea7","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"6b11dd34-8d9f-4525-b9bf-933722b805cf"},{"name":"Adds a step in the package's process","id":"9ffe03dd-860f-4377-83fc-26ad104edda9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Add process step

\n

Description

\n

This call adds a process step to a package's process. A process step consists of an array of actors.

\n

Please note: It's not supported to mix different actor types, with the exception of FormFillers and Approvers, within the same process step.

\n

The approval and form filling flow(s) need to proceed the signing flow. This limitation is in place since adding approval and/or form filling data to the source file is regarded as making changes to the source file. Adding approval and/or form filling data after signatures are placed will consequently render the electronic signature invalid.

\n

After the approval and form filling flow, all signing flows (sequential, parallel, mixed) need to be completed before the final (receiver) step.

\n

The receiver flow is always parallel.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process

\n

HTTP method

\n

POST

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderId*Unique identifier of the stakeholder.String (GUID)
\n

The Request parameters are the same for all four types of actors, with the exception of elements. SigningField elements can only be used for Signers, since the other actor types do not sign documents. CheckBoxField, TextBoxField and RadioGroup elements can only be used for FormFillers, since that is the only actor type that fills out forms.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Type*The type of action that must be done on the package. The possible values are: FormFiller, Approver, Signer and Receiver.String (enum)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures itself. Maximum length: 256String
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ElementsThe elements to which the actor will be linked. The elements parameters are identical to those of the Create element call and are described there.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. See the RedirectUrl section below for more details.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
StakeholderIdThe stakeholder's unique identifier.String (GUID)
TypeThe type of action that must be done on the package. The possible values are: approver, formfiller signer and receiver.String (enum)
StatusStatus of an action. Available statuses are: draft, waiting, available, inProgress, failed, finished, rejected, kipped.String (enum)
SuppressNotificationsThis parameter determines whether notifications are sent to the actor, informing them about the package. By default its value is false, which means notifications are sent.Boolean
ResultResult of a completed action. This parameter does not apply to receivers.Object
ElementsThe elements to which the actor will is linked. This parameter only applies to signers and formfillers.Array of objects
RedirectUrlUrl to which the stakeholder is redirected after completing this action. This parameter does not apply to receivers.String (url)
RedirectTypeIf a RedirectUrl has been defined then this parameter defines when exactly signer actors are redirected when using an asynchronous signing method or when a fom filler actor is redirected after filling out forms. Important: The RedirectType parameter must only be used for actors of the type FormFiller or Signer. It is not allowed for the types Approver or Receiver.
The RedirectType parameter is forbidden if no RedirectUrl has been set.
Possible values: AfterSession (default), AfterCompletion, AfterDelay, Immediately. By default, actors are redirected AfterSession. This means they cannot close the form filling/signing session and have to wait for all fields to be filled or all documents to be signed before being redirected. For actors to be redirected immediately, enter Immediately as value. For actors to be redirected after 5 seconds, enter AfterDelay as value. To make sure the final actor is only redirected after the entire package is completed, enter AfterCompletion as value. Note: when AfterCompletion is set for multiple actors, it will only be applied to the final actor. For the other actors, the default AfterSession will be used.		String (enum)
BackButtonUrlURL to which the end user is sent after pressing back button. This parameter does not apply to receivers.String (url)
\n

Result

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CompletedByEmail address.String (email)
VerifiedNameThe actor's verified name as mentioned on the signing certificate or signing service.String
CompletedDateDate when the action was completed.String (date-time)
IdentityIdentity date returned when signer used eID or OpenID Connect to sign.TBD
SigningMethodSigning method the actor used to sign the document. Only applies to signers.String (enum)
RejectReasonReason why a document was rejected.String
\n

Links / MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
LinksLinks to interact with the package for this person stakeholder.String (url)
MemberLinksEmail address of all group stakeholders and their links to interact with the package.Array of objects
\n

MemberLinks

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailEmail address of a member of the group stakeholder.String (email)
LinkLinks to interact with the package for this member.String (url)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedProcess step was successfully created.
401 UnauthorizedCaller is unauthorized to do this operation.
404 Not foundTarget package could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
\n

RedirectUrl Details

\n

The RedirectUrl is used to redirect the end user to the originating web application pointed to by that URL. The redirect occurs immediately after the user has filled out forms, signed or rejected.

\n

If there is no URL, the end user will have to close the current tab by clicking the Close Tab button of the browser.

\n

The base URL (without any parameters) must be given in the Create actor call and is appended with the following query parameters:

\n
    \n

  • SessionID (unique identifier of the package signing session, i.e. ActorId)

    \n
    • \n

  • ExternalReference (as found in the ExternalReference parameter of the Create Stakeholder call)

    \n
    • \n

  • Status (FINISHED,* REJECTED or INVALIDTOKEN)

    \n
    • \n

  • PackageExternalReference (as found in the ExternalReference parameter of the Create Package call)

    \n
    • \n
\n

Please Note

\n
    \n

  • Prior to eSignatures 6.4, the \"FINISHED\" status was called the \"SIGNED\" status.

    \n
    • \n

  • The ExternalReference parameters for both Stakeholder and Package are identical.
    However, PackageExternalReference has been renamed to clearly differentiate it within the resulting RedirectUrl.

    \n
    • \n
\n

The RedirectUrl parameter must contain a valid, absolute URL with no existing query parameters.
For example, if the RedirectUrl parameter contains the following redirect url:
https://myserver.example.org/rental/services/testredirect
then the effective RedirectUrl will be:
https://myserver.example.org/rental/services/testredirect?SessionID=5a2aff04-3cfa-4278-9480-64ac39f74734&ExternalReference=user1@example.org&Status=REJECTED&PackageExternalReference=dossier-3592

\n

Note: the end user can counterfeit the RedirectUrl because the redirection happens *client-side*!
Either establish a second secure channel by means of the CallbackUrl, or verify through session state that the end user returned from the correct session id. Afterwards a call to Get Package Status must be done to verify that the document was actually signed or rejected.

\n

Note during asynchronous signing, the signer has the possibility to close the signing session - by means of a Close button - while the signing continues in the background. The purpose of a RedirectUrl however is to redirect the signer to a new URL after the signing has finished. By default, the signer has to wait until all documents are signed before being redirected. Since eSignatures 5.4, it is possible to configure when the redirect happens (See the RedirectType parameter info above).

\n

Note during form filling, the form filler has the possibility to close the session - by means of a Close button - while the form fields are being processed in the background. The purpose of a RedirectUrl however is to redirect the form filler to a new URL after the form fields are filled and processed. By default, the form filler has to wait until all form fields are processed before being redirected.

\n","urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"329f46b8-f1ac-4285-aa91-c6dba732bf80","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"0b939607-bd96-4763-876b-a6f9084483b1","name":"Process step was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created process step","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"424d58a8-c833-40a2-b25a-0c3598174c56","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9a54bf9a-f111-43ca-9383-244a46d0dfe4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"9ffe03dd-860f-4377-83fc-26ad104edda9"},{"name":"Overwrites process steps of a package","id":"cfd7166b-b731-4628-a259-39498b13bb56","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Approver\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Id\": \"\"\n }\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process","description":"

Update process steps

\n

Description

\n

This call overwrites all actors in a package using a 2D array, where every set of actors are actions that can be done in parallel. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process \n 

\n

HTTP method

\n

PUT \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose actors must be updated.String (GUID)
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess steps were updated successfully.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n
","urlObject":{"path":["packages",":packageId","process"],"host":[""],"query":[],"variable":[{"id":"8cb6a632-0eb4-4604-986c-692e96418687","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"17ad6b60-4c52-47ec-9b6e-81694b2b9f39","name":"Process steps were updated","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6c864904-451a-4c29-9ac8-a49a3b7a4f8b","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"548ccafe-3767-4011-90d8-969cf130584e","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"[\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ],\n [\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n },\n {\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n }\n ]\n]","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process","host":[""],"path":["packages",":packageId","process"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"cfd7166b-b731-4628-a259-39498b13bb56"},{"name":"Gets all actions of a process step","id":"bf66c62a-cc7a-4a1f-b990-185de961a5a2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Get process step actions

\n

Description

\n

This call gets a particular set of actions that can be completed in parallel from any specific process step

\n

The process step of which the actions must be retrieved is specified by the StepIndex parameter. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
StepIndex*Index of the process step that must be retrieved.Integer
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"38817477-c2d7-4caa-a767-edf3f3362c37","type":"any","value":"","key":"packageId"},{"id":"2c62af68-b0c6-4dca-81c2-8a5bba117de5","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"7fa40dcd-2451-4237-881c-48b082ca0de5","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"2ee58029-f9eb-4f3d-a429-450529a4afde","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"61fc5eb4-94f9-4efc-b07e-87f87cd62aba","name":"package or process step could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"bf66c62a-cc7a-4a1f-b990-185de961a5a2"},{"name":"Deletes a process step and all its actors","id":"48c52758-3051-40ec-98d7-68fa823ab24b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/:stepIndex","description":"

Delete process step and its actions

\n

This call allows you to delete a process step and its actions from a package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose process step must be deleted.String (GUID)
StepIndex*Index of the process step that must be deleted.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentProcess step was successfully deleted.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundTarget package or process step could not be found.
409 ConflictProcess step could not be deleted.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Actor.NotFound
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"69e99bbe-c957-4f95-8a5e-fd1f3c333762","type":"any","value":"","key":"packageId"},{"id":"ddf8c92e-0471-41ab-84ab-08154e81498e","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"87491f18-de77-4a68-a9e6-1deca219e9c0","name":"Process step was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6d303779-65d9-49dd-a6ad-c54641afa9e8","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"dab11777-e0fd-40fb-ba91-6ed86d5ba72f","name":"package or process step could not be found","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"ee74b4a3-28c2-4ed3-829b-f7cf644aaf00","name":"Process step could not be deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"48c52758-3051-40ec-98d7-68fa823ab24b"},{"name":"Adds an actor to a process step","id":"4e333675-df68-40a8-b307-b92f76442d31","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"StakeholderId\": \"\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n {\n \"Type\": \"signingField\",\n \"DocumentId\": \"\",\n \"SigningMethods\": [\n \"\",\n \"\"\n ],\n \"LegalNotice\": {\n \"Text\": \"\"\n },\n \"Location\": {\n \"Page\": 2,\n \"Top\": 200,\n \"Left\": 200\n },\n \"Dimensions\": {\n \"Width\": 200,\n \"Height\": 200\n }\n }\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/process/:stepIndex","description":"

Add process step action

\n

Description

\n

This call adds an actor to a process step, by means of StepIndex. The StepIndex indicates at which step of the process the action must be done. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/process/{stepIndex} \n 

\n

HTTP method

\n

POST \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step must be added.String (GUID)
StepIndex*Step at which the action must be done.Integer
\n

Request parameters

\n

The request parameters are identical to those of the Add process step call and are described here. \n 

\n

Response parameters

\n

The response parameters are identical to those of the Add process step call and are described here. \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / Description
201 CreatedActor was successfully added to the process step
401 UnauthorizedCaller is unauthorized to do this operation
404 Not foundTarget package or process step could not be found
409 ConflictActor could not be added to the process step
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400LegalNotice.NameAndTextUsedSimultaneously
400Request.RequiredFieldIsMissing
400Request.OneOfFieldsIsMissing
400Request.FieldMaxLength
400SigningType.Invalid
400Request.FieldMinimumValue
400SigningField.InvalidWidthCoordinate
400FormField.InvalidWidthCoordinate
400SigningField.InvalidHeightCoordinate
400FormField.InvalidHeightCoordinate
400Url.Invalid
400Actor.InvalidOrder
401Authentication failed, username or password incorrect
409Package.InvalidStatus
409Document.DataMissing
404Actor.NotFound
404SigningField.NotFound
404FormField.NotFound
409Package.InvalidStatus
409ProcessStep.MixedTypes
404Stakeholder.NotFound
\n
","urlObject":{"path":["packages",":packageId","process",":stepIndex"],"host":[""],"query":[],"variable":[{"id":"bbffb313-54b1-4fac-9424-3d8a041e8372","type":"any","value":"","key":"packageId"},{"id":"4359cfc6-4a75-470c-9f3d-3599f4da1358","type":"any","value":"","key":"stepIndex"}]}},"response":[{"id":"863f31e0-cda3-417e-a8a5-589190286e51","name":"Actor was added to the process step. The location header points to the location of the created actor under its stakeholder.\n","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created actor (under its stakeholder)","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Waiting\",\n \"SuppressNotifications\": false\n}"},{"id":"adba9a06-c562-4c34-957a-92c55600a5a1","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"cd037414-9bc9-4525-bb1c-d1ff188231a9","name":"package or process step could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"cfa1e257-c231-4a18-94d4-e9cbe9ac25b1","name":"Actor could not be added to the process step","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Type\": \"Signer\",\n \"SuppressNotifications\": false,\n \"Elements\": [\n null,\n null\n ],\n \"RedirectUrl\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/process/:stepIndex","host":[""],"path":["packages",":packageId","process",":stepIndex"],"variable":[{"key":"packageId"},{"key":"stepIndex"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"4e333675-df68-40a8-b307-b92f76442d31"},{"name":"Gets all actions the current process step","id":"130d99d2-6397-44f7-ac44-a4172d06fa75","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/process/current","description":"

Get process step actions of current process step

\n

Description

\n

This call gets all actions that can be completed in parallel of the current process step, i.e. the process step that is currently in progress.

\n

In the example below, you'll see that the actions of the signing step are retrieved. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4//packages/{packageId}/process/current \n 

\n

HTTP method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the process step belongs.String (GUID)
\n

Response parameters

\n

The response parameters are identical to the ones of the Add process step action call and are described here.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll actions of the current process steps are successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundPackage or process step could not be found.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","process","current"],"host":[""],"query":[],"variable":[{"id":"b0f57706-a3a1-4b37-8e31-155455e643e5","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"720fbd51-bbdd-4776-b7b7-137b03186d6a","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Available\",\n \"SuppressNotifications\": false\n },\n {\n \"Id\": \"\",\n \"Type\": \"Signer\",\n \"Status\": \"Failed\",\n \"SuppressNotifications\": false\n }\n]"},{"id":"96950e3c-5d08-4bcc-bd48-f6c721ca8b92","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"57d05f04-b2f5-4462-a4fc-329ef4d74773","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/process/current","host":[""],"path":["packages",":packageId","process","current"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"130d99d2-6397-44f7-ac44-a4172d06fa75"}],"id":"c782d200-eb87-4f9e-b2e4-c04efae87f49","description":"

Process

\n

The Process collection contains all resources and methods to set up a package's form filling/approval/signing process. Its allows you to set up parallel, sequential and complex signing flows. \n 

\n

How does a process work?

\n

A package's process defines which stakeholder will do their action at which moment in time.

\n

A process may consist of multiple process steps. A process step is a set of actions that may be done in parallel. For instance, approve in process step 1, fill out forms in step 2, sign in step 3 and receive in step 4. The approval step may occur before or after the filling of forms, as long as they are both prior to signing. Receivers must be placed in the last step, since they receive the signed documents after the signers have completed their tasks. \n 

\n

Process methods

\n\n","_postman_id":"c782d200-eb87-4f9e-b2e4-c04efae87f49"},{"name":"SigningMethods","item":[{"name":"Returns all signing methods that are currently configured","id":"b037353a-9984-4b30-a662-4ae2f4c6cf34","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/signingmethods?isActive=","description":"

Get signing methods

\n

Description

\n

This call retrieves all signing methods that are currently enabled or disabled in the eSignatures Configuration Index and are thus available to the users.

\n

This call is useful for integrators who need to know which methods are currently enabled in a given eSignatures installation, otherwise that list of signing methods would need to be duplicated in the integrator’s configuration database as well.

\n

Note that this API v4 call retrieves both the SigningTypes that are configured in the deprecated Signing Options settings group, and the SigningMethods and the Signing Behavior they belong to, configured in the new Signing Options settings group. The new SigningMethods are formatted as follows: SigningBehavior:SigningMethod. E.g. SmartCard:BeID.

\n

Note that as of eSignatures 6.5.0, a new Signing Behavior has been introduced: RemoteHashSigning. This Signing Behavior currently encompasses two supported SigningMethods: itsme and Swisscom. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/signingmethods \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveDetermines whether the call must retrieve all active or inactive SigningMethods.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
isActiveWhether the SigningMethod can be used to create new signing fields.Boolean
NameThe name of the SigningMethod as configured in the Configuration Index.String
DisplayNamesThe names of the SigningMethod in the different languages as they will be shown to a signer in WYSIWYS.Array or objects
DisplayNamesInitiatorThe names of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
DescriptionsThe descriptions of the SigningMethod in the different languages as they will be shown to an initiator in the WebPortal.Array or objects
RequiredPropertiesThe properties that are required to be passed in the Create stakeholders call. When RequiredProperties are returned for a SigningMethod, it means mandated signing rules have been applied to that SigningMethod. To check whether a signer is mandated to sign during a particular signing session, eSignatures compares the data passed in the RequiredProperties to the external data retrieved from the signing certificate or returned by the signing service.Array or objects
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe SigningMethods list is successfully returned.
401 UnauthorizedCaller is unauthorized to do this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["signingmethods"],"host":[""],"query":[{"description":{"content":"

only return active / inactive signing methods

\n","type":"text/plain"},"key":"isActive","value":""}],"variable":[]}},"response":[{"id":"6176c432-648a-4556-916a-297c62ec2547","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"consequat_958\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"dolore6\": \"\"\n },\n \"Descriptions\": {\n \"anima38\": \"\",\n \"pariatur_f\": \"\",\n \"ea_2b\": \"\",\n \"exercitation0f\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"do_e8\": \"\",\n \"irured\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"esse_33\": \"\",\n \"ullamco_d\": \"\",\n \"proident_82d\": \"\"\n }\n }\n ]\n },\n {\n \"IsActive\": \"\",\n \"Name\": \"\",\n \"DisplayNames\": {\n \"est96\": \"\"\n },\n \"DisplayNamesInitiator\": {\n \"nostrud87\": \"\"\n },\n \"Descriptions\": {\n \"laboris9c6\": \"\",\n \"irure18f\": \"\",\n \"id_7\": \"\"\n },\n \"RequiredProperties\": [\n \"\",\n \"\"\n ],\n \"KeyPairs\": [\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"incididunt_d\": \"\"\n }\n },\n {\n \"Name\": \"\",\n \"DisplayNames\": {\n \"aliquip_dd\": \"\",\n \"aliquip_5\": \"\",\n \"magna4\": \"\"\n }\n }\n ]\n }\n]"},{"id":"d7011d5e-a2a4-4116-8e76-429b862e08c8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/signingmethods?isActive=","host":[""],"path":["signingmethods"],"query":[{"description":"only return active / inactive signing methods","key":"isActive","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"b037353a-9984-4b30-a662-4ae2f4c6cf34"}],"id":"0584d64a-46a5-4f1b-b49d-bc892a71339b","description":"

The signing methods that are configured in eSignatures

\n","_postman_id":"0584d64a-46a5-4f1b-b49d-bc892a71339b"},{"name":"AuditProofs","item":[{"name":"This call allows API users to add extra proofs from an external source to a location on a document.","id":"f146a358-2a75-4db9-ab6b-901777ca82d3","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": \"\",\n \"Name\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/:packageId/auditproof/proofs","description":"

Add Proof from External Source

\n

Description

\n

This call allows API users to add extra proofs from an external source to a location on a document.

\n

This call can be done multiple times for the same location and even when the package is fully signed (in this case the API user is responsible for making sure that any proof is added before retrieving the signed Audit proofs xml). \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/proofs \n 

\n

HTTP Method

\n

POST \n 

\n

MIME Type

\n

application/json

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
LocationIdMandatoryLocation of the signature for which the proof content is generated.Guid
NameMandatoryName of the proof.String
DescriptionOptionalBrief human-readable description of the proof.String
TypeMandatoryA machine-readable “type” key. Can be freely chosen.String
ContentMandatoryThe actual content of the proof.Base64 string
IpAddressOptionalIP address of the end user of the external source for which the proof was added.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentThe proof was created for the requested location.
400 Bad RequestThe request contained parameters which could not be accepted.
404 Not FoundThe documentId or the LocationId could not be found.
409 ConflictThe proof could not be added due to some other reason.
\n
","urlObject":{"path":["packages",":packageId","auditproof","proofs"],"host":[""],"query":[],"variable":[{"id":"802a6e0f-fa5d-4c7e-84cd-8471fd9d7801","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"42e9e430-35f7-4bd1-b377-7b9a3c3614af","name":"Audit proof created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Created","code":201,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"aefec9a1-0a71-4e1e-aa81-d89953e0ae5b","name":"When the Content is not a valid Base64 string or the Type contains an invalid value","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"d3803aa8-39be-4783-b80c-b75344d59bd5","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"0b395c41-4b9a-4151-8468-2d0b19c73380","name":"When the packageId could not be found","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"4eaace96-ff06-45d2-9709-fc133aeb1a16","name":"When Audit Proofs are not enabled or package is in an invalid status.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"LocationId\": {\n \"value\": \"\",\n \"Type\": \"TIME_STAMP_CERTIFICATE\",\n \"Content\": \"\",\n \"Description\": \"\",\n \"IpAddress\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/packages/:packageId/auditproof/proofs","host":[""],"path":["packages",":packageId","auditproof","proofs"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"f146a358-2a75-4db9-ab6b-901777ca82d3"},{"name":"Downloads the Audit Proofs of a package","id":"d3cfc44e-696d-47d2-87f4-c2d04168d7a1","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download","description":"

Get Package or Document Audit Proofs Xml

\n

Description

\n

A package’s audit proofs xml can be retrieved when the package is fully signed. The same applies for a document: it only works when the containing package is fully signed. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof/download/{documentId} \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package to which the proofs belong.String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the package status is right).

\n","urlObject":{"path":["packages",":packageId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"130834e3-6e9c-4285-ae49-cd00a90d12bd","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"3bf102bf-2399-45bf-8246-d363bbb2dd2b","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"85c5765b-c6f2-42c7-b36a-f049f5e18e62","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"5c46bc37-10d9-449a-be01-1b0b03569fce","name":"When the packageId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"087bc752-3b8a-49c2-b87b-1d66c816e923","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download","host":[""],"path":["packages",":packageId","auditproof","download"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"d3cfc44e-696d-47d2-87f4-c2d04168d7a1"},{"name":"Downloads the Audit Proofs of a document","id":"2877e6b5-58b2-4270-a78c-fdb4b610985a","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packages/:packageId/auditproof/download/:documentId","description":"

Downloads the Audit Proofs of a document

\n","urlObject":{"path":["packages",":packageId","auditproof","download",":documentId"],"host":[""],"query":[],"variable":[{"id":"6a6615cd-d01e-4ca7-bcd9-2b6f58d2537d","type":"any","value":"","key":"packageId"},{"id":"3f1c2f0f-e359-414d-9d3b-d73365eead10","type":"any","value":"","key":"documentId"}]}},"response":[{"id":"655cf587-a7e6-491e-ba04-590fdd458469","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"7de2ddc3-b781-48ba-a1a8-eec424d0570f","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"348c058a-d18e-4411-b92e-3ddbf23343ca","name":"When the document or package could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"a81f3857-2bd3-4e19-aefd-d70e0d0db0cd","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this document.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/auditproof/download/:documentId","host":[""],"path":["packages",":packageId","auditproof","download",":documentId"],"variable":[{"key":"packageId"},{"key":"documentId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"2877e6b5-58b2-4270-a78c-fdb4b610985a"},{"name":"Downloads the Audit Proofs by packageCorrelationId","id":"dff62746-99f3-4181-b0af-1ee032f8e7da","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/packagecorrelations/:correlationId/auditproof/download","description":"

Get Package or Document Correlation Audit Proofs Xml

\n

Description

\n

Correlation ids are used to track packages or documents across several passes through the eSignatures application. On a document it states the “external identity” of that document so that it can be established what happened to it, whereas for a package it depends on how you interpret the data.

\n

Either way, retrieving the audit proofs for such an identifier will combine all available audit proofs into one big XML. Items will be grouped into packages and documents to indicate how they were uploaded several times of the lifespan of the set.

\n

Important: combined audit proofs xmls should only be retrieved when all packages containing the package correlation id or all documents with the given correlation id are fully signed, or otherwise in a final state. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packagecorrelations/{correlationId}/auditproof/download

\n

https://[servername]:[port]/esig/webportalapi/v4/documentcorrelations/{correlationId}/auditproof/download

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/xml

\n

 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
CorrelationId*Unique identifier that links related audit proofs together .String (GUID)
\n

Response parameters

\n

The API will return a signed xml containing the Audit proofs (if the status of all items in the set is right). \n 

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit proofs xml is returned.
404 Not FoundThe document/package id could not be found.
409 ConflictThe package is not fully signed.
\n
","urlObject":{"path":["packagecorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"5236174f-eac2-426c-9904-c0b893790911","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"d57ba809-5ec9-4169-982c-2608d06647cf","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"436b2ea8-4d95-43b8-89dd-9a6c21e48a33","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4acb64f5-7d95-4895-82f7-cdb7054c2a50","name":"When no package with given correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"11de6bfc-4ae4-4617-b8ac-212aed59ba9b","name":"When Audit Proofs are not enabled or no Audit Proofs are available for this package.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packagecorrelations/:correlationId/auditproof/download","host":[""],"path":["packagecorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"dff62746-99f3-4181-b0af-1ee032f8e7da"},{"name":"Downloads the Audit Proofs by documentCorrelationId","id":"87d28f5a-5b0a-44ed-96d6-b6c65780aaaa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/xml"}],"url":"/documentcorrelations/:correlationId/auditproof/download","description":"

Downloads the Audit Proofs by documentCorrelationId

\n","urlObject":{"path":["documentcorrelations",":correlationId","auditproof","download"],"host":[""],"query":[],"variable":[{"id":"9efb8a1a-4450-4826-99a8-da5c4e1be255","type":"any","value":"","key":"correlationId"}]}},"response":[{"id":"c102615c-7503-4d27-9879-fb54b127171f","name":"The signed audit proofs XML","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"xml","header":[{"key":"Content-Type","value":"application/xml"}],"cookie":[],"responseTime":null,"body":"\n(string)"},{"id":"27e7cb53-88a9-4501-b7ca-e0cad61fec2c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"57ae5082-74ae-4b5f-aa91-00774e2ce5f0","name":"When the correlationId could not be found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"267df940-6651-40c1-bb86-36a1c16d6cea","name":"When Audit Proofs are not enabled","originalRequest":{"method":"GET","header":[],"url":{"raw":"/documentcorrelations/:correlationId/auditproof/download","host":[""],"path":["documentcorrelations",":correlationId","auditproof","download"],"variable":[{"key":"correlationId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"87d28f5a-5b0a-44ed-96d6-b6c65780aaaa"},{"name":"Deletes audit proof infos of a package","id":"d27e9a55-ec97-41ab-8a53-8c7095238956","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/auditproof","description":"

Delete Audit Proof Info

\n

Description

\n

Audit proofs are no longer automatically deleted as soon as the corresponding package is deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can now be configured on environment level in the Configuration Index, or specified per package through the DelayedDeletionDate parameter in the Delete Package by ID call.

\n

If you want to delete audit proofs earlier than specified, you can also do a manual Delete audit proof info call and specify of which package the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/auditproof \n 

\n

HTTP Method

\n

DELETE \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*Unique identifier of the package whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
204 No contentAll audit proofs are deleted successfully
401 UnauthorizedCaller is unauthorized to perform this operation.
404 Not foundNo audit proofs available for this package
409 ConflictCould not perform operation on package with id {id}
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
409Package.InvalidStatus
404Package.NotFound
\n
","urlObject":{"path":["packages",":packageId","auditproof"],"host":[""],"query":[],"variable":[{"id":"5891e857-8b98-4fa5-a0ee-1ff35482d958","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"44d3d124-fda2-4392-bfaf-8d5edb00db98","name":"Audit proofs of package were succesfully deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"9e7d86d3-cafa-4069-8c6b-906dccc8f588","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"a01684b4-7d96-4728-b5ba-7956d745c5da","name":"No auditproofs were found for given packageId","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"6fa017f9-eef5-4ff2-a868-df3b76061ccb","name":"Package wasn't deleted yet","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/packages/:packageId/auditproof","host":[""],"path":["packages",":packageId","auditproof"],"variable":[{"key":"packageId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"d27e9a55-ec97-41ab-8a53-8c7095238956"},{"name":"Gets audit proof infos of all packages","id":"aa67386a-9d13-4167-b5dd-215cea2e0418","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","description":"

Get Audit Proof Info

\n

Description

\n

This calls allows to you retrieve the audit proof info of packages.

\n

Currently, you can retrieve the audit proof info of DELETED packages.

\n

You can narrow the search for specific audit proof info by adding the optional request parameters listed below. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproofinfo \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Status*Status of the package. Currently, you can only retrieve the audit proof info of packages that have the status DELETED.String (enum)
PackageIdUnique identifier of the package whose audit proof info you want to retrieve.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.String (GUID)
CreatedBeforeGets only the audit proof info of packages created before this date. ISO 8601 date format.String (date-time)
CreatedAfterGets only the audit proof info of packages created after this date. ISO 8601 date format.String (date-time)
DeletedBeforeGets only the audit proof info of the packages deleted before this date. ISO 8601 date format.String (date-time)
DeletedAfterGets only the audit proof info of the packages deleted after this date. ISO 8601 date format.String (date-time)
ExpiresBeforeGets only the audit proof info of the packages that expire before this date. ISO 8601 date format.String (date-time)
ExpiresAfterGets only the audit proof info of the packages that expire after this date. ISO 8601 date format.String (date-time)
SortFieldField on which the result is sorted.String
SortOrderDetermines how the result is sorted. Available values are asc, desc. Default value: descString (enum)
PageSizeMaximum number of records in the response Default value is 20.Integer
PageNumberThe page to retrieve. Default value is 0. Example: when you set the PageNumber to 0 and the PageSize is 20, the first 20 packages are retrieved. When you set the PageNumber to 1 and the PageSize is 20, the next 20 packages are retrieved. Note: when the value you pass is higher than the actual number of pages, an empty list will be returned.
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.String (GUID)
PackageNameName of the package.String
CorrelationIdIdentifier that correlates this package to other resources in the proofs system.
PackageCreationDateDate and time when the package was created according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
PackageDeletionDateDate and time when the package was deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DelayedDeletionDateDate and time when the audit proofs of the package were deleted according to the server. Format is ISO 8601 date-time. E.g. 2020-01-23T12:34:00.000ZString (date-time)
DocumentsThe documents that the retrieved package contains.Array of objects
\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
NameName of the document. Minimum length: 1 Maximum length: 150String (GUID)
DocumentIdUnique identifier of the document.String (GUID)
CorrelationIdIdentifier that correlates this document to other resources in the proofs system.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAll audit proof info is successfully retrieved.
400 Bad requestThe parameter Status does not support value 'xyz'. Supported value is 'Deleted' only.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","auditproofinfo"],"host":[""],"query":[{"description":{"content":"

(Required) The status of the packages to get the auditproof infos for

\n","type":"text/plain"},"key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items deleted before given date

\n","type":"text/plain"},"key":"deletedBefore","value":""},{"description":{"content":"

Select items deleted after given date

\n","type":"text/plain"},"key":"deletedAfter","value":""},{"description":{"content":"

Select items expires before given date

\n","type":"text/plain"},"key":"expiresBefore","value":""},{"description":{"content":"

Select items expires after given date

\n","type":"text/plain"},"key":"expiresAfter","value":""},{"description":{"content":"

Select items on given correlationId

\n","type":"text/plain"},"key":"correlationId","value":""},{"description":{"content":"

specify how the result is sorted, default is ascending

\n","type":"text/plain"},"key":"sortOrder","value":"desc"},{"description":{"content":"

specify on which field the result is sorted

\n","type":"text/plain"},"key":"sortField","value":"packageDeletionDate"}],"variable":[]}},"response":[{"id":"e1da9ca0-993e-47e3-af5d-d6587dc65255","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n },\n {\n \"PackageId\": \"\",\n \"PackageName\": \"\",\n \"CorrelationId\": \"\",\n \"PackageCreationDate\": \"\",\n \"PackageDeletionDate\": \"\",\n \"DelayedDeletionDate\": \"\",\n \"Documents\": [\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n },\n {\n \"Name\": \"\",\n \"DocumentId\": \"\",\n \"CorrelationId\": \"\"\n }\n ]\n }\n ]\n}"},{"id":"d7a6429b-fcce-411a-bfb1-cfcee573d41e","name":"Bad request","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"ec0f65e8-8930-4621-9067-c9274edcafb9","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/auditproofinfo?status=Deleted&packageId=&pageNumber=0&pageSize=20&createdBefore=&createdAfter=&deletedBefore=&deletedAfter=&expiresBefore=&expiresAfter=&correlationId=&sortOrder=desc&sortField=packageDeletionDate","host":[""],"path":["packages","auditproofinfo"],"query":[{"description":"(Required) The status of the packages to get the auditproof infos for","key":"status","value":"Deleted"},{"key":"packageId","value":""},{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items deleted before given date","key":"deletedBefore","value":""},{"description":"Select items deleted after given date","key":"deletedAfter","value":""},{"description":"Select items expires before given date","key":"expiresBefore","value":""},{"description":"Select items expires after given date","key":"expiresAfter","value":""},{"description":"Select items on given correlationId","key":"correlationId","value":""},{"description":"specify how the result is sorted, default is ascending","key":"sortOrder","value":"desc"},{"description":"specify on which field the result is sorted","key":"sortField","value":"packageDeletionDate"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"aa67386a-9d13-4167-b5dd-215cea2e0418"}],"id":"87367a10-0574-493b-aa3e-72c252b453b5","description":"

Audit proofs

\n

⚠️ Deprecated: Use AuditTrails endpoints for new implementations.

\n

Access Level: Machine-to-machine only (administrative access required)

\n

Legacy endpoints for adding proofs to packages and retrieving signed XML
documents containing all audit proofs. This functionality is deprecated
in favor of the AuditTrails endpoints.

\n

When the Audit proofs setting is enabled in the Configuration Index, eSignatures keeps Audit proofs about each signature that is placed.

\n

The following information is collected in base64 format about each form filling:
Form filling events information

\n
    \n

  • Time when form fields on the package were filled out

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an invitation was sent to form fill the package, content of the invitation, recipient(s)

    \n
    • \n

  • For all form filling events mentioned above, the form filler’s IP address is added to the Audit proofs.

    \n
    • \n
\n

The following information is collected in base64 format about each approval:
Approval events information

\n
    \n

  • Time when package was approved

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an invitation was sent to approve the package, content of the invitation, recipient(s)

    \n
    • \n

  • For all approval events mentioned above, the approver’s IP address is added to the Audit proofs.

    \n
    • \n
\n

The following information is collected in base64 format about each reassignment:
Reassignment events information

\n
    \n

  • Time when package was reassigned

    \n
    • \n

  • Reason why the package was reassigned

    \n
    • \n

  • First name of previous and new approver or signer

    \n
    • \n

  • Last name of previous and new approver or signer

    \n
    • \n

  • Email address of previous and new approver or signer

    \n
    • \n
\n

The following information is collected in base64 format about each signature:
Signing events information

\n
    \n

  • Start time of signing, end time of signing

    \n
    • \n

  • Time when reminder was sent, content of the reminder, recipient(s) of the reminder

    \n
    • \n

  • Time when an SMS OTP was sent, content of the SMS, recipient of the SMS

    \n
    • \n

  • Time when a mail OTP was sent, content of the mail, recipient of the mail

    \n
    • \n

  • Time when an invitation was sent to sign the package, content of the invitation, recipient(s)

    \n
    • \n

  • For the signing events mentioned above, the signer’s IP address is added to the Audit proofs

    \n
    • \n
\n

Signature information

\n
    \n

  • Signature certificate that was used to place the signature, its certificate chain and certificate revocation information (OCSP / CRL)

    \n
    • \n

  • Timestamp certificate, its certificate chain and certificate revocation information (OCSP / CRL)

    \n
    • \n

  • The signed PDF when the package is fully signed

    \n
    • \n

  • If the setting Intermediate States Saved is enabled in the Configuration Index, a copy of the document gets added in base64 format after each signature.

    \n
    • \n

  • Any extra proofs which were added by the client through the Post extra proof call.

    \n
    • \n

  • If the setting IsOneTimeUrlEnabled is disabled in the Configuration Index, the following value is added for every signature that was placed by means of an “unsecure” URL: “One-time URL was disabled when signing”.

    \n
    • \n
\n

All this data is stored in xml files which are signed at the end. The signed xml files can then be retrieved through one of the following four calls:

\n
    \n

  1. The Audit proofs of a specific document within a package, based on the document id

    \n
    2. \n

  2. The Audit proofs of a specific package, based on the package id.

    \n
    3. \n

  3. The Audit proofs of all packages containing a specific package correlation id.

    \n
    4. \n

  4. The Audit proofs of all documents containing a specific document correlation id.

    \n
    5. \n
\n

Important: If a package is deleted via the API or the eSignatures Portal then the audit proofs are deleted as well.

\n","_postman_id":"87367a10-0574-493b-aa3e-72c252b453b5"},{"name":"AuditTrails","item":[{"name":"Downloads the audit trail of the Package (PDF)","id":"672679e6-40fd-4a38-ad06-cbb113d9bdab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/audittrail","description":"

Get Audit Trail

\n

Description

\n

This call allows you to retrieve the PDF Audit Trail representation of the specified package in a specified language.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/audittrail/{culture}

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/pdf

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to retrieve.String (GUID)
Culture*ISO 639-1 language code of the language.String
\n

Response parameters

\n

The API returns the Audit Trail in pdf format.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit Trail pdf is returned.
404 Not FoundThe package could not be found.
409 ConflictThe package is not in a final state.
401 UnauthorizedYou don't have the correct rights for this call
\n
","urlObject":{"path":["packages",":packageId","audittrail"],"host":[""],"query":[],"variable":[{"id":"883c935d-578c-4892-8b09-a182107031bb","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"0e755bad-82cd-445f-899a-7d7a644fe923","name":"The signed Audit Trail in pdf file.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"OK","code":200,"_postman_previewlanguage":"text","header":[{"key":"Content-Type","value":"application/pdf"}],"cookie":[],"responseTime":null,"body":""},{"id":"f854bd9c-fdfa-4dd3-b82f-52f53848ebaf","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"1a6f11d1-513e-4b32-8f91-957e30d36db8","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"e3f1536d-ce81-4716-8973-ac7496b7f11d","name":"When the package has not been fully signed, rejected or revoked","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/:culture","host":[""],"path":["packages",":packageId","audittrail",":culture"],"variable":[{"key":"packageId"},{"key":"culture"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"672679e6-40fd-4a38-ad06-cbb113d9bdab"},{"name":"Retrieve the audit trail of the Package (JSON)","id":"828aa374-6a0e-4a45-b7e4-a430c3c716b9","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/pdf"}],"url":"/packages/:packageId/audittrail","description":"

Get Audit Trail

\n

Description

\n

This call allows you to retrieve the Audit Trail of the specified package, consisting of a list of events

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/{packageId}/audittrail

\n

HTTP Method

\n

GET

\n

MIME Type

\n

application/json

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to retrieveString (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
RequestedOnDate of request for this audit trailString (date)
PackageInfoInformation about the packagePackageInfo
EventsA list of events that occured during the lifecycle of the packageArray of EventInfo
\n

PackageInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the packageString (GUID)
CreatedOnDate of package creationString (date)
InitiatorThe package initiator (user) email addressString
StatusThe status of the packageString (enum)
DocumentsThe documents in the packageArray of DocumentInfo
\n

DocumentInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the documentString (GUID)
NameThe name of the documentString
PagesCountsCount of pages in the documentInteger
SignedFieldsCountThe number of signed fields on the documentInteger
\n

EventInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of an eventString (GUID)
CreatedOnDate of event creationString (date)
IpAddressThe ip address of the user that made the event happenString
TypeUnique name defining the event typeString (enum): AuditEventType
UserThe email address of the logged in application user that made the event happenString
PackageDetailAdditional information about the package that is relevant for the package events.
Not empty for events that affect the package itself.		PackageAuditDetail
ActionDetailAdditional information about the actor that is relevant for the action events.
Not empty for events that affect an actor itself.		ActionAuditDetail
\n

PackageAuditDetail

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ApiSourceThe source of the API that initiated the event.String (enum):
- Unknown
- PortalApi
- WebPortalApiV3
- WebPortalApiV4
TemplateCodeIdentifier of the template from which the package was created.
Not empty when `PackageCreated` event indicates the package was created from a template.		String
DocumentsState of documents at time of the event.Array of DocumentInfo
\n

ActionAuditDetail

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActorIdAn actor's (action) unique identifierString (GUID)
PersonIdA person's (stakeholder) unique identifierString (GUID)
EmailAddressThe person's email addressString
SigningMethodsUsed signing methods for a `SignActionCompleted` eventArray of SigningMethod
DocumentsAffected documents during an action (Approved, FormFilled or Signed).Array of ActionDocumentInfo
\n

ActionDocumentInfo

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdThe unique identifier of the documentString (GUID)
NameThe name of the documentString
\n

AuditEventType

\n

Unique name defining the event type. The list is not exhaustive and subject to extension.

\n
    \n

  • PackageCreated

    \n
    • \n

  • PackageSubmitted

    \n
    • \n

  • PackageDeleted

    \n
    • \n

  • PackageEnded

    \n
    • \n

  • PackageExpired

    \n
    • \n

  • PackageExtended

    \n
    • \n

  • PackageRevoked

    \n
    • \n

  • PackageFinished

    \n
    • \n

  • PackageRejected

    \n
    • \n

  • PackageSentToReceiver

    \n
    • \n

  • PackageApprovalEnded

    \n
    • \n

  • PackageEnded

    \n
    • \n

  • PackageActionInvitationSent

    \n
    • \n

  • PackageActionReminderSent

    \n
    • \n

  • PackageViewedByPerson

    \n
    • \n

  • UnsignedPackageDownloadedByAnonymous

    \n
    • \n

  • UnsignedPackageDownloadedByPerson

    \n
    • \n

  • DocumentsRefusedBySigner

    \n
    • \n

  • FormFieldsRefused

    \n
    • \n

  • MailOtpAuthenticationCodeSent

    \n
    • \n

  • MailOtpAuthenticationSuccessful

    \n
    • \n

  • SmsOtpAuthenticationCodeSent

    \n
    • \n

  • SmsOtpAuthenticationSuccessful

    \n
    • \n

  • PhoneNumberVerified

    \n
    • \n

  • SmsOtpSent

    \n
    • \n

  • MailVerified

    \n
    • \n

  • MailOtpSent

    \n
    • \n

  • PackageActionRejected

    \n
    • \n

  • PackageActionInProgress

    \n
    • \n

  • PackageActionFailed

    \n
    • \n

  • ApproveActionCompleted

    \n
    • \n

  • FormFillActionCompleted

    \n
    • \n

  • SignActionCompleted

    \n
    • \n

  • PackageActionReassigned

    \n
    • \n

  • PackageActionReassignedByUser

    \n
    • \n

  • DocumentDownloadedByAnonymous

    \n
    • \n

  • DocumentDownloadedByPerson

    \n
    • \n

  • DocumentDownloadedByUser

    \n
    • \n

  • PackageDownloadedByAnonymous

    \n
    • \n

  • PackageDownloadedByPerson

    \n
    • \n

  • PackageDownloadedByUser

    \n
    • \n
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe Audit Trail is returned
404 Not FoundThe package could not be found
409 ConflictThe package is in wrong state
401 UnauthorizedYou don't have the correct rights for this call
\n
","urlObject":{"path":["packages",":packageId","audittrail"],"host":[""],"query":[],"variable":[{"id":"c1158942-96c7-416f-8d82-b8669477a884","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"8b6c0ade-0f16-4421-8781-f62a1df53991","name":"The audit events","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/","host":[""],"path":["packages",":packageId","audittrail",""],"variable":[{"key":"packageId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json","description":"","type":"text"}],"cookie":[],"responseTime":null,"body":"{\n \"RequestedOn\": \"2025-02-27T09:09:46Z\",\n \"PackageInfo\": {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example package\",\n \"CreatedOn\": \"2025-01-14T13:24:49Z\",\n \"Initiator\": \"hello@world.invalid\",\n \"Status\": \"Draft\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\",\n \"PagesCount\": 10,\n \"SignedFieldsCount\": 4\n }\n ]\n },\n \"Events\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"CreatedOn\": \"2024-08-14T13:24:49Z\",\n \"IpAddress\": \"127.1.0.0\",\n \"Type\": \"SignActionCompleted\",\n \"User\": \"hello@world.invalid\",\n \"PackageDetail\": {\n \"ApiSource\": \"Unknown\",\n \"TemplateCode\": \"string\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\",\n \"PagesCount\": 10,\n \"SignedFieldsCount\": 4\n }\n ]\n },\n \"ActionDetail\": {\n \"ActorId\": \"00000000-0000-0000-0000-000000000000\",\n \"PersonId\": \"00000000-0000-0000-0000-000000000000\",\n \"EmailAddress\": \"hello@world.invalid\",\n \"Documents\": [\n {\n \"Id\": \"00000000-0000-0000-0000-000000000000\",\n \"Name\": \"example document\"\n }\n ],\n \"SigningMethods\": [\n {\n \"Name\": \"MailOtp:MailOtp\",\n \"KeyPair\": \"MyKeyPair\"\n }\n ]\n }\n }\n ]\n}"},{"id":"d7bd6620-9497-48da-bb3d-f3d87c4d1a26","name":"When the package is not found","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail","host":[""],"path":["packages",":packageId","audittrail"],"variable":[{"key":"packageId","value":""}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"828aa374-6a0e-4a45-b7e4-a430c3c716b9"},{"name":"Verifies whether the audittrail is valid","id":"02854f71-2f1a-4339-8472-4144e77f12ec","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/:packageId/audittrail/verify","description":"

Verify Audit Trail

\n

Description

\n

This call allows you to verify if a specified package's Audit Trail is valid. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/packages/{packageId}/audittrail/verify \n 

\n

HTTP Method

\n

GET \n 

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageId*The unique identifier of the package whose Audit Trail you want to verify.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA Boolean indicating if the Audit Trail is valid.
404 Not FoundThe package could not be found.
\n
","urlObject":{"path":["packages",":packageId","audittrail","verify"],"host":[""],"query":[],"variable":[{"id":"1f3863ff-a16f-435d-aa75-fd7512189f4e","type":"any","value":"","key":"packageId"}]}},"response":[{"id":"64466dec-2e4b-4b8e-b5bb-59824294de78","name":"A boolean indicating if the Audit Trail is valid.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":""},{"id":"12a77b7b-6c09-4409-a3d1-1a10c54704a3","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/:packageId/audittrail/verify","host":[""],"path":["packages",":packageId","audittrail","verify"],"variable":[{"key":"packageId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"}],"_postman_id":"02854f71-2f1a-4339-8472-4144e77f12ec"}],"id":"ab5a7f5a-777d-464e-bb1b-40fe63a1ed92","description":"

Audit trails

\n

Prior eSignatures versions already supported the Audit Proof, an XML that can be downloaded through the API that keeps track of all actions taken on a package.

\n

With eSignatures 6.1.0, we added the notion of the Audit Trail. The Audit Trail is a pdf that can be downloaded from the Document Portal or through the API. The Audit Trail contains the actions taken for that package and can be downloaded when the package is in a final state.

\n","_postman_id":"ab5a7f5a-777d-464e-bb1b-40fe63a1ed92"},{"name":"Templates","item":[{"name":"Gets all package templates available","id":"571b9cf4-57c3-4f82-af19-94ee03246c8f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","description":"

Get Templates

\n

Description

\n

This call retrieves all the templates, and their code, that are available in the eSignatures WebPortal.

\n

The Template code can be entered as a request parameter when doing a Create Package call. The package will then be created with all the information from the template. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/templates \n 

\n

HTTP Method

\n

GET \n 

\n

MIME Type

\n

application/json \n 

\n

Query parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent/DescriptionType
pageNumberOptionalThe page to retrieve.Int
pageSizeOptionalMaximum number of recordsInt
documentGroupCodeOptionalFilter the records by the document group they are in.String
sortOptional‘asc’ or ‘desc’ to specify in which way sorting happens.String
createdAfterOptionalOnly show the templates that are created after a
specific date		DateTime
createdBeforeOptionalOnly show the templates that are created before a
specific date		DateTime
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent/DescriptionType
TotalNumber of total records for the given parametersInt
ItemsList of templatesArray of objects
NameName of the templateString
TemplateCodeUnique id of the templateString
PageSizeMaximum number of recordsInt
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe templates list gets returned successfully.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
NoneNo errors
\n
","urlObject":{"path":["templates"],"host":[""],"query":[{"description":{"content":"

The page to retrieve

\n","type":"text/plain"},"key":"pageNumber","value":"0"},{"description":{"content":"

Maximum number of records in the response

\n","type":"text/plain"},"key":"pageSize","value":"20"},{"description":{"content":"

Select items created before given date

\n","type":"text/plain"},"key":"createdBefore","value":""},{"description":{"content":"

Select items created after given date

\n","type":"text/plain"},"key":"createdAfter","value":""},{"description":{"content":"

Select items that have given documentGroupCode

\n","type":"text/plain"},"key":"documentGroupCode","value":""},{"description":{"content":"

specify how the result is sorted, default is descending

\n","type":"text/plain"},"key":"sort","value":"desc"}],"variable":[]}},"response":[{"id":"b7a888d0-0757-46fe-b7fa-3abbc3aaffaa","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/templates?pageNumber=0&pageSize=20&createdBefore=&createdAfter=&documentGroupCode=&sort=desc","host":[""],"path":["templates"],"query":[{"description":"The page to retrieve","key":"pageNumber","value":"0"},{"description":"Maximum number of records in the response","key":"pageSize","value":"20"},{"description":"Select items created before given date","key":"createdBefore","value":""},{"description":"Select items created after given date","key":"createdAfter","value":""},{"description":"Select items that have given documentGroupCode","key":"documentGroupCode","value":""},{"description":"specify how the result is sorted, default is descending","key":"sort","value":"desc"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"PageSize\": \"\",\n \"Total\": \"\",\n \"Items\": [\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n },\n {\n \"Name\": \"\",\n \"TemplateCode\": \"\"\n }\n ]\n}"}],"_postman_id":"571b9cf4-57c3-4f82-af19-94ee03246c8f"}],"id":"9e3b8e1d-68ca-43ac-9093-aa14a49627ac","description":"

Package templates module

\n","_postman_id":"9e3b8e1d-68ca-43ac-9093-aa14a49627ac"},{"name":"AbsencePeriods","item":[{"name":"Creates an absence period","id":"c302a401-cca9-40fd-bbc5-e19d322cf65b","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods","description":"

API v4: Create an absence period

\n

Set an absence period for a user and assign their substitutes.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods

\n

Method

\n

POST

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required.

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
User*The email address of a user for whom an absence period is created.String (email)
StartDate*

Absence start date and time.

For example:

2023-02-01T11:40:00Z 2024-12-20T08:00:00+0200

String ($date-time)
EndDateAbsence end date and time.String ($date-time)
SubstitutesSubstitutes for this absence period.
See the child parameters of this parameter.		Array of objects
\n

Child parameters of the Substitutes parameter

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
Type*Possible values:String
person

A stakeholder who takes action on the package individually.		See the parameters for the person type.
group

A group stakeholder is a group of people who can interact with the package. The members of the group must be specified within the POST stakeholder call. When a group of people is defined, any member of the group will be able to fill out forms and approve or sign a package on behalf of the entire group. Each person in the group will receive a unique URL for the package.

As soon as one member of the group has taken action, the others no longer can.		See the parameters for the group type.
contactgroup

A contact group stakeholder can be used when a contact group has been created in the eSignatures Portal. This type functions in the same way as a a group stakeholder. The only difference is that you simply pass the contactGroup code obtained in the eSignatures Portal instead of defining each member in the call.

Note: The stakeholder type contactGroup only exists when the package is in draft status. When the status changes to pending, the stakeholder type contactGroup is converted to group. The contactGroupCode value remains.		See the parameters for the contactgroup type.
ActionTypes*

Possible values:

- approver
- receiver
- signer
- formFiller

String (enum)
AllowedToReassignIf enabled, the substitute can assign a package to another user.Boolean
\n

Parameters for the person type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
Language*User language.
A two-letter ISO 639-1 language code.

For example: en		String
TitleFor example: Ms.String
FirstNameThe first name of a substitute.

Maximum length: 150 characters.		String
LastName*The last name of a substitute.

Maximum length: 150 characters.		String
EmailAddress*The email address of a substitute.String (email)
PhoneNumberThe phone number of a substitute.String
BirthDateThe birth date of a substitute.String (date)
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the group type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
GroupName*The name of the group.
Maximum length: 128 characters.		String
Members*The list of persons in this group.
Use the same parameters as described for the person type.		Array of objects
ExternalReferenceExternal reference to this resource given by a calling application. This parameter is not used by eSignatures.

Maximum length: 256 characters.		String
\n

Parameters for the contactgroup type

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParametersDescriptionType
ContactGroupCode*The contact group code in the eSignatures Portal.String
\n

Response parameters

\n

The response parameters will be the same as the request parameters. Additionally, the required response parameter Id*, which is the unique identifier of the string($guid) type, will be returned for:

\n
    \n
  • The absence period
    • \n
  • The substitutes (person, group, contact group)
    • \n
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
201The absence period has been created.
400

The request failed validation.

For example:

[ { \"Code\": \"Name.MinimumLength:6\", \"Message\": \"The minimum length for a name is 6\" } ]

401The caller is unauthorized to perform this operation.
403It is forbidden to perform this operation.
404

An exception has occurred.

For example:

{ \"Code\": \"User.NotFound\", \"Message\": \"No user found with email address [hello@world.test].\" }

409

The request conflicts with existing information and/or business rules.

For example:

{ \"Code\": \"AbsencePeriod.OverlapsWithExistingAbsencePeriod\", \"Message\": \"The provided absence period overlaps with an existing absence period.\" }

\n

Error codes

\n

|

HTTP code

|

Error code

|\n|

400

|

Json.DeserializationFailed

|\n|

400

|

Request.RequiredFieldIsMissing:{fieldName}

|\n|

400

|

Request.FieldMaxLength:{fieldName},{maxLength}

|\n|

400

|

EmailAddress.Invalid

|\n|

400

|

Request.DateInvalid:{date}

|\n|

400

|

Actor.TypeInvalid:{actorType}

|\n|

400

|

Person.UnsupportedLanguage:{language}

|\n|

400

|

Person.EmailAddressInvalid:{emailAddress}

|\n|

400

|

Person.BirthDayInvalid:{date}

|\n|

400

|

Person.BirthDayInFuture:{date}

|\n|

400

|

Person.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

ContactProperty.Invalid:{contactPropertyKey}

|\n|

400

|

ContactProperty.Duplicate:{contactPropertyKey}

|\n|

400

|

ContactProperty.MissingValue:{contactPropertyKey}

|\n|

400

|

ContactProperty.InvalidValue:{contactPropertyKey}

|\n|

400

|

GroupMember.UnsupportedLanguage:{language}

|\n|

400

|

GroupMember.EmailAddressInvalid:{emailAddress}

|\n|

400

|

GroupMember.BirthDayInvalid:{date}

|\n|

400

|

GroupMember.BirthDayInFuture:{date}

|\n|

400

|

GroupMember.InvalidPhoneNumber:{phoneNumber}

|\n|

400

|

PersonGroup.DuplicateEmailAddress

|\n|

400

|

AbsencePeriod.ShouldHaveStartDate

|\n|

400

|

AbsencePeriod.StartDateInThePast

|\n|

400

|

AbsencePeriod.EndDateBeforeStartDate

|\n|

403

|

ContactGroup.ViewNotAllowed

|\n|

403

|

OutOfOffice.Disabled

|\n|

404

|

User.NotFound:{emailAddress}

|\n|

404

|

ContactGroup.NotFound:{contactGroupCode}

|\n|

409

|

AbsencePeriod.OverlapsWithExistingAbsencePeriod

|\n|

409

|

AbsencePeriod.HasMoreThanOneSubstituteDefinedForActionType:{actionType}

|

\n","urlObject":{"path":["absenceperiods"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"0c45fe7f-7427-4060-b783-a6eaa371a18f","name":"Absence period was created","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Created","code":201,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"},{"description":{"content":"Location of the newly created absence period","type":"text/plain"},"key":"Location","value":""}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"8bc3e1cb-ef71-4e2a-b72c-ce5d901aef17","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"20b5eecf-f1eb-4cde-875c-29e699a0e7e0","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"05207d15-5e09-4220-a146-f3202c580013","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"d6243615-6c18-48c3-9bc9-6ac65edbe82f","name":"An exception has occured","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"2257ff52-f32d-44f8-ae45-4b97347a6ed3","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"laborum_0\": {},\n \"occaecatea3\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"euc\": {}\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods"},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"c302a401-cca9-40fd-bbc5-e19d322cf65b"},{"name":"Gets absence periods by email address","id":"4e0b86a3-2cfb-43bb-bdf5-04b6f91fa370","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods?email=","description":"

API v4: Get absence periods by email address

\n

Get the list of absence periods for a user by email address.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
email*The email address of a user for whom an absence period is created.String (email)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","urlObject":{"path":["absenceperiods"],"host":[""],"query":[{"description":{"content":"

(Required) The user email address to search on

\n","type":"text/plain"},"key":"email","value":""}],"variable":[]}},"response":[{"id":"812f5781-ded6-4624-a5a9-2a43169f4935","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"approver\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"deserunt_18\": {},\n \"cupidatat_583\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"approver\",\n \"formFiller\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"nisi_c\": {},\n \"ea_3\": {}\n }\n }\n ]\n },\n {\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"sint3a8\": {},\n \"voluptate_9\": {},\n \"euc90\": {},\n \"qui_7\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"eu_7a\": {},\n \"quis02c\": {}\n }\n }\n ]\n }\n]"},{"id":"07e28a90-4a10-451a-aa14-f9363dc7e65e","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"ec980b40-933d-4e14-ac17-3a6f65290ed5","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"f8a6f00f-198c-47fa-9b84-a096a8607a45","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods?email=","host":[""],"path":["absenceperiods"],"query":[{"description":"(Required) The user email address to search on","key":"email","value":""}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"4e0b86a3-2cfb-43bb-bdf5-04b6f91fa370"},{"name":"Gets an absence period by id","id":"f645e26b-b869-43b5-bf77-592657cc3d17","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Get an absence period by ID

\n

Get the information about an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

GET

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"f9b0a641-325b-4b82-8ce6-da86a61d842c","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"05743e70-e79e-41f6-a848-3f35bfbb9b85","name":"OK","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"62aeea17-c310-4e68-a806-e792105bd079","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"966c215c-14c3-4000-b5ca-4b8e60350372","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"6dd8d179-e252-40df-901b-e3e12f9eca34","name":"An exception has occured","originalRequest":{"method":"GET","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"f645e26b-b869-43b5-bf77-592657cc3d17"},{"name":"Updates an absence period by id","id":"6f2ad0d1-68fb-4bff-82ba-17b029b31316","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"User\": \"\",\n \"StartDate\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"formFiller\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\",\n \"BeLawyer\": \"\"\n }\n },\n {\n \"ActionTypes\": [\n \"receiver\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"BeId\": \"\"\n }\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Update an absence period by ID

\n

Update the information in an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

PUT

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

Request parameters

\n

For the list of request parameters, refer to API v4: Create an absence period.

\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period. \n 

\n

Response codes

\n

For response codes, refer to API v4: Create an absence period.

\n

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"5283921c-bf18-45d5-b705-c4d2e4e80c44","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"65ebc5c5-803c-4f87-9488-f60b0f0a3df0","name":"OK","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Id\": \"\",\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"voluptate_1f_\": {},\n \"dolor52e\": {}\n }\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"receiver\"\n ],\n \"EmailAddress\": \"\",\n \"Id\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"est8\": {},\n \"elitb9\": {}\n }\n }\n ]\n}"},{"id":"f890bbb5-d3c4-4288-9a4a-e8f78cf22213","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"[\n {\n \"Code\": \"\",\n \"Message\": \"\"\n },\n {\n \"Code\": \"\",\n \"Message\": \"\"\n }\n]"},{"id":"83978a4b-07d8-44a2-8563-9e0871ec7bfe","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"2bbe7d98-e332-48ab-8676-98cff8fb5dd1","name":"Untitled Response","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"4d4cc30a-520f-4470-b81d-26ca8dad5b5d","name":"An exception has occured","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"},{"id":"5bb889bd-d0ba-40ba-8571-79eeb8970c32","name":"The request conflicts with existing information and/or business rules","originalRequest":{"method":"PUT","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"StartDate\": \"\",\n \"User\": \"\",\n \"EndDate\": \"\",\n \"Substitutes\": [\n {\n \"ActionTypes\": [\n \"signer\",\n \"approver\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"dolore_2c9\": {},\n \"est_00\": {}\n },\n \"Id\": \"\"\n },\n {\n \"ActionTypes\": [\n \"signer\",\n \"signer\"\n ],\n \"EmailAddress\": \"\",\n \"Language\": \"\",\n \"LastName\": \"\",\n \"Type\": \"person\",\n \"AllowedToReassign\": \"\",\n \"Title\": \"\",\n \"FirstName\": \"\",\n \"PhoneNumber\": \"\",\n \"BirthDate\": \"\",\n \"ExternalReference\": \"\",\n \"AdditionalProperties\": {\n \"culpa015\": {},\n \"irurea\": {}\n },\n \"Id\": \"\"\n }\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Conflict","code":409,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"6f2ad0d1-68fb-4bff-82ba-17b029b31316"},{"name":"Deletes an absence period by id","id":"93d0c19b-929a-4fa4-8185-b76beb4f62eb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"DELETE","header":[{"key":"Accept","value":"application/json"}],"url":"/absenceperiods/:absencePeriodId","description":"

API v4: Delete an absence period by ID

\n

Delete an absence period by its ID.

\n

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/absenceperiods/{absencePeriodId} \n 

\n

Method

\n

DELETE

\n

Request parameters

\n

Parameters marked with red asterisks (*) are required. \n 

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterDescriptionType
absencePeriodId*The unique number of an absence period.Guid (string)
\n

\n

Response parameters 

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n
CodeDescription
204The absence period was deleted.
\n

For other response codes, refer to API v4: Create an absence period.

\n

Error codes

\n

For the list of response parameters, refer to API v4: Create an absence period.

\n","urlObject":{"path":["absenceperiods",":absencePeriodId"],"host":[""],"query":[],"variable":[{"id":"bf141146-9b03-4661-add7-b8356b321b25","type":"any","value":"","key":"absencePeriodId"}]}},"response":[{"id":"2dd1b3cb-27a0-47a5-8ff2-6b7c47ab1f3b","name":"Absence period was deleted","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"No Content","code":204,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"016b67e9-328b-463e-af92-698e19ad831b","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"fffc964d-4403-4fe0-91ee-67505b91f15e","name":"Untitled Response","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Forbidden","code":403,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"ca83cc0c-7d99-4f0f-884c-c50495fe9f24","name":"An exception has occured","originalRequest":{"method":"DELETE","header":[],"url":{"raw":"/absenceperiods/:absencePeriodId","host":[""],"path":["absenceperiods",":absencePeriodId"],"variable":[{"key":"absencePeriodId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Code\": \"\",\n \"Message\": \"\"\n}"}],"_postman_id":"93d0c19b-929a-4fa4-8185-b76beb4f62eb"}],"id":"3c6ead89-3cea-4b09-8d0c-a95a1c5f7a49","description":"

API v4: Managing absence periods

\n

Access Level: Machine-to-machine only (administrative access required)

\n

You can set absence periods for users and name their substitutes. In their absence, packages assigned to a user will be forwarded to these substitutes who will act as a form filler, approvers, signers and receivers.

\n

By using API calls, you can:

\n\n","_postman_id":"3c6ead89-3cea-4b09-8d0c-a95a1c5f7a49"},{"name":"BulkActions","item":[{"name":"Create a bulk signing session for given user","id":"63f6e797-2fcb-4872-9a7c-b41afa1d35c7","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\r\n \"EmailAddress\": \"\",\r\n \"Language\": \"\",\r\n \"Packages\": [\r\n \"\",\r\n \"\"\r\n ]\r\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk","description":"

API v4: Bulk sign packages

\n

Description

\n

This call allows you to sign multiple pending packages. When providing only the EmailAddress parameter, all available actors will be chosen for bulk signing.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/sign/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
EmailAddress*The email address of the actor for whom you want to start a bulk signing session.String (email)
LanguageThe language of the current signing session.String (language code)
Packages

Collection of PackageIds; i.e., unique identifiers of the packages that must be signed.

Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.

Array of strings (GUID)
ActorsCollection of ActorIds; i.e., unique identifiers of the actors who must sign.
 Important: You cannot use the Packages and Actors parameters at the same time. You must use the Actors parameter or the Packages parameter in your call.		Array of strings (GUID)
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
ActionUrlThe link to a bulk signing session.String (URL)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKAn ActionUrl is provided in the response body, this url will open the bulk signing session.
400 Bad RequestThe bulk sign session could not be created due to invalid data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400Request.RequiredFieldIsMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","sign","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"82d27a40-2ae2-4605-88ae-fb18d2f782ca","name":"OK.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"ActionUrl\": \"\"\n}"},{"id":"9446f357-933b-48a7-a662-f3319cdf3b1b","name":"When the Content has an invalid value.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"dfde3a96-b246-4a9a-919d-a859045ead48","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"null","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/sign/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"63f6e797-2fcb-4872-9a7c-b41afa1d35c7"},{"name":"Updates the status of multiple packages in bulk","id":"039cb554-7702-49ee-9a5b-660fbc936cbb","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\",\n \"SuppressNotifications\": false\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk","description":"

Bulk update status of packages

\n

Description

\n

This call allows you to update the status of multiple packages simultaneously.

\n

The possible combinations are:

\n
    \n

  • Draft to pending

    \n
    • \n

  • Pending to revoked

    \n
    • \n
\n

Draft to pending

\n

When packages are ready to be sent to the stakeholders to take action, change the status to 'pending'. This will make the packages visible to each of the stakeholders in their Signer Portal.

\n

Pending to revoked

\n

Packages that have been sent to stakeholders, but haven't been processed yet, or packages that have failed can be revoked. You can do so by updating their status to 'revoked'. The stakeholders will no longer be able to take action on their package.

\n

Important: For the bulk update to succeed for all packages, make sure that all packages you update are in the same original status. Updating both 'draft' and 'pending' packages to 'revoked' for instance will only succeed for the pending packages. The draft packages can only be updated to pending and will therefore fail when trying to update them to revoked.

\n

New: it is now possible to SuppressNotifications when revoking packages in bulk.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/status/bulk

\n

HTTP Method

\n

POST

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose status you want to update.String (GUID)
Status*Status to which the packages must be updated. The possible values are: pending and revoked.String (enum)
SuppressNotificationsWhen true, no notifications will be sent for the status change. Only applies when Status is 'Revoked'.
Default value: false		Boolean
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad requestThe packages could not be updated due to missing data or unsupported values in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400Request.RequiredFieldIsMissing: status
400Request.UnsupportedValue
401Authentication failed, username or password incorrect.
\n
","urlObject":{"path":["packages","status","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"7d6e189e-e277-44a9-8f5a-2b0d196cd18e","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"6b31c6f2-7510-4241-bbbc-399489616292","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Status\": \"Pending\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/status/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"039cb554-7702-49ee-9a5b-660fbc936cbb"},{"name":"Removes multiple Packages in bulk.","id":"7768b964-5df5-41cc-93ed-46d51c2d1590","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk","description":"

Bulk delete packages

\n

Description

\n

This call allows you to delete multiple packages simultaneously from the database.

\n

eSignatures does not automatically delete packages from the database once they have reached a final state. They are stored indefinitely.

\n

To delete packages from the database, you can use this Bulk delete packages call or the Delete package by ID call.

\n

Note: you can only delete packages that have status draft or one of the final states: finished, archived, rejected or revoked. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be deleted.String (GUID)
DelayedDeletionTimeTime expressed in number of days after which the audit proofs of the packages will be deleted, once the packages have been deleted. When this parameter is not passed, the value set under Delayed Deletion Time in the Configuration Index will be applied. Tip: to keep audit proofs indefinitely until a manual Delete audit proofs call is done, enter '0' as value.Integer
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
400AuditProof.DelayedDeletionTimeNegative
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"b127c01f-2f34-4303-8219-ba2f02c55ead","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"295d02e1-ff2b-4dbc-a7ba-e747b0178f32","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"DelayedDeletionTime\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"7768b964-5df5-41cc-93ed-46d51c2d1590"},{"name":"Allows to download multiple Packages in bulk.","id":"52ac5340-5f94-467e-9b33-99291a7915ed","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk","description":"

Bulk download packages

\n

Description

\n

This call allows you to download multiple finished packages. Note that bulk downloading packages works in two steps:

\n
    \n
  1. The Bulk download packages call downloads the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe packages could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"5ebb000f-b8ef-4856-bd17-6369839fb4b8","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"34d973ac-8a74-4e34-a8d0-eb5be4c73e3f","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"52ac5340-5f94-467e-9b33-99291a7915ed"},{"name":"Allows to send reminders to the Actors of multiple Packages in bulk.","id":"5f660e5b-7c74-41f9-9cf7-5429dae85275","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk","description":"

Bulk send reminders

\n

Description

\n

The Bulk send reminders call sends a reminder to the actors of the specified packages.

\n

Company policy might require that a document is handled within a given timespan. Doing a Bulk send reminders call looks up all actors within the specified packages who haven't approved/signed/filled out their document and sends them an extra notification as a reminder.

\n

Note that only the next available actor(s) in the workflow are notified. This means approvers/signers/form fillers waiting for someone else to take action first in a serial workflow will not receive a notification. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/reminders/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe reminder could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","reminders","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"825e67a0-4100-49d6-8286-0d3725f2b726","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"800b3f8a-0dc7-4ed2-935e-aa2dea3abedb","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/reminders/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"5f660e5b-7c74-41f9-9cf7-5429dae85275"},{"name":"Allows to extend expiry date of Packages in bulk.","id":"02d07cbb-ecda-495b-ad5a-7c33328748ab","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk","description":"

Bulk extend the expiry date of packages

\n

Description

\n

This call allows you to extend the expiry date of multiple packages simultaneously. This way, you can make documents that were expired available again. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/expirydate/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose expiry date must be extended.String (GUID)
ExpirationTimeStampDate and time when these packages expire and are no longer accessible. Documents within the packages expire on the same date.

Format is ISO 8601 date-time.		String (date-time)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe expiration date could not be extended due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","expirydate","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"c24ceb11-82b0-453e-b672-345ccb2dd879","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"c8774517-cb3d-42e0-a1b9-789a570a03a9","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"ExpirationTimestamp\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/expirydate/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"02d07cbb-ecda-495b-ad5a-7c33328748ab"},{"name":"Allows to skip a number of Actors of multiple Packages in bulk.","id":"c7e613ce-cc36-4f5d-ac3c-50df0e9b847f","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk","description":"

Bulk skip actors of multiple packages

\n

Description

\n

This bulk action call allows you to skip the actors of the specified packages who haven't taken action on their package yet.

\n

With this call you can either skip approvers and form fillers, by sending the packages ToSigners. This way the packages become available for signing, and the approvers/form fillers can no longer take action. Or you can skip any signers who haven't signed yet, by sending the packages ToFinished. This way you can end the signing flow of multiple packages simultaneously. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/skip/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages for which a reminder must be sent.String (GUID)
Target

Target to which the packages must be sent.
Supported values:

- ToSigners
- ToFinished

String (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe packages could not be sent due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","skip","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"06788c77-cbb3-4637-a5b7-888bdb8ca0cb","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"04bd3bf4-d456-4b2c-adcf-8da59c3d7a02","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Target\": \"ToFinished\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/skip/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"c7e613ce-cc36-4f5d-ac3c-50df0e9b847f"},{"name":"Removes audit proofs of deleted packages in bulk.","id":"cb20842b-d563-4d3f-9e6f-b01867eaf5e8","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk","description":"

Bulk delete audit proofs of deleted packages

\n

Description

\n

This call allows you to manually delete the audit proof info of multiple deleted packages simultaneously. As of eSignatures 6.4 it is no longer required to delete audit proofs one by one.

\n

Note that Audit proofs are not automatically deleted as soon as the corresponding packages are deleted in the Document Portal or via the API.

\n

The time (in days) after which they are deleted can be configured on environment level in the Configuration Index, or specified per package(s) through the DelayedDeletionDate parameter in the Delete Package by ID call or Bulk delete packages call.

\n

If you want to delete audit proofs earlier than specified, you can do a manual Delete audit proof info call or this Bulk delete audit proofs call and specify of which package(s) the audit proof info must be deleted. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/auditproof/delete/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages whose audit proofs must be deleted.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get all status info call to retrieve all info about this specified bulk action session, and check whether it succeeded.
400 Bad RequestThe audit proofs could not be deleted due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect.
\n
","urlObject":{"path":["packages","auditproof","delete","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"83f014c2-c348-4591-acc5-5bad4a1cf44d","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"d6eb0c81-4e6f-4eb8-adb9-9896d9da78c4","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ]\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/auditproof/delete/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"cb20842b-d563-4d3f-9e6f-b01867eaf5e8"},{"name":"Allows to download audit trails of multiple packages in bulk.","id":"2ab900fa-51f1-4c51-8882-19595d328f44","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk","description":"

Bulk download Audit Trail PDFs

\n

Description

\n

This call allows you to download the audit trail PDFs of multiple packages.

\n

Note that the packages must be in finished, archived, rejected or revoked status to download their audit trail PDF.

\n

Note that bulk downloading audit trail PDFs works in two steps:

\n
    \n
  1. The Bulk download audit trails PDF call downloads the audit trails of the specified packages and returns a unique BulkActionSessionId.
    2. \n
  2. The BulkActionSessionId is used in a Get bulk action result call to retrieve the actual contents (as .zip file).
    3. \n
\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/audittrails/download/bulk \n 

\n

HTTP Method

\n

POST \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIds*Collection of PackageIds; i.e., unique identifiers of the packages that must be downloaded.String (GUID)
CultureISO 639-1 language code of the language.String
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKA unique identifier of the created bulk action session is returned as response. This can be used in a Get bulk action info call to retrieve all info about this specified bulk action session, and check whether it succeeded, or in a Get bulk action result call to retrieve the actual contents.
400 Bad RequestThe Audit Trails could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","audittrails","download","bulk"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"54ae0a76-445a-4426-8ef8-4ddedffeff93","name":"An unique identifier of the created bulk action session.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"value\": \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"6b3296a4-805a-4460-8c18-bbae8ec96198","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"PackageIds\": [\n \"\",\n \"\"\n ],\n \"Culture\": \"\"\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/packages/audittrails/download/bulk"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"2ab900fa-51f1-4c51-8882-19595d328f44"},{"name":"Get all status information of a bulk package action session.","id":"4c71f449-bbd9-4bd7-bf1b-c35892692daa","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/packages/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per package about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of packages that were processed in the bulk action.integer
SucceededThe number of packages that succeeded in the bulk action.integer
FailedThe number of packages that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info per package.Object
\n

BulkActionDetail (per package)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
PackageIdUnique identifier of the package.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the package.string
ErrorMessageError message displayed when processing the package.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"id":"c76006fd-313b-4ea6-955d-16aa6b00cf0d","type":"any","value":"","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":""}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"RequestAuditTrails\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"PackageId\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"fc51fd41-d9b1-4ec8-ad9a-0f82ffb26a10","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"148db6fe-c86d-4b3e-9960-d44c9b38197a","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["packages","bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain all the info available about the requested bulk action session."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"4c71f449-bbd9-4bd7-bf1b-c35892692daa"},{"name":"Get all status information of a bulk action session.","id":"f2e6fca9-0060-4449-93de-faa3cc6c630c","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/json"}],"url":"/bulkactionsession/:bulkActionSessionId?includeDetails=","description":"

Get bulk action info of a specified bulk action session

\n

Description

\n

When doing a bulk action through the API, it takes some time for eSignatures to process each action in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified items. Instead, a unique identifier of the executed bulk action session is returned.

\n

This unique ID can be used in the Get Bulk Action Info call to check whether the specified bulk action session is finished and what the results are.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/bulkactionsession/{bulkActionSessionid}

\n

HTTP Method

\n

GET

\n

Template parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IncludeDetailsThis parameter determines whether the results contain detailed information per item about the bulk action session.Boolean
\n

Response parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
SessionIdA unique Id that identifies the bulk action session.string (GUID)
ActionThe type of bulk action that was executed.string
StatusThe status of the bulk action that was executed. Possible values: Finished or Pending.string
TotalThe total number of items that were processed in the bulk action.integer
SucceededThe number of requests that succeeded in the bulk action.integer
FailedThe number of requests that failed in the bulk action.integer
FinishedTimeThe date and time when the bulk action was finished. A value is only returned if the Status is Finished. If the status is still Pending, the FinishedTime value is null.string (date/time)
DetailsIncludes the bulk session info.Object
\n

BulkActionDetail (per item)

\n

These parameters are returned when IncludeDetail is set to true.

\n

Succeeded

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
\n

Failed

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
IdUnique identifier of the item.string (GUID)
ExecutedTimeThe date and time when the bulk action was executed.string (date/time)
ErrorCodeError code returned when processing the item.string
ErrorMessageError message displayed when processing the item.string
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe status information of the target bulk action session is successfully retrieved.
401 UnauthorizedCaller is unauthorized to perform this operation.
404An exception has occurred.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.NotFound
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["bulkactionsession",":bulkActionSessionId"],"host":[""],"query":[{"description":{"content":"

The result will contain all the info available about the requested bulk action session.

\n","type":"text/plain"},"key":"includeDetails","value":""}],"variable":[{"id":"b5be6aef-5fbc-4d66-a5b0-c82840a599f9","type":"any","value":"","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"OK","code":200,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Action\": \"UserEmailInvitationNotification\",\n \"Status\": \"Pending\",\n \"Total\": \"\",\n \"Succeeded\": \"\",\n \"Failed\": \"\",\n \"FinishedTime\": \"\",\n \"Details\": {\n \"Succeeded\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\"\n }\n ],\n \"Failed\": [\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n },\n {\n \"Id\": \"\",\n \"ExecutedTime\": \"\",\n \"ErrorCode\": \"\",\n \"ErrorMessage\": \"\"\n }\n ]\n }\n}"},{"id":"331362e4-e4fd-4357-905a-bdce9f52efa4","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"e551da77-c5b5-491d-9771-f87b33644750","name":"An exception is occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/bulkactionsession/:bulkActionSessionId?includeDetails=","host":[""],"path":["bulkactionsession",":bulkActionSessionId"],"query":[{"key":"includeDetails","value":"","description":"The result will contain the action details information."}],"variable":[{"key":"bulkActionSessionId","value":""}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"f2e6fca9-0060-4449-93de-faa3cc6c630c"},{"name":"Allows to download the result of a Bulk Action that creates a Zip archive.","id":"67481f0a-513c-4000-bfc2-4fdb7b5109b2","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"GET","header":[{"key":"Accept","value":"application/zip"}],"url":"/packages/bulkactionsession/download/:bulkActionSessionId","description":"

Get bulk action result call

\n

Description

\n

This call allows you to retrieve the result of a Bulk download packages or Bulk download audit trails PDF call once those calls have been finished.

\n

The result is always downloaded as a .zip file. The .zip file contains a subfolder for each package. Each subfolder may contain the documents in .pdf or .xml, or the audit trails in .pdf format. The .zip file also contains a .json file with information about each package. \n 

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/​/packages​/bulkactionsession​/download​/{bulkActionSessionId} \n 

\n

HTTP Method

\n

GET \n 

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
BulkActionSessionId*The unique identifier of the target bulk action session.String (GUID)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
200 OKThe results of the requested bulk action are successfully downloaded as .zip file.
400 Bad RequestThe results could not be downloaded due to missing data in the request.
401 UnauthorizedCaller is unauthorized to perform this operation.
\n

Error codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
HTTP CodeCode
400BulkActionSession.DataMissing
401Authentication failed, username or password incorrect
\n
","urlObject":{"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"host":[""],"query":[],"variable":[{"id":"02a4d69d-c6c5-40be-b156-877f5d0cffc2","type":"any","value":""},{"id":"f19c54ce-8c0e-432b-b61e-82cff17a688c","name":"Untitled Response","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""},{"id":"7dfb6c04-6fc7-4d24-bed1-5258583918e9","name":"An exception has occured.","originalRequest":{"method":"GET","header":[],"url":{"raw":"/packages/bulkactionsession/download/:bulkActionSessionId","host":[""],"path":["packages","bulkactionsession","download",":bulkActionSessionId"],"variable":[{"key":"bulkActionSessionId"}]}},"status":"Not Found","code":404,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"}],"_postman_id":"67481f0a-513c-4000-bfc2-4fdb7b5109b2"}],"id":"09bf6506-e278-4580-863c-d5aec1358091","description":"

API v4: Bulk actions

\n

You can perform actions on multiple packages at once.

\n

The following API calls for bulk actions are available:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
CallAdded in version
Bulk sign packages7.4.0
Update the status of packages6.4.x
Bulk delete packages6.4.x
Bulk download packages6.4.x
Bulk send reminders6.4.x
Bulk extend the expiry date of packages6.4.x
Bulk skip actors6.4.x
Bulk delete the audit proofs info of deleted packages6.4.x
Bulk download audit trail PDFs of packages6.4.x
Get bulk action info about a specified bulk action session6.4.x
Get bulk action result call (to download the .zip files created by a Bulk download packages or Bulk download audit trails call)6.4.x
\n

Bulk action calls differ from regular API calls. When doing a bulk action through the API, it takes some time for eSignatures to process each PackageId in the background. Consequently, you don't immediately see whether the bulk action succeeded for all specified packages. Instead, a unique identifier of the executed bulk action session (BulkActionSessionId) is returned.

\n

This unique ID (BulkActionSessionId) can be used in:

\n
    \n

  • A Get bulk action info call to check whether the specified bulk action session is finished and what the results are.

    \n
    • \n

  • A Get bulk action result call to download the contents (as .zip file) of a Bulk download packages or Bulk download audit trails PDF call.

    \n
    • \n
\n","_postman_id":"09bf6506-e278-4580-863c-d5aec1358091"},{"name":"Users","item":[{"name":"Sends an user email invitation for given email addresses","id":"d096a63b-795f-4d76-af73-faa0708dd588","protocolProfileBehavior":{"disableBodyPruning":true},"request":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"},{"key":"Accept","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\",\n \"InvitationLanguage\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite","description":"

Invite users

\n

Description

\n

This call allows API users to invite other users to the eSignature environment and add them to the correct user groups.

\n

This call can be used to invite multiple users at the same time and create a shared contact from that user if needed.

\n

URL

\n

https://[servername]:[port]/esig/webportalapi/v4/users/invite

\n

HTTP Method

\n

POST

\n

MIME Type

\n

application/json

\n

Request parameters

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
EmailsMandatoryEmail addresses of all the users you want to invite.Array of Strings
UserGroupsOptionalThe user groups you want to assign the invited users toArray of Strings
CreationOptionsOptionalOptional options for the invited users.Object
\n

CreationOptions

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterOccurrenceContent / DescriptionType
IsSharedContactOptionalOption to create a shared contact for the userBoolean
InvitationLanguage (as of 7.5.0)OptionalLanguage that will be used for the invitation. Currently supported: en, nl, de, fr, es, da, nb, sv, fi, lv, pl, hu, it, pt, roString (enum)
\n

Response codes

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
Response status codeDescription
202 Request is acceptedThe users have been invited.
400 Bad RequestThe request contained parameters which could not be accepted.
\n
","urlObject":{"path":["users","invite"],"host":[""],"query":[],"variable":[]}},"response":[{"id":"6c6fdbce-0955-4247-ba4c-25739d3b6fdb","name":"Request is accepted.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Accepted","code":202,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"SessionId\": \"\",\n \"Link\": \"\"\n}"},{"id":"1aedcfbd-c0a2-48e0-b002-51a2e72e6521","name":"Request failed validation.","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Bad Request","code":400,"_postman_previewlanguage":"json","header":[{"key":"Content-Type","value":"application/json"}],"cookie":[],"responseTime":null,"body":"{\n \"Errors\": [\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n },\n {\n \"ErrorCode\": \"\",\n \"Message\": \"\"\n }\n ]\n}"},{"id":"4cab2de1-33dd-429b-8ace-aa388403dfac","name":"Untitled Response","originalRequest":{"method":"POST","header":[{"key":"Content-Type","value":"application/json"}],"body":{"mode":"raw","raw":"{\n \"Emails\": [\n \"\",\n \"\"\n ],\n \"UserGroups\": [\n \"\",\n \"\"\n ],\n \"CreationOptions\": {\n \"IsSharedContact\": \"\"\n }\n}","options":{"raw":{"headerFamily":"json","language":"json"}}},"url":"/users/invite"},"status":"Unauthorized","code":401,"_postman_previewlanguage":"text","header":[],"cookie":[],"responseTime":null,"body":""}],"_postman_id":"d096a63b-795f-4d76-af73-faa0708dd588"}],"id":"9213d699-3c5b-4128-99da-fdf8e1f86505","_postman_id":"9213d699-3c5b-4128-99da-fdf8e1f86505","description":""}],"id":"bfb18886-d479-4232-a92a-050737f33d5a","description":"

Last updated 09/2025

\n

Introduction

\n

This document describes the technical specifications of the Nitro Sign Enterprise Verified API v4.

\n

The Nitro Sign Enterprise Verified API is a REST API. It is a web service that allows external systems to make requests for Nitro Sign Enterprise Verified sources through URL paths. More concretely, it allows external systems to interact with the Nitro Sign Premium platform and use its features to create and manage signing flows.

\n

Disclaimers

\n

Only the described use cases are supported. All other use cases, even though possibly technically feasible with the API, are explicitly not supported and should not be implemented as such.

\n

In case of discrepancies between examples and the description of the parameters section, the description of the parameters section prevails.

\n

The descriptions of error codes in this document or the actual error message fields returned by the API are subject to change. External applications should rely on the returned error code values, anything else is only for diagnostic purposes.

\n

All documents uploaded to the API must comply with the standards corresponding of that format. Conversions are based on a best-effort approach. The behavior of uploading non-compliant documents and / or conversions in an environment where required fonts, color profiles etc. are missing is undefined.

\n

The URLs of the REST API in this document were changed to v4 in Nitro Sign Enterprise Verified version 6.0. The support period for the API with v3 URLs outlined in the Nitro Sign Enterprise Verified version 5.x API Technical Documentation is governed by the Nitro Sign Premium support Contract.

\n

The API calls with v2 URLs are no longer supported since version 6.0.

\n

Be aware that the agile nature of JSON for the REST services supports adding optional parameters to the request or new parameters to the responses. The only actions that are considered breaking changes of the API are adding required parameters, changing existing parameters in the requests, or parameters missing from responses.

\n

Important: Always use conforming JSON data in the requests. When the Web Application Firewall in front of Nitro Sign Enterprise Verified is enabled, the firewall validates all JSON passing through it and does not accept invalid JSON (e.g. which contains embedded comments such as // or /* */ and extra commas).

\n

Optional fields that are not used must be left out of the request message. An empty string or dummy value for optional fields is also a value, and hence may trigger an error in the current version or a future version.

\n

There is no dedicated error code for packages which exceed a given file size other than HTTP code 404.13 returned by IIS. However, as a practical guideline a document must not exceed 30 MB. Packages must not be larger than 150 MB in total and should not contain more than 15 documents. Note that large files might affect signing performance, depending on the user's Internet connections.

\n

REST service

\n

The services are plain REST based services, maintaining no state whatsoever. All data exchanges, in and out, are handled in JSON data format and using UTF-8 encoding.

\n

The default URL is:

\n

https://[servername]:[port]/esig/webportalapi/v4/

\n

Important note about MTLS:

\n

When the setting IsMtlsEnabled is enabled in the Configuration Index, API users must make sure that an HTTP/1.1 connection is established and that the following header is sent in all Nitro Sign Premium API calls:

\n

Plain Text

\n
Expect: 100-continue\n\n

The client should then wait for the HTTP 100 Continue response before sending the actual payload.

\n

Failing to do so will cause problems with large payloads (e.g. when uploading PDF documents). In such a case the payload will fill the server’s receiving buffer before proper mutual authentication is finished, the connection will never be established and the request will time out as a result.

\n

If for some reason such HTTP/1.1 connection is not feasible, API users can also try to send a HEAD request using their HTTP client object before doing the actual file upload request with the same client. This workaround is not recommended however, since the client may decide to reset the connection in between the two different calls.

\n

HTTP statuses

\n

Below you find an overview of the HTTP statuses that are returned, and their meaning.

\n

Successful responses

\n

200 OK
The response body contains a representation of the requested / created resource.

\n

201 Created
The request led to the creation of a resource. The created resource is in the body of the response and its location is found in the Location header.

\n

204 No Content
The request was successful and there is no additional content to send in the response body.

\n

Client Error responses

\n

400 Bad Request
The server cannot or will not process the request due to something that is perceived to be a client error (e.g. failed validation).

\n

401 Unauthorized
The request has not been applied because it lacks valid authentication credentials for the target resource.

\n

404 Not Found
The origin server did not find a current representation of the target resource.

\n

409 Conflict
The request could not be completed due to a conflict with the current state of the target resource. This code is used in situations where the user might be able to resolve the conflict and resubmit the request.

\n

Server error responses

\n

500 Internal Server Error
The server encountered an unexpected condition that prevented it from fulfilling the request.

\n

Concepts Overview

\n

This section explains the different concepts that are used in the Nitro Sign Enterprise Verified API.

\n

Package
Packages lie at the core of Nitro Sign Enterprise Verified . A package is a container for digital documents that are sent for signing.

\n

A package may contain one or more documents that need to be signed. A package may also have multiple stakeholders who will take actions on the package's documents.

\n

Document
A document is a digital file that is sent for signing. A document is always part of a package and is signed by a stakeholder.

\n

A document may contain multiple elements. This element could be a signing field or a form field (e.g. textbox field, checkbox field and radio buttons) and as of 7.0.0 it can also be a UnplacedElement (e.g. not attached to a document yet)

\n

Element
An element is an item that is placed on a document and may be assigned to an actor. For instance, a signing field that can be assigned to a signer actor or a form field that can be assigned to a form filler actor.

\n

Stakeholder
A stakeholder is an entity that has an interest in a package. A single stakeholder may contain multiple actors, i.e. actions the stakeholders must do. For instance, form fill, approve, sign or receive.

\n

A stakeholder may be a single person, or a group of people. When a group of people is defined, any member of the group will be able to form fill, approve or sign on behalf of the entire group.

\n

Actor
An actor is a single action that a stakeholder must do on a package.

\n

The different actor types are: form filler, approver, signer and receiver.

\n

Process and process steps
A package's process defines which stakeholder will do their action at which moment in time. A process may consist of multiple process steps. This way, you can set up parallel, sequential or complex flows in which actors can form fill and approve or sign. All actors that are put in the same process step will be completed in parallel.

\n

Tip: Consult the Glossary section for an overview of more Nitro Sign Enterprise Verified related terms.

\n

API Variants

\n

This specification is available in two variants:

\n
    \n

  • Full API: Complete API with all endpoints (BasicAuth + OAuth2 M2M)

    \n
    • \n

  • User API: Limited API excluding admin endpoints (OAuth2 user-based only)

    \n
    • \n
\n

Administrative endpoints (/poisonqueue, /absenceperiods, /auditproofs) are
restricted to machine-to-machine authentication only.

\n

Authentication and Security

\n

Authentication

\n

Basic authentication

\n

The Nitro Sign Enterprise Verified API supports ‘Basic Authentication’ via a username and password combination that must be placed in the header of every request.

\n

The default credentials, which must be changed through configuration at installation time should have been communicated to you by email or sms.

\n

Note: depending on the Configuration Index settings, the use of an Mtls Client certificate might be required.

\n

OAuth 2.0

\n

Authentication can be done using a JWT access token.

\n

Client Credentials Flow (Machine-to-Machine)

\n
    \n

  • Full API access including administrative endpoints

    \n
    • \n

  • Ideal for server-to-server integrations

    \n
    • \n
\n

Authorization Code Flow (User-based)

\n
    \n

  • Limited API access excluding administrative endpoints

    \n
    • \n

  • Ideal for user-facing applications

    \n
    • \n

  • Supports delegated user access scenarios

    \n
    • \n
\n

The access token can be retrieved by calling the token endpoint of the authentication server. The Url of the token endpoint can be retrieved from the discovery endpoint available at /.well-known/openid-configuration.

\n

The access token should be cached and reused for its lifetime. A new access token should be retrieved using the refresh token when it is expired.

\n

Example of getting a token with curl in a client credentials flow:

\n
curl -A \"ClientApplication/1.0\" -d \"grant_type=client_credentials&client_id=${client_id}&client_secret=${client_secret}&scope=${scope}\" \"${token_endpoint}\"\n\n

client_id is the value of the client id (also called application id) provided by Nitro client_secret is the \"password\" for the client id, provided by Nitro

\n

scope must contain \"gonitro.signerapp\"

\n

token_endpoint is the token endpoint on the authentication server

\n

The response is a json document of the form:

\n
{\n  \"access_token\": \"eyJhb.........A\",\n  \"expires_in\": 300,\n  \"refresh_expires_in\": 1800,\n  \"refresh_token\": \"eyJhb...........A\",\n  \"token_type\": \"bearer\",\n  \"not-before-policy\": 1591634674,\n  \"session_state\": \"0f65368c-90df-4e2f-b039-5320a0b34871\",\n  \"scope\": \"email gonitro.signerapp profile\"\n}\n\n
\n

When calling the API, the access token must be placed in an Authorization HTTP Header of type “Bearer”. See https://tools.ietf.org/html/rfc6750

\n

NB: a valid User Agent string is required for calls. The default user agent for curl or wget can be blocked by the Web Application Firewall protecting the application.

\n

Security through short-time / one-time URLs

\n

By default, the URL lifetime is limited to one day. The default duration can be specified in days in the Config Index and can be overridden with the parameter ActionUrlExpirationPeriodInDays in the API call.

\n

In a previous default, the URL lifetime was limited to one-time use. This configuration can still be enabled for some environments.

\n

It is recommended to request the stakeholder's actor links just before redirecting them. This way, you make sure they receive the latest generated link.

\n

When end users open an action URL they already used or that is expired, they will either be redirected to the redirect URL (if specified),or the Notification callback URL will be called (if specified), or see a warning and an action button to receive a new URL by email. If a redirect or a Notification callback URL is specified in the API, the client application must request a new URL and provide it to the user. You can get the new action URL by retrieving the Actor information via any of the API status calls.

\n

When end users try to take action on a document that has been deleted, a 404 Not found error will occur. This cannot be recovered from, since all information has been purged from the application.

\n

Error Handling Responses

\n

Nitro Sign Enterprise Verified API v4 uses HTTP error codes to give an idea of whether a call succeeded or failed, and a system of error codes in the response body to give more information in case things went wrong.

\n

The used error codes for each call are listed in that call’s section. The meaning of each error code is further explained in Error Code Descriptions.

\n

The error responses are JSON containing the following list of objects:

\n
\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n\n
ParameterContent / DescriptionType
Errors (array of objects)List of the errorsArray
ErrorCodeError code with variable informationString
MessageError message detail text, not localizedString
\n

A Nitro Sign Premium error code is always displayed as follows:

\n

Resource.Error:parameter

\n

E.g. Package.NotFound:00000000-0000-0000-0000-000000000000. The GUID behind the colon is the packageId that wasn't found.

\n

Error codes can be reused: if the HTTP response code is HTTP 400 Bad Request, an error code like “Document.InvalidTargetFormat” indicates a value that is not supported by Nitro Sign Premium. If the HTTP response code is HTTP 409 Conflict, an error code like “Document.InvalidTargetFormat” means that the request value can currently not be used because the configuration forbids it.

\n

Note: any HTTP 500 Server Error or other 50x responses might deviate from the format described in this section as they are not part of the API.

\n

Full error code descriptions

\n

https://connectivegroup.my.site.com/s/article/API-v4-Error-code-descriptions

\n","event":[{"listen":"prerequest","script":{"id":"b217872b-1dba-40a8-88bb-a3c91cf69c20","type":"text/javascript","packages":{},"requests":{},"exec":[""]}},{"listen":"test","script":{"id":"ea3a9da3-dc0e-4768-b392-78cd84504af2","type":"text/javascript","packages":{},"requests":{},"exec":[""]}}],"_postman_id":"bfb18886-d479-4232-a92a-050737f33d5a"}],"event":[{"listen":"prerequest","script":{"id":"7537f623-13fa-42b8-8b0d-79a60b2b671f","type":"text/javascript","packages":{},"exec":[""]}},{"listen":"test","script":{"id":"9fc73bf5-20c0-4663-89fe-0af0e74a0bc0","type":"text/javascript","packages":{},"exec":[""]}}],"variable":[{"key":"baseUrl","value":"","type":"default"}]}