Skip to content
/Consent

ClickWrap Integrators API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

http://localhost/

AppLog

Manage appLogs

Operations

Create a new consent

Request

Headers
apiKeystringrequired
Bodyapplication/json

The content of the consent to create

agreementGroupGuidstring(uuid)required

Specifies the guid of the agreementGroup

consentGroupGuidstring or null(uuid)

Specifies the guid of the consentGroup

userIpstringnon-emptyrequired

Specifies the user ip address

Example: "127.0.0.1"
externalIDstringnon-emptyrequired

Specifies the external ID

Example: "2c65cf53-d083-4cab-8f13-402d73b24463"
environmentinteger(int32)(EnviromentEnum)required
Enum01
screenshotstring(byte)required
clausesArray of objects(ClausesViewModel)required
clauses[].​tagstring or null

The tag of the clause

Example: "my_tag"
clauses[].​acceptedboolean

Specifies wether the clause was accepted

Example: true
fieldCollectionobjectrequired
fieldCollection.​property name*Array of arrays(JToken)additional property
curl -i -X POST \
  http://localhost/api/Consent \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "agreementGroupGuid": "770963cd-b340-45fc-b4ac-6f58c2b4e58d",
    "consentGroupGuid": "fbcb1e92-2897-4fbc-a84f-cec8496772aa",
    "userIp": "127.0.0.1",
    "externalID": "2c65cf53-d083-4cab-8f13-402d73b24463",
    "environment": 0,
    "screenshot": "string",
    "clauses": [
      {
        "tag": "my_tag",
        "accepted": true
      }
    ],
    "fieldCollection": {
      "property1": [
        []
      ],
      "property2": [
        []
      ]
    }
  }'

Responses

Created

Bodyapplication/json
guidstring(uuid)
agreementobject(AgreementOutputViewModel)
fieldCollectionstring or null
consentDatestring(date-time)
platformstring or null
userIdentifierstring or null
clausesArray of objects or null(ClausesViewModel)
agreementHashstring or null
externalIDstring or null
consentGroupGuidstring(uuid)
screenshotstring or null(byte)
userIpstring or null
Response
application/json
{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "agreement": {
    "version": "string",
    "enviroment": 0,
    "groupGuid": "57b4a4e2-6452-4a39-a08e-ed582f926ada",
    "nameOfAgreement": "string"
  },
  "fieldCollection": "string",
  "consentDate": "2019-08-24T14:15:22Z",
  "platform": "string",
  "userIdentifier": "string",
  "clauses": [
    { … }
  ],
  "agreementHash": "string",
  "externalID": "string",
  "consentGroupGuid": "fbcb1e92-2897-4fbc-a84f-cec8496772aa",
  "screenshot": "string",
  "userIp": "string"
}

Provides a filtered list of consents

Request

Headers
apiKeystringrequired
Bodyapplication/json

The parameters to filter by

agreementGroupGuidstring or null(uuid)
externalIDstring or null
Example: "3fa85f64-5717-4562-b3fc-2c963f66afa6"
userIdentifierstring or null
dateFromstring or null(date-time)
Example: "2020/04/01"
dateTostring or null(date-time)
Example: "2030/04/01"
platformstring or null
enviromentinteger(int32)(EnviromentEnum)
Enum01
versionstring or null
getScreenshotboolean
pageinteger(int32)[ 0 .. 2147483647 ]
Example: 0
itemsPerPageinteger(int32)[ 1 .. 5000 ]
Example: 20
curl -i -X POST \
  http://localhost/api/Consent/List \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "agreementGroupGuid": "770963cd-b340-45fc-b4ac-6f58c2b4e58d",
    "externalID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
    "userIdentifier": "string",
    "dateFrom": "2020/04/01",
    "dateTo": "2030/04/01",
    "platform": "string",
    "enviroment": 0,
    "version": "string",
    "getScreenshot": true,
    "page": 0,
    "itemsPerPage": 20
  }'

Responses

Success

Bodyapplication/jsonArray [
guidstring(uuid)
agreementobject(AgreementOutputViewModel)
fieldCollectionstring or null
consentDatestring(date-time)
platformstring or null
userIdentifierstring or null
clausesArray of objects or null(ClausesViewModel)
blockchainProcessIdstring or null
blockchainTxHashstring or null
agreementHashstring or null
blockchainStatusinteger(int32)(ConsentStatusEnum)
Enum012345678
blockchainStatusDatestring(date-time)
externalIDstring or null
blockchainUuidstring or null
screenshotstring or null(byte)
consentGroupGuidstring(uuid)
userIpstring or null
]
Response
application/json
[
  {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "agreement": { … },
    "fieldCollection": "string",
    "consentDate": "2019-08-24T14:15:22Z",
    "platform": "string",
    "userIdentifier": "string",
    "clauses": [ … ],
    "blockchainProcessId": "string",
    "blockchainTxHash": "string",
    "agreementHash": "string",
    "blockchainStatus": 0,
    "blockchainStatusDate": "2019-08-24T14:15:22Z",
    "externalID": "string",
    "blockchainUuid": "string",
    "screenshot": "string",
    "consentGroupGuid": "fbcb1e92-2897-4fbc-a84f-cec8496772aa",
    "userIp": "string"
  }
]

Provides the audit trail pdf document for a specific consent

Request

Path
guidstring(uuid)required

The guid of the consent

Headers
apiKeystringrequired
curl -i -X GET \
  'http://localhost/api/Consent/GetAuditTrail/{guid}' \
  -H 'apiKey: string'

Responses

Success

Bodyapplication/pdf
string(binary)

SignedContract

Manage signedContracts

Operations