Skip to main content
POST
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"

​
stakeholderId
string<guid>
required

The target stakeholder's unique identifier A stakeholder's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
actorId
string<guid>
required

The target actor's unique identifier This actor's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

Body

application/json
​
Stakeholder
object
required

The new person stakeholder that replaces the appointed actor

​
ReassignmentReason
string
required

The reason for the reassignment. Required.

Response

200 - application/json

Actor was reassigned

A single individual

​
Type
enum<string>
required

The type of stakeholder

Available options:
Person
​
Language
string<languageCode>
required

A country's 2 letter ISO code (ISO 639-1)

Example:

"en"

​
LastName
string
required

Last name of the stakeholder

Maximum string length: 150
​
EmailAddress
string<email>
required
Example:

"hello@world.test"

​
Id
string<guid>

A stakeholder's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
PackageId
string<guid>

A package's unique identifier

Example:

"00000000-0000-0000-0000-000000000000"

​
Actors
(Signer · object | Receiver · object | Approver · object | Form filler · object)[]

The actions to be performed

Signs one or more signing fields

Example:
​
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
​
FirstName
string

First name of the stakeholder

Maximum string length: 150
​
PhoneNumber
string

Phone number used to receive an SMS OTP. Always include the country code (for example +32xxxxxxxxx); use a leading plus sign rather than "00" as the international dialing prefix, and never include spaces.

Example:

"+32xxxxxxxxx"

​
BirthDate
string<date>
​
AdditionalProperties
object

Additional stakeholder properties configured in the Contact Properties Settings of the configuration - any extra stakeholder information the administrator requires (for example maiden name or nationality). Two properties are configured by default in every environment: BeId (the stakeholder's national security number) and BeLawyer (their lawyer ID). When a mandated signing rule is applied to a property, that property becomes mandatory and its value is checked against the data extracted from the signing certificate or returned by the signing service; a match is required for the stakeholder to be mandated to sign. Use Get signing methods to see which additional properties are mandatory for each signing method.

Example:
​
Substitutes
object[]

Active substitutes of the person