List packages

GET

packages

Error

A valid request URL is required to generate request examples

{
  "PageSize": 20,
  "Total": 1,
  "Items": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "BatchId": "00000000-0000-0000-0000-000000000000",
      "Name": "example package",
      "IsActionNeeded": true,
      "CreationDate": "2023-11-07T05:31:56Z",
      "ExpiryDate": "2023-11-07T05:31:56Z",
      "RevocationDate": "2023-11-07T05:31:56Z",
      "Initiator": "hello@world.test",
      "UnplacedElements": [
        {
          "Type": "signingField",
          "SigningMethods": [
            "manual"
          ],
          "LegalNotice": {
            "Text": "read and approved"
          },
          "Id": "C923F37A-DD9F-4877-B81C-40F2940C51B0",
          "ActorId": "4F2C1AED-DAE3-44F5-9879-0E3FFF9ED0B8",
          "Status": "Pending",
          "ExternalReference": "external reference example",
          "MarkerType": "PdfFormField",
          "MarkerId": "#SIG01"
        }
      ],
      "Documents": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "PackageId": "00000000-0000-0000-0000-000000000000",
          "Name": "example document",
          "CreationDate": "2023-11-07T05:31:56Z",
          "MediaType": "application/pdf",
          "Language": "en",
          "Elements": [
            {
              "Id": "00000000-0000-0000-0000-000000000000",
              "ActorId": "00000000-0000-0000-0000-000000000000",
              "ExternalReference": "<string>",
              "CompletedDate": "<string>",
              "Location": {
                "Page": 2,
                "Top": 200,
                "Left": 200
              },
              "UsedSigningMethod": "<string>",
              "SigningMethods": [
                "manual"
              ],
              "KeyPairMappings": [
                {
                  "SigningMethodName": "MailOtp:MailOtp",
                  "KeyPair": "MyKeyPair"
                }
              ],
              "LegalNotice": {
                "Text": "Read and approved"
              },
              "Dimensions": {
                "Width": 200,
                "Height": 200
              }
            }
          ],
          "ExternalReference": "<string>",
          "ProofCorrelationId": "<string>",
          "OrderIndex": 123,
          "IsActionNeeded": true,
          "ErrorCode": "<string>",
          "HasSignatures": true,
          "HasSigningFields": true,
          "HasFormFields": true
        }
      ],
      "Stakeholders": [
        {
          "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>"
        }
      ],
      "DefaultLegalNotice": {
        "Text": "Read and approved"
      },
      "ExternalReference": "<string>",
      "DocumentGroupCode": "<string>",
      "ThemeCode": "<string>",
      "CallBackUrl": "<string>",
      "NotificationCallBackUrl": "<string>",
      "F2fSigningUrl": "<string>",
      "PreviewUrl": "<string>",
      "DefaultRedirectUrl": "<string>",
      "F2fRedirectUrl": "<string>",
      "IsUnsignedContentDownloadable": true,
      "IsReassignEnabled": true,
      "ActionUrlExpirationPeriodInDays": 2,
      "ProofCorrelationId": "<string>",
      "AddInitiatorAsReceiver": true,
      "MustBeArchived": true,
      "ArchiveAuditProofs": true,
      "ArchiveAuditTrail": true,
      "Warnings": [
        {
          "ResourceType": "process",
          "Code": "ContactGroup.SomeMissingPhoneNumbers",
          "Message": "Some of the group members don't have a phone number required for [SmsOTP] signing type.",
          "Stakeholder": {
            "Id": "82c6b4f4-70fe-4fff-b176-6df0f4e79293",
            "ExternalReference": "userXYZ"
          },
          "Actor": {
            "Id": "73462bf5-8430-411d-befb-b35c92f35e10"
          }
        }
      ],
      "AutomaticReminder": {
        "IsSendAutomaticRemindersEnabled": true,
        "DaysBeforeFirstReminder": 2,
        "IsRepeatRemindersEnabled": true,
        "RepeatReminders": 2
      },
      "ExpirationReminder": {
        "IsSendExpirationRemindersEnabled": true,
        "DaysBeforeExpirationReminder": 2
      },
      "OtpAuthenticationSetting": {
        "IsSmsOtpAuthenticationEnabled": true,
        "IsMailOtpAuthenticationEnabled": true
      }
    }
  ]
}

Authorizations

Authorization

string

header

required

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

Query Parameters

pageNumber

integer

default:0

The page to retrieve

Required range: x >= 0

pageSize

integer

default:20

Maximum number of records in the response

Required range: x >= 1

createdBefore

string<date>

Select items created before given date

Example:

"2020-01-15"

createdAfter

string<date>

Select items created after given date

Example:

"2020-01-14"

status

string

Select items that have a specific status. In addition to the live statuses, the value Archived is accepted to filter for archived items.

documentGroupCode

string

Select items that have given documentGroupCode

initiator

string<email>

Select items that have given initiator email address

Example:

"john.doe@example.org"

packageName

string

Select items that have given package name

externalReference

string

Select items that have given external reference

batchId

string<guid>

Optional package batch identifier to filter packages by. A globally unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

sort

enum<string>

default:desc

specify how the result is sorted, default is descending

Available options:

asc,

desc

detailed

boolean

default:true

Specifies whether to return a detailed (true) or a simplified (false) list of packages.

Response

Detailed packages
Simplified packages

A page of packages in their full representation, returned when the detailed query parameter is true (the default).

PageSize

integer

The requested page size

Example:

20

Total

integer

The total number of items

Example:

1

Items

object[]

The packages on this page, each in full detail.

Show child attributes

