List stakeholders - Nitro APIs

GET

/

packages

/

{packageId}

/

stakeholders

Error

A valid request URL is required to generate request examples

[
  {
    "Type": "Undecided",
    "Id": "00000000-0000-0000-0000-000000000000",
    "PackageId": "00000000-0000-0000-0000-000000000000",
    "Actors": [
      {
        "Type": "signer",
        "Status": "available",
        "Elements": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Type": "signingField",
            "Location": {
              "Page": 2,
              "Top": 250,
              "Left": 250
            },
            "Dimensions": {
              "Width": 230,
              "Height": 230
            }
          }
        ]
      }
    ],
    "ExternalReference": "<string>"
  }
]

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

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

Undecided stakeholder
Person stakeholder
Group stakeholder
Contact group stakeholder

Unspecified stakeholder

Type

enum<string>

required

The type of stakeholder

Available options:

Undecided

Id

string<guid>

A stakeholder's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

PackageId

string<guid>

A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Actors

(Signer · object | Receiver · object | Approver · object | Form filler · object)[]

The actions to be performed

Signs one or more signing fields

Signer
Receiver
Approver
Form filler

Show child attributes

Example:

{
  "Type": "signer",
  "Status": "available",
  "Elements": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "Type": "signingField",
      "Location": { "Page": 2, "Top": 250, "Left": 250 },
      "Dimensions": { "Width": 230, "Height": 230 }
    }
  ]
}

ExternalReference

string

External reference to this resource set by the calling application. NSEV does not use this value itself. When filtering packages, this matches the package-level external reference only, not document or field references.

Maximum string length: 256

Create stakeholderCreates a stakeholder and adds it to the specified package. A stakeholder is an entity that has an interest in a package; a single stakeholder may carry multiple actors (the actions it must take, such as filling forms, approving, signing or receiving). Three types of stakeholder can be created, selected with the `Type` property: - **person** - a single individual. Only that person can act on the package. - **group** - a group of people, defined inline through `Members`. Any member can form fill, approve or sign on behalf of the whole group, and each member receives a unique URL. As soon as one member acts, the others can no longer act. - **contactGroup** - references a contact group already created in the NSEV WebPortal by its `ContactGroupCode`, instead of listing members inline. It behaves like a group stakeholder. A contactGroup stakeholder only exists while the package is in draft; once the package moves to pending it is converted to a **group** stakeholder, while the contact group code is retained. Actors can be supplied inline through `Actors`. The actor parameters are the same as for Create actor.

Error

A valid request URL is required to generate request examples

[
  {
    "Type": "Undecided",
    "Id": "00000000-0000-0000-0000-000000000000",
    "PackageId": "00000000-0000-0000-0000-000000000000",
    "Actors": [
      {
        "Type": "signer",
        "Status": "available",
        "Elements": [
          {
            "Id": "00000000-0000-0000-0000-000000000000",
            "Type": "signingField",
            "Location": {
              "Page": 2,
              "Top": 250,
              "Left": 250
            },
            "Dimensions": {
              "Width": 230,
              "Height": 230
            }
          }
        ]
      }
    ],
    "ExternalReference": "<string>"
  }
]

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