Common Data Structures in Ironclad Clickwrap
Within Ironclad Clickwrap, there is a set of data structures to consider when interacting with the API that will help you formulate the ideal integration:
Signer
- Any person or organization identified by any unique identifier to your company that is accepting documents
- Can accept contracts via clickwrap through a series of events we call activities
Activity
- An event that’s logged for a
Signer
against a given Contract Version and, optionally, aGroup
. - Common types of events include:
- Visited - A specific
Signer
viewed a clickwrap contract(s) - Displayed - An individual viewed the full text of the clickwrap contract (usually by clicking on the link in the clickwrap)
- Agreed - A specific
Signer
agreed to a clickwrap contract(s) - Disagreed (optional) - A specific
Signer
disagreed to a clickwrap contract(s).
- Visited - A specific
Contract
- Can have many versions that are drafted and published
- Has both a
latest_version
and apublished_version
(if a version has been published)
Group
- "Container" for your contracts where you can manage visual and overall settings
- Can contain one or more contracts to present to an individual for review and acceptance
Account
- All Signers, Contracts, and Activities live within a
Site
, which aSite
lives within anAccount
- An
Account
can have manySites
which act as a sub-tenant within your environment. OneSite
is your default, which controls how aContract
can be shared across anAccount
.
Updated 8 months ago