A valid request URL is required to generate request examples{
"Id": "00000000-0000-0000-0000-000000000000",
"PackageId": "00000000-0000-0000-0000-000000000000",
"Type": "group",
"Actors": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Type": "signer",
"Status": "available",
"MemberLinks": [
{
"Email": "zu@li.test",
"Link": "https://dothething.test"
},
{
"Email": "john@doe.test",
"Link": "https://alsocompleteyouraction.test"
}
]
}
],
"GroupName": "Group123",
"Members": [
{
"Language": "en",
"FirstName": "John",
"LastName": "Doe",
"EmailAddress": "john@doe.test",
"BirthDate": "1990-01-16"
},
{
"Language": "en",
"FirstName": "Zu",
"LastName": "Li",
"EmailAddress": "zu@li.test",
"BirthDate": "1991-03-14"
}
]
}[
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
]Get stakeholder
Retrieves a single stakeholder from a package by its stakeholder ID.
A valid request URL is required to generate request examples{
"Id": "00000000-0000-0000-0000-000000000000",
"PackageId": "00000000-0000-0000-0000-000000000000",
"Type": "group",
"Actors": [
{
"Id": "00000000-0000-0000-0000-000000000000",
"Type": "signer",
"Status": "available",
"MemberLinks": [
{
"Email": "zu@li.test",
"Link": "https://dothething.test"
},
{
"Email": "john@doe.test",
"Link": "https://alsocompleteyouraction.test"
}
]
}
],
"GroupName": "Group123",
"Members": [
{
"Language": "en",
"FirstName": "John",
"LastName": "Doe",
"EmailAddress": "john@doe.test",
"BirthDate": "1990-01-16"
},
{
"Language": "en",
"FirstName": "Zu",
"LastName": "Li",
"EmailAddress": "zu@li.test",
"BirthDate": "1991-03-14"
}
]
}[
{
"ErrorCode": "Package.NotFound:00000000-0000-0000-0000-000000000000",
"ErrorMessage": "The package with id '00000000-0000-0000-0000-000000000000' could not be found"
}
]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 target stakeholder's unique identifier A stakeholder's unique identifier
"00000000-0000-0000-0000-000000000000"
Response
OK
- Undecided stakeholder
- Person stakeholder
- Group stakeholder
- Contact group stakeholder
Unspecified stakeholder
The type of stakeholder
Undecided A stakeholder's unique identifier
"00000000-0000-0000-0000-000000000000"
A package's unique identifier
"00000000-0000-0000-0000-000000000000"
The actions to be performed
Signs one or more signing fields
- Signer
- Receiver
- Approver
- Form filler
Show child attributes
Show child attributes
{ "Type": "signer", "Status": "available", "Elements": [ { "Id": "00000000-0000-0000-0000-000000000000", "Type": "signingField", "Location": { "Page": 2, "Top": 250, "Left": 250 }, "Dimensions": { "Width": 230, "Height": 230 } } ] }
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.
256