Create Clickwrap

Creates a new test or live Clickwrap in the Valtt system.

Create Clickwrap

POST https://app.valtt.com/api/create/

This endpoint accepts clickwrap data, creates a clickwrap fingerprint, and stores the clickwrap fingerprint and data. After it is recorded a backend process starts and records the clickwraps on the Blockchain. The Blockchain recording process does not happen for test data or clickwraps created by Starter Plan accounts. To save test data, use a TEST API Key. To save live data, use a LIVE API Key. A success response will indicate the type of data that was stored.

Headers

Name	Type	Description
Authentication	string	Basic Auth, API Key and API Secret. To save test data, use a test API Key, to save live data use a live API Key. See Getting Started > API Authentication.

Request Body

Name	Type	Description
Unique-User-ID	string	An email address or other unique identifier for your user.
Agreement-ID	string	This can be found in the Valtt Dashboard, click Agreements on left menu, choose your Agreement, click on the name. At the top of the edit page you will find "Agreement: long-string-agreement-id". The Agreement ID is the part after the colon.
User-Agent-Info	string	Specific information about the device that your user is using to agree to the agreement. In a website it is comprised of browser type, browser version, screen height and width, etc.
IP-Address	string	The IP Address of your user, the IP they used to access your agreement form.
Form-Location	string	The location, website URL, or other location information you have about your user when they filled out the agreement form.

200 Clickwrap successfully saved.

{
    "status": "success",
    "unique-user-id": "[e-mail]",
    "clickwrap-fingerprint": "2c4ba2bbdj322sdsdf323asa3ls0lad034ldss26b5d22f583ff33712ad4b9dbda",
    "test-data": "n",
    "time_gmt": "2020-07-21 22:49:28"
}

404 If an error occurred the response will always indicate as below with a specific error message.

{
    "status": "error",
    "error_message": "Missing or blank required data: Unique User ID.",
    "time_gmt": "2020-07-21 23:17:39"
}

Example cURL Request

curl --location --request POST 'https://app.valtt.com/api/clickwrap/create/' \
--header 'Authorization: Basic dmtfdGVzdF8xYjFhNGRjODE6OWJmNmU3YTM1ODgyOGQ2YTZiZWUyNWNmMmNmMjBlMjJiZjU2MjQ2ZDAwMmM0ODZiZTE0M2IyYTkwNTU2MmUwMTc4MjI3ODNkNTM1ZjYw' \
--form 'Unique-User-ID=[e-mail]' \
--form 'Agreement-ID=4EE12385FBF002722150959733C50176DD33F3584590223332DB27AEFC44DCEF7' \
--form 'User-Agent-Info=Mac;Chrome v17;' \
--form 'IP-Address=127.0.0.1' \
--form 'Form-Location=my-website.com/signup-form'