Home - zentry-developer/sdk GitHub Wiki

The purpose of the SDK is to allow its clients to initiate a signing flow of a document.

A document order specifies who should sign the document and what they should sign.

The who is defined by the properties Subjects, Contacts, and Relationships.

Subjects:
The subjects/parties the document is in regard to, e.g., a company and an employee, a school and a student, etc.
If only one subject is added, the system will automatically add the customer/school as the other subject.

Contacts:
Signers, recipients, or subjects.

Relationships:
Defines the relationships between the contacts.

The what is defined by the properties DocumentOrderDefinitionId, MergeFields, and DataFields. The what is obtained from the DocumentOrderDefinitionsFacade which return a list of definitions created by the customer.

DocumentOrderDefinitionId:
The definition ID for the order. A list of available definitions can be obtained from the DocumentOrderDefinitionsFacade.

MergeFields:
A list of fields that are merged into the document.
The fields are defined in the document order definition.

DataFields:
The data fields that will be returned once the document order is completed.
The fields are defined in the document order definition.