Skip to main content
GET
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"

Response

OK

Signs one or more signing fields

​
Id
string<guid>

This actor's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
Type
enum<string>

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
​
Status
enum<string>

The status of an actor's action.

  • Draft - the package is still in draft; the action is not yet active.
  • Waiting - the action is waiting for an earlier process step to complete.
  • Available - the action is ready to be performed.
  • InProgress - the action is being performed.
  • Failed - the action failed.
  • Finished - the action was completed.
  • Rejected - the actor rejected the document.
  • Skipped - the action was skipped (for example via skip approvers/signers).
Available options:
Draft,
Waiting,
Available,
InProgress,
Failed,
Finished,
Rejected,
Skipped
​
SuppressNotifications
boolean
default:false

suppress the notifications for this actor

​
ActionUrls
object[]
​
Links
string<url>[]

Only present when the actor's stakeholder is a person.

links to interact with the package for this person stakeholder

​
MemberLinks
object[]

Only present when the actor's stakeholder is a group or contact group.

​
Result
object

The result of a completed action

​
Elements
Signing field · object[]

The actor's elements

​
RedirectUrl
string<url>

Url to which the stakeholder is redirected after completing this action

​
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"

​
StakeholderId
string<guid>

A stakeholder's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Example: