List document elements

GET

packages

{packageId}

documents

{documentId}

elements

Error

A valid request URL is required to generate request examples

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "signingField",
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    }
  },
  {
    "Id": "00000000-0000-0000-0000-000000000001",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "TextBoxField",
    "Name": "TextBox1",
    "Label": "Empty textbox",
    "IsRequired": false,
    "IsMultiline": false,
    "Value": null,
    "DefaultValue": null,
    "CharLimit": 115,
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    },
    "ExternalReference": "my_checkboxfield"
  },
  {
    "Id": "00000000-0000-0000-0000-000000000002",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "CheckBoxField",
    "Name": "CheckBox1",
    "Label": "To be checked",
    "IsRequired": true,
    "Checked": null,
    "DefaultValue": false,
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    },
    "ExternalReference": "my_checkboxfield"
  }
]

[
  {
    "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"

documentId

string<guid>

required

The target document's unique identifier A document's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

Signing field
Check box field
Text box field
Radio group

A field that can be signed by an actor

Type

enum<string>

required

the type of element ( the discriminator of the different types of elements, for the moment there's just one! )

Available options:

SigningField,

TextBoxField,

CheckBoxField,

RadioGroup

string<guid>

An element's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

ActorId

string<guid>

Is null when no actor has been assigned to this field yet

Example:

"00000000-0000-0000-0000-000000000000"

Status

enum<string>

The status of a document element

Available options:

Pending,

InProgress,

Rejected,

Failed,

Finished,

Refused

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

CompletedDate

string<dateTime>

Location

object

where an element is placed

Show child attributes

Example:

{ "Page": 2, "Top": 200, "Left": 200 }

UsedSigningMethod

string

The signingmethod that was used to sign this signingfield

SigningMethods

string[]

An NSEV signing method

KeyPairMappings

object[]

Show child attributes

LegalNotice

Custom legal notice text · object

Show child attributes

Dimensions

Element dimensions · object

The size of an element in points. The minimum width and height depend on the element type - a signing field must be at least 50 × 30, other elements at least 10 × 10. See the Field positioning guide.

Show child attributes

Example:

{ "Width": 200, "Height": 200 }

Create elementAdds one element to an existing document. The element type is chosen with the `Type` field, which can be one of four values: - **SigningField** - marks where a signature must be placed. Signing fields are always mandatory. - **TextBoxField** - a text input the end user can fill in. May carry a prefilled default value and may be mandatory or optional. - **CheckBoxField** - a checkbox the end user can toggle. May be checked by default and may be mandatory or optional. - **RadioGroup** - a group of radio buttons (the individual buttons are the group's `Options`). May have a button selected by default and may be mandatory or optional. An element is positioned in one of the ways described on the placement schemas: with an explicit `Location` and `Dimensions`, with a text `Marker`, or with a `FieldId` that references an existing form field in the uploaded document. A signing field signed only with the server signing method can also be created invisible, with no position at all. An element can instead be created from an existing unplaced element by supplying its `UnplacedElementId`. A single document must not contain more than 30 signing fields. When the request references a marker or an existing form field (`Marker` or `FieldId`), it is recommended to add the element at document-upload time: after a document conversion the referenced marker or field may no longer exist.

Error

A valid request URL is required to generate request examples

[
  {
    "Id": "00000000-0000-0000-0000-000000000000",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "signingField",
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    }
  },
  {
    "Id": "00000000-0000-0000-0000-000000000001",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "TextBoxField",
    "Name": "TextBox1",
    "Label": "Empty textbox",
    "IsRequired": false,
    "IsMultiline": false,
    "Value": null,
    "DefaultValue": null,
    "CharLimit": 115,
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    },
    "ExternalReference": "my_checkboxfield"
  },
  {
    "Id": "00000000-0000-0000-0000-000000000002",
    "ActorId": "00000000-0000-0000-0000-000000000000",
    "Type": "CheckBoxField",
    "Name": "CheckBox1",
    "Label": "To be checked",
    "IsRequired": true,
    "Checked": null,
    "DefaultValue": false,
    "Location": {
      "Page": 1,
      "Top": 200,
      "Left": 200
    },
    "Dimensions": {
      "Width": 200,
      "Height": 200
    },
    "ExternalReference": "my_checkboxfield"
  }
]

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

Product updates

NSEV WebPortal API

List document elements

Authorizations

Path Parameters

Response