Submit process step action
Adds an actor to an existing process step, identified by its stepIndex. The
actor parameters are the same as for Create process step. On success the Location
header points to the created actor under its stakeholder.
The same actor-type rules apply: a step may not mix actor types except FormFillers with Approvers.
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"
The index of the process step
x >= 0Body
- Signer
- Approver
- Form filler
- Receiver
Signs one or more signing fields
The type of action an actor performs on a package, and the discriminator across the actor variants.
- FormFiller - fills TextBoxField, CheckBoxField, RadioGroup and ComboBoxField (NSEV v8.5+) elements; does not sign or approve. Must be placed in the first process step.
- Approver - approves a document as fit for signing, before any signer acts. Must be placed in the first process step (may share it with FormFillers).
- Signer - signs one or more signing fields.
- Receiver - receives a copy of the fully signed document; takes no action and must be placed in the last process step.
Signer A stakeholder's unique identifier
"00000000-0000-0000-0000-000000000000"
suppress the notifications for this actor
Url to which the stakeholder is redirected after completing this action
The actor's elements
Parameters for creating a signing field
- New signing field on a document
- Existing element by Id
When stakeholder gets redirected after completing this action
- afterSession - Redirect after signing session is ended, but before package is completed (only important for last signer).
- immediately - Redirect as soon as possible.
- afterDelay - Redirect after some delay (defined on frontend).
- afterCompletion - Redirect after the package is completed.
Only valid together with RedirectUrl - the API rejects RedirectType without it.
AfterSession, Immediately, AfterDelay, AfterCompletion URL to which the end user is sent after pressing close session button
"https://homepage.example.test"
Response
Actor was added to the process step. The location header points to the location of the created actor under its stakeholder.
- Signer
- Receiver
- Approver
- Form filler
Signs one or more signing fields
This actor's unique identifier
"00000000-0000-0000-0000-000000000000"
The type of action an actor performs on a package, and the discriminator across the actor variants.
- FormFiller - fills TextBoxField, CheckBoxField, RadioGroup and ComboBoxField (NSEV v8.5+) elements; does not sign or approve. Must be placed in the first process step.
- Approver - approves a document as fit for signing, before any signer acts. Must be placed in the first process step (may share it with FormFillers).
- Signer - signs one or more signing fields.
- Receiver - receives a copy of the fully signed document; takes no action and must be placed in the last process step.
Signer The status of an actor's action.
- Draft - the package is still in draft; the action is not yet active.
- Waiting - the action is waiting for an earlier process step to complete.
- Available - the action is ready to be performed.
- InProgress - the action is being performed.
- Failed - the action failed.
- Finished - the action was completed.
- Rejected - the actor rejected the document.
- Skipped - the action was skipped (for example via skip approvers/signers).
Draft, Waiting, Available, InProgress, Failed, Finished, Rejected, Skipped suppress the notifications for this actor
Only present when the actor's stakeholder is a person.
links to interact with the package for this person stakeholder
Only present when the actor's stakeholder is a group or contact group.
The result of a completed action
The actor's elements
Url to which the stakeholder is redirected after completing this action
When stakeholder gets redirected after completing this action
- afterSession - Redirect after signing session is ended, but before package is completed (only important for last signer).
- immediately - Redirect as soon as possible.
- afterDelay - Redirect after some delay (defined on frontend).
- afterCompletion - Redirect after the package is completed.
Only valid together with RedirectUrl - the API rejects RedirectType without it.
AfterSession, Immediately, AfterDelay, AfterCompletion URL to which the end user is sent after pressing close session button
"https://homepage.example.test"