Field reference for Sample API data
The fields below are returned in the Sample API.
Add additional information about fields.
Create Package API Fields
| Field name |
Description |
Data type |
orgName
|
This is the unique identifier provided by the DSS team to each of the subscribers of the API as part of the on-boarding process. |
string |
packageName
|
User defined name for the package. The API supports max size of 64 characters. |
string |
senderEmail
|
Email address of the Sender / owner of the package. The API supports max size of 100 characters. |
string |
packageOption
|
A value of ‘create’ indicates that the package is created in draft mode. A value of ‘createSend’ indicates that the package is created and sent for signing to the senders. |
string |
packageDescription
|
This enables the user to provide brief details about the package being created. The API supports max size of 256 characters. |
string |
templateId
|
This is unique Id of the template from which the package is created. |
string |
Signers
|
The API provides ability to include multiple signers for a given document. |
string |
signerEmail
|
Email address of the signer. The API supports max size of 256 characters. |
string |
signerFirstName
|
Signer’s first name. The API supports max size of 100 characters. |
string |
signerLastName
|
Signer’s last name. The API supports max size of 100 characters. |
string |
placeHolder
|
This is the name of the signer placeholder in the template. |
string |
noteToSigner
|
For each signer, this field enables the Sender of the package to provide messages custom to the Signer(s). The API supports max size of 2048 characters. |
string |
enableSigningOrder
|
In scenarios where there are more than one Signers, a value of ‘true’ will indicate that the Signers sign the documents sequentially. The default value is ‘false’ and indicates that the Signers sign the documents in parallel. |
string |
Attachments
|
The API provides ability to attach multiple attachments which do not require signatures on them. |
string |
attachmentName
|
Name of the attachment to be used. The API supports pdf documents only. |
string |
attachmentContent
|
The actual attachment is included as base64Encoded string. The API support max. file size of 10mb. |
string |
Documents
|
The API provides ability to attach multiple documents and provide signer information for each of the documents. |
string |
documentName
|
Name of the document to be used for the signing ceremony. The API supports pdf documents only. |
string |
documentContent
|
The actual document is included as base64Encoded string. The API support max. file size of 10mb. |
string |
layoutName
|
Name of the the layout that is applied to the document. |
string |
Create Package From Template API Fields
| Field name |
Description |
Data type |
orgName
|
This is the unique identifier provided by the DSS team to each of the subscribers of the API as part of the on-boarding process. |
string |
packageName
|
User defined name for the package. The API supports max size of 64 characters. |
string |
senderEmail
|
Email address of the Sender / owner of the package. The API supports max size of 100 characters. |
string |
packageOption
|
A value of ‘create’ indicates that the package is created in draft mode. A value of ‘createSend’ indicates that the package is created and sent for signing to the senders. |
string |
packageDescription
|
This enables the user to provide brief details about the package being created. The API supports max size of 256 characters. |
string |
templateId
|
This is unique Id of the template from which the package is created. |
string |
Signers
|
The API provides ability to include multiple signers for a given document. |
string |
signerEmail
|
Email address of the signer. The API supports max size of 256 characters. |
string |
signerFirstName
|
Signer’s first name. The API supports max size of 100 characters. |
string |
signerLastName
|
Signer’s last name. The API supports max size of 100 characters. |
string |
placeHolder
|
This is the name of the signer placeholder in the template. |
string |
noteToSigner
|
For each signer, this field enables the Sender of the package to provide messages custom to the Signer(s). The API supports max size of 2048 characters. |
string |
Create Package from Document Layout API Fields
| Field name |
Description |
Data type |
orgName
|
This is the unique identifier provided by the DSS team to each of the subscribers of the API as part of the on-boarding process. |
string |
packageName
|
User defined name for the package. The API supports max size of 64 characters. |
string |
senderEmail
|
Email address of the Sender / owner of the package. The API supports max size of 100 characters. |
string |
packageOption
|
A value of ‘create’ indicates that the package is created in draft mode. A value of ‘createSend’ indicates that the package is created and sent for signing to the senders. |
string |
packageDescription
|
This enables the user to provide brief details about the package being created. The API supports max size of 256 characters. |
string |
Signers
|
The API provides ability to include multiple signers for a given document. |
string |
signerEmail
|
Email address of the signer. The API supports max size of 256 characters. |
string |
signerFirstName
|
Signer’s first name. The API supports max size of 100 characters. |
string |
signerLastName
|
Signer’s last name. The API supports max size of 100 characters. |
string |
placeHolder
|
This is the name of the signer placeholder in the template. |
string |
noteToSigner
|
For each signer, this field enables the Sender of the package to provide messages custom to the Signer(s). The API supports max size of 2048 characters. |
string |
enableSigningOrder
|
In scenarios where there are more than one Signers, a value of ‘true’ will indicate that the Signers sign the documents sequentially. The default value is ‘false’ and indicates that the Signers sign the documents in parallel. |
string |
Attachments
|
The API provides ability to attach multiple attachments which do not require signatures on them. |
string |
attachmentName
|
Name of the attachment to be used. The API supports pdf documents only. |
string |
attachmentContent
|
The actual attachment is included as base64Encoded string. The API support max. file size of 10mb. |
string |
Documents
|
The API provides ability to attach multiple documents and provide signer information for each of the documents. |
string |
documentName
|
Name of the document to be used for the signing ceremony. The API supports pdf documents only. |
string |
documentContent
|
The actual document is included as base64Encoded string. The API support max. file size of 10mb. |
string |
layoutName
|
Name of the the layout that is applied to the document. |
string |
Retrieve Package Documents in Zipped Format API Fields
| Field name |
Description |
Data type |
orgName
|
This is the unique identifier provided by the DSS team to each of the subscribers of the API as part of the on-boarding process. |
string |
packageId
|
Unique identifier for the package to be retrieved. (The packageId is available as a response to the CreatePackage API call. |
string |
Retrieve Individual Package Document
| Field name |
Description |
Data type |
orgName
|
This is the unique identifier provided by the DSS team to each of the subscribers of the API as part of the on-boarding process. |
string |
packageId
|
Unique identifier for the package to be retrieved. (The packageId is available as a response to the CreatePackage API call. |
string |
documentId
|
Unique identifier for the document to be retrieved. (The documentId is available as a response to the CreatePackage API call. |
string |