Create packageCreates a package and, optionally, everything it contains in a single request. A package is the central object in NSEV: a container for one or more documents that are sent for signing, together with the stakeholders and actors who act on them. There are two ways to create a package: - **Build it up incrementally.** In its simplest form this call needs only the package `Name` and the `Initiator`. The package is created empty (status `Draft`) and you add documents, elements, stakeholders, actors and process steps afterwards with their respective calls. - **Super call.** Define every object in one request, mimicking the "Instant Package" behaviour of API v3: create the package, add documents, elements, stakeholders, actors and the process all at once. (Not applicable when creating from a template.) When building a super call with multiple documents, you have not yet received the document IDs, so elements reference their target document by position using `DocumentIndex` (0 = first document in the call, 1 = second, and so on). **Creating from a template.** Pass a `TemplateCode` to create a package that is pre-populated from a saved template. When a template code is used, the only other mandatory parameter is `Initiator`; `Name`, `ExternalReference` and `ProofCorrelationId` are optional, and all other package settings are taken from the template (any values you pass for them are overwritten by the template). **Size limitations** - A package must not exceed 150 MB. - A package must not contain more than 15 documents, and each document must not exceed 30 MB. - An `.xml` file must not contain more than 2 million characters, and a package must not contain more than 15 `.xml` files. - Large files may affect signing performance depending on the signer's internet connection. API requests never trigger a callback; callbacks fire only on end-user actions in the Portal or Signer application.

Error

A valid request URL is required to generate request examples

{
  "PageSize": 20,
  "Total": 1,
  "Items": [
    {
      "Id": "00000000-0000-0000-0000-000000000000",
      "BatchId": "00000000-0000-0000-0000-000000000000",
      "Name": "example package",
      "IsActionNeeded": true,
      "CreationDate": "2023-11-07T05:31:56Z",
      "ExpiryDate": "2023-11-07T05:31:56Z",
      "RevocationDate": "2023-11-07T05:31:56Z",
      "Initiator": "hello@world.test",
      "UnplacedElements": [
        {
          "Type": "signingField",
          "SigningMethods": [
            "manual"
          ],
          "LegalNotice": {
            "Text": "read and approved"
          },
          "Id": "C923F37A-DD9F-4877-B81C-40F2940C51B0",
          "ActorId": "4F2C1AED-DAE3-44F5-9879-0E3FFF9ED0B8",
          "Status": "Pending",
          "ExternalReference": "external reference example",
          "MarkerType": "PdfFormField",
          "MarkerId": "#SIG01"
        }
      ],
      "Documents": [
        {
          "Id": "00000000-0000-0000-0000-000000000000",
          "PackageId": "00000000-0000-0000-0000-000000000000",
          "Name": "example document",
          "CreationDate": "2023-11-07T05:31:56Z",
          "MediaType": "application/pdf",
          "Language": "en",
          "Elements": [
            {
              "Id": "00000000-0000-0000-0000-000000000000",
              "ActorId": "00000000-0000-0000-0000-000000000000",
              "ExternalReference": "<string>",
              "CompletedDate": "<string>",
              "Location": {
                "Page": 2,
                "Top": 200,
                "Left": 200
              },
              "UsedSigningMethod": "<string>",
              "SigningMethods": [
                "manual"
              ],
              "KeyPairMappings": [
                {
                  "SigningMethodName": "MailOtp:MailOtp",
                  "KeyPair": "MyKeyPair"
                }
              ],
              "LegalNotice": {
                "Text": "Read and approved"
              },
              "Dimensions": {
                "Width": 200,
                "Height": 200
              }
            }
          ],
          "ExternalReference": "<string>",
          "ProofCorrelationId": "<string>",
          "OrderIndex": 123,
          "IsActionNeeded": true,
          "ErrorCode": "<string>",
          "HasSignatures": true,
          "HasSigningFields": true,
          "HasFormFields": true
        }
      ],
      "Stakeholders": [
        {
          "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>"
        }
      ],
      "DefaultLegalNotice": {
        "Text": "Read and approved"
      },
      "ExternalReference": "<string>",
      "DocumentGroupCode": "<string>",
      "ThemeCode": "<string>",
      "CallBackUrl": "<string>",
      "NotificationCallBackUrl": "<string>",
      "F2fSigningUrl": "<string>",
      "PreviewUrl": "<string>",
      "DefaultRedirectUrl": "<string>",
      "F2fRedirectUrl": "<string>",
      "IsUnsignedContentDownloadable": true,
      "IsReassignEnabled": true,
      "ActionUrlExpirationPeriodInDays": 2,
      "ProofCorrelationId": "<string>",
      "AddInitiatorAsReceiver": true,
      "MustBeArchived": true,
      "ArchiveAuditProofs": true,
      "ArchiveAuditTrail": true,
      "Warnings": [
        {
          "ResourceType": "process",
          "Code": "ContactGroup.SomeMissingPhoneNumbers",
          "Message": "Some of the group members don't have a phone number required for [SmsOTP] signing type.",
          "Stakeholder": {
            "Id": "82c6b4f4-70fe-4fff-b176-6df0f4e79293",
            "ExternalReference": "userXYZ"
          },
          "Actor": {
            "Id": "73462bf5-8430-411d-befb-b35c92f35e10"
          }
        }
      ],
      "AutomaticReminder": {
        "IsSendAutomaticRemindersEnabled": true,
        "DaysBeforeFirstReminder": 2,
        "IsRepeatRemindersEnabled": true,
        "RepeatReminders": 2
      },
      "ExpirationReminder": {
        "IsSendExpirationRemindersEnabled": true,
        "DaysBeforeExpirationReminder": 2
      },
      "OtpAuthenticationSetting": {
        "IsSmsOtpAuthenticationEnabled": true,
        "IsMailOtpAuthenticationEnabled": true
      }
    }
  ]
}

Product updates

NSEV WebPortal API

Authorizations

Query Parameters

Response