Skip to main content
GET
Error

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"

​
elementId
string<guid>
required

The target elements's unique identifier An element's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Response

OK

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
​
Id
string<guid>

An element's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
ActorId
string<guid>

This actor's unique identifier

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
​
MarkerType
enum<string> | null

the type of marker (if set)

Available options:
None,
Text,
PdfFormField
​
MarkerId
string | null

A piece of text or PDF field identifier

​
SigningMethods
string[]

An NSEV signing method

​
LegalNotice
Custom legal notice text · object