Process

Create process step

Adds one process step to the package’s process. A process step is an array of actors whose actions can be performed in parallel; steps run sequentially in the order they appear in the process.

A single step may not mix actor types, except that FormFillers and Approvers may be combined in one step. The approval and form-filling flows must precede all signing flows: adding approval or form-filling data after signatures are placed would invalidate those signatures. After the approval and form-filling step, all signing flows (sequential, parallel or mixed) must complete before the final receiver step. The receiver flow is always parallel and is always last.

Each actor in the step is supplied together with the StakeholderId it belongs to.

POST

packages

{packageId}

process

Error

A valid request URL is required to generate request examples

[
  {
    "Id": "00000000-0000-0000-0000-000000000003",
    "StakeholderId": "00000000-0000-0000-0000-000000000003",
    "Type": "signer",
    "Status": "available",
    "Links": [
      "https://completeyouraction.test"
    ]
  },
  {
    "Id": "00000000-0000-0000-0000-000000000002",
    "StakeholderId": "00000000-0000-0000-0000-000000000002",
    "Type": "signer",
    "Status": "available",
    "MemberLinks": [
      {
        "Email": "john@doe.test",
        "Link": "https://alsocompleteyouraction.test"
      },
      {
        "Email": "zu@li.test",
        "Link": "https://dothething.test"
      }
    ]
  }
]

[
  {
    "ErrorCode": "Name.MinimumLength:6",
    "ErrorMessage": "The minimum length for a name is 6"
  }
]

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

[
  {
    "ErrorCode": "Something.WentWrong",
    "ErrorMessage": "Something went wrong"
  }
]

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

Signer
Approver
Form filler
Receiver

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

New signing field on a document
Existing element by Id

Show child attributes

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 step was created

Signer
Receiver
Approver
Form filler

Signs one or more signing fields

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[]

Show child attributes

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.

Show child attributes

Result

object

The result of a completed action

Show child attributes

Elements

Signing field · object[]

The actor's elements

Show child attributes

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:

[
  {
    "Id": "00000000-0000-0000-0000-000000000003",
    "StakeholderId": "00000000-0000-0000-0000-000000000003",
    "Type": "signer",
    "Status": "available",
    "Links": ["https://completeyouraction.test"]
  },
  {
    "Id": "00000000-0000-0000-0000-000000000002",
    "StakeholderId": "00000000-0000-0000-0000-000000000002",
    "Type": "signer",
    "Status": "available",
    "MemberLinks": [
      {
        "Email": "john@doe.test",
        "Link": "https://alsocompleteyouraction.test"
      },
      {
        "Email": "zu@li.test",
        "Link": "https://dothething.test"
      }
    ]
  }
]

Update processOverwrites the package's entire process with the supplied steps. The body is a 2D array: the outer array is the ordered list of steps, and each inner array is the set of actors that run in parallel within that step. The same step-ordering and actor-type rules as Create process step apply.

Error

A valid request URL is required to generate request examples

[
  {
    "Id": "00000000-0000-0000-0000-000000000003",
    "StakeholderId": "00000000-0000-0000-0000-000000000003",
    "Type": "signer",
    "Status": "available",
    "Links": [
      "https://completeyouraction.test"
    ]
  },
  {
    "Id": "00000000-0000-0000-0000-000000000002",
    "StakeholderId": "00000000-0000-0000-0000-000000000002",
    "Type": "signer",
    "Status": "available",
    "MemberLinks": [
      {
        "Email": "john@doe.test",
        "Link": "https://alsocompleteyouraction.test"
      },
      {
        "Email": "zu@li.test",
        "Link": "https://dothething.test"
      }
    ]
  }
]

[
  {
    "ErrorCode": "Name.MinimumLength:6",
    "ErrorMessage": "The minimum length for a name is 6"
  }
]

[
  {
    "ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
    "ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
  }
]

[
  {
    "ErrorCode": "Something.WentWrong",
    "ErrorMessage": "Something went wrong"
  }
]

Product updates

NSEV WebPortal API

Create process step

Authorizations

Path Parameters

Body

Response