Create package

Name of the package. It is shown in the NSEV WebPortal and used as the file name when the package is downloaded as a .zip file, so do not add a file extension.

Avoid forbidden file-name characters - slash (/), backslash (\), question mark (?), percent (%), asterisk (*), colon (:), pipe (|), single quote, double quote ("), less-than (<) and greater-than (>) - and HTML-sensitive characters such as ampersand (&) and apostrophe. This list is not exhaustive. When using itsme signing, use only characters supported by ISO 8859-15; some software-generated characters such as curly apostrophes and long dashes are not supported.

Email address of a known user of the webSigner portal

Status the package will have once created. By default a package is created in Draft. Set Pending to send it for signing immediately.

Identifier of the document group the package is uploaded to. By default an initiator uploads to their personal "My Documents" folder, which cannot be shared. An NSEV admin can configure additional document groups so users can collaborate on each other's packages. To use "My Documents", omit this parameter or pass 00001; to use a specific group, pass its document group code. Use the Get document groups call to discover the configured codes.

Date and time when the package (and every document in it) expires and can no longer be form filled, approved or signed. ISO 8601 date-time.

Theme code applied to the package's look and feel. When omitted, the theme configured at environment level in the Config Index - or at document-group level if applicable - is used.

Absolute URL, without query parameters, that NSEV calls with an HTTP POST whenever the package's status changes, so an external system can react. Callbacks fire on end-user actions such as: a user changing the package from Draft to Pending or revoking it in the Document Portal, confirming in a drag-and-drop editor, a signer completing all their fields or rejecting, all signers signing, an approver approving, form fillers completing fields, or the system setting the package to Failed. API requests never trigger a callback.

The POST body is application/json containing packageId and packageStatus, e.g. {"packageId":"d2912916-c555-47af-b666-1e8cf2eb9dfa","packageStatus":"Finished"}. If the external system needs more information it can issue a Get package by ID call. The callback has a 100-second timeout: if your service does not respond in time, NSEV forces the timeout and finishes the flow as if it had received 200 OK, so respond as quickly as possible and run any follow-up work asynchronously. On error, NSEV retries the callback 3 times over 3 retry cycles by default (configurable by administrators).

URL called each time a signer requests a new signing URL. NSEV uses one-time signing URLs, so a link expires once clicked and a new one must be requested; when set, this URL lets a remote service decide what to do instead of sending the usual email.

The remote service is called once per user action (no retry unless the end user requests another notification) with an application/json POST body containing packageId, actorId, language and notificationTypeKey. Current notificationTypeKey values are SendActionUrl (the single-use action link was already used and a new one was requested) and SendDownloadUrl (the single-use download link was already used and a new one was requested); ignore other values without erroring, as the list may grow. NSEV waits for the service to finish before returning control to the end user, so it must respond within seconds. This is separate from SuppressNotifications. On error, NSEV retries 3 times over 3 retry cycles by default.

Default url to which stakeholders will be redirected after completing their actions. Set on package submit, when actor has no RedirectUrl.

Absolute URL, without query parameters, that the end user is redirected to after signing or rejecting all fields face to face in the Document Portal. Do not confuse this with a regular redirect URL - it applies only to face-to-face signing.

NSEV appends SessionID (the package signing session, i.e. the package ID), Status (FINISHED, REJECTED or INVALIDTOKEN) and PackageExternalReference (the package's ExternalReference). Because the redirect happens client-side the end user can counterfeit it, so verify the outcome through a second secure channel (the callback URL) or by checking session state, then confirm with a Get package status call.

During asynchronous signing, configuring an F2fRedirectUrl removes the Close button (which would otherwise let the signer leave while signing continues in the background); signers instead see a message that they will be redirected.

Whether an actor can download the package from the WYSIWYS (What You See Is What You Sign) page before form filling, approving, signing or rejecting - for example to print and read it on paper. When omitted, the value of the Config Index setting IsDownloadUnsignedFilesEnabled (Customization Settings) is used.

Whether a stakeholder may reassign their action to another party. When omitted, the value of the Config Index setting IsReassignEnabled (Customization Settings) is used.

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.

Number of days after which unused action URLs expire. When omitted, the value is taken from the Config Index setting IsActionUrlExpirationEnabled (Customization Settings). The maximum equals the number of days left until 9999-12-31.

Id for correlating with other resources in the proofs system

Whether the initiator is added as a receiver of the package automatically, so you do not have to add them with a Create actor call. Overrides the environment-level IsAddInitiatorAsReceiverEnabled setting; when that setting is already true, every initiator is added as receiver and passing this is unnecessary.

Whether the package is sent to the external archive when it reaches the Finished status. Ignored when archiving is not configured at environment level; when archiving is configured, every package is archived by default, so passing this is unnecessary.

Whether the audit proofs are sent to the external archive when the package is Finished. Ignored when archiving is not configured or audit proofs are disabled in the audit tools or archive settings.

Whether the audit trail is sent to the external archive when the package is Finished. Ignored when archiving is not configured or the audit trail is disabled in the audit tools or archive settings.