Important Definitions
Before using ToughClicks, it's helpful to understand the key terms used throughout the platform and documentation.
Packet
A packet is a group of documents. Oftentimes, a signup packet may include the Terms of Service and Privacy Policy documents.
Example: A "User Registration Packet" might contain:
- Terms of Service document
- Privacy Policy document
- Cookie Policy document
Document
A document is a contract template, Terms of Service, for example. Documents house shared meta-data (such as display name) between related versions of this template as it is updated over time.
Key Points:
- Documents represent a type of legal agreement
- Documents can have multiple versions over time
- Each document has a display name and other metadata
- Documents can belong to multiple packets
Version
A version is a numbered instance of a document. It contains the actual legalese that is active at a given time.
Important Fields:
- State: A version can either be in the
DRAFTstate orPUBLISHEDstate - Version Number: This is the
{MAJOR}.{MINOR}version number used to determine if a user has agreed to the latest version of a document
Once a version is published, it cannot be edited or deleted. This ensures the integrity of user acceptances.
Acceptance
An acceptance is a legally binding agreement stating that a specific user has agreed to a specific version of a document.
What's Tracked:
- Which user accepted
- Which document version was accepted
- When the acceptance occurred
- Any custom data associated with the acceptance
- The context in which it was accepted (IP address, user agent, etc.)
Terms / Contents
Terms and Contents are often used interchangeably to denote the actual legal content of a version.
This is the HTML or markdown content that users will read before accepting.
Signer
The signer is the user who is agreeing to your terms.
Identification:
- Can be identified by email address
- Can be identified by a UUID or other unique identifier
- The signer ID is what you'll use to verify acceptance later
Client
A client represents your application or integration in the ToughClicks system.
Key Information:
- Each client has a unique Client ID (token)
- Clients are used to authenticate API requests
- Multiple packets can belong to a single client
Next Steps
Now that you understand the core terminology, learn about how these entities relate to each other in the Data Model.