A valid request URL is required to generate request examples[
{
"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"
}
][
{
"ErrorCode": "Name.MinimumLength:6",
"ErrorMessage": "The minimum length for a name is 6"
}
][
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
][
{
"ErrorCode": "Something.WentWrong",
"ErrorMessage": "Something went wrong"
}
]Create unplaced element
Creates one or more unplaced elements on the specified package. The request body is an array; each entry creates one unplaced element.
An unplaced element is created on the package without a position on a document. It can later be positioned with the Package Elements Editor (see Get elements action url) or by creating a placed element that references it.
Four element types can be created, selected by the Type field on each entry:
signing fields, check box fields, text box fields and radio groups. Because unplaced
elements carry no position, only the type-specific content (signing methods, legal
notice, form-field name/label, radio options, and so on) is supplied - never a
location, dimensions, marker or field identifier.
A valid request URL is required to generate request examples[
{
"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"
}
][
{
"ErrorCode": "Name.MinimumLength:6",
"ErrorMessage": "The minimum length for a name is 6"
}
][
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
][
{
"ErrorCode": "Something.WentWrong",
"ErrorMessage": "Something went wrong"
}
]Authorizations
Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.
Path Parameters
The target package's unique identifier A package's unique identifier
"00000000-0000-0000-0000-000000000000"
Body
Collection of unplaced elements to be added to the package.
- Unplaced signing field
- Unplaced check box
- Unplaced text box
- Unplaced radio group
- Unplaced combo box
A field that can be signed by an actor
The type of element - the discriminator across the element variants.
The ComboBoxField value is available as of NSEV v8.5.
SigningField 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.
256The signing methods that may be used to sign this signing field. Always supply an
array, even for a single method. Each entry is an object with a Name and an optional
KeyPair; a bare signing-method name string is also accepted as shorthand for
{ "Name": "<method>" }. When omitted, the package's DefaultSigningMethods
(NSEV v8.5+) are applied to the field.
Show child attributes
Show child attributes
An optional legal notice added to the signing field. Supply either a custom Text
or the Name of a notice configured in the Config Index.
- Custom legal notice text
- Named legal notice from Config Index
Show child attributes
Show child attributes
Response
Ok
- Unplaced signing field (result)
- Unplaced check box field (result)
- Unplaced text box field (result)
- Unplaced radio group (result)
- Unplaced combo box field (result)
A field that can be signed by an actor
The type of element - the discriminator across the element variants.
The ComboBoxField value is available as of NSEV v8.5.
SigningField An element's unique identifier
"00000000-0000-0000-0000-000000000000"
This actor's unique identifier
"00000000-0000-0000-0000-000000000000"
The status of a document element
Pending, InProgress, Rejected, Failed, Finished, Refused 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.
256the type of marker (if set)
None, Text, PdfFormField A piece of text or PDF field identifier
An NSEV signing method
Show child attributes
Show child attributes