Skip to main content
PUT
Error

Authorizations

​
Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

​
packageId
string<guid>
required

The target package's unique identifier A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Body

application/json

Signs one or more signing fields

​
Type
enum<string>
required

The type of action an actor performs on a package, and the discriminator across the actor variants.

  • FormFiller - fills TextBoxField, CheckBoxField, RadioGroup and ComboBoxField (NSEV v8.5+) elements; does not sign or approve. Must be placed in the first process step.
  • Approver - approves a document as fit for signing, before any signer acts. Must be placed in the first process step (may share it with FormFillers).
  • Signer - signs one or more signing fields.
  • Receiver - receives a copy of the fully signed document; takes no action and must be placed in the last process step.
Available options:
Signer
​
StakeholderId
string<guid>
required

A stakeholder's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
SuppressNotifications
boolean
default:false

suppress the notifications for this actor

​
RedirectUrl
string<url>

Url to which the stakeholder is redirected after completing this action

​
Elements
(New signing field on a document · object | Existing element by Id · object)[]

The actor's elements

Parameters for creating a signing field

​
RedirectType
enum<string>

When stakeholder gets redirected after completing this action

  • afterSession - Redirect after signing session is ended, but before package is completed (only important for last signer).
  • immediately - Redirect as soon as possible.
  • afterDelay - Redirect after some delay (defined on frontend).
  • afterCompletion - Redirect after the package is completed.

Only valid together with RedirectUrl - the API rejects RedirectType without it.

Available options:
AfterSession,
Immediately,
AfterDelay,
AfterCompletion
​
BackButtonUrl
string<url>

URL to which the end user is sent after pressing close session button

Example:

"https://homepage.example.test"

Response

Process steps were updated