Skip to content
Technical reference
/
/
Provides a filtered list...

ClickWrap Integrators API (v1)

Download OpenAPI description
openapi.json
openapi.yaml
Languages
Servers

http://localhost/

AppLog

Manage appLogs

Operations

SignedContract

Manage signedContracts

Operations

Create a new signedContract

Request

Headers
apiKeystringrequired
Bodyapplication/json

The content of the signedContract to create

contractGroupGuidstring(uuid)required

The guid of the contract

Example: "d8b7fcd1-e607-4099-8d66-f27884dddb77"
templateVariantstring or null

The name of the template variant

Example: "Default"
externalIDstringnon-emptyrequired

Specifies your ID

Example: "d8b7fcd1-e607-4099-8d66-f27884dddb77"
userIpstringnon-emptyrequired

Specifies the ip address of the user

Example: "127.0.0.1"
environmentinteger(int32)(EnviromentEnum)required
Enum01
screenshotstring(byte)required

Specifies the byte array that contains the screenshot

clausesArray of objects(ClausesViewModel)required

The list of clauses

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*string or nulladditional property
curl -i -X POST \
  http://localhost/api/SignedContract \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "contractGroupGuid": "d8b7fcd1-e607-4099-8d66-f27884dddb77",
    "templateVariant": "Default",
    "externalID": "d8b7fcd1-e607-4099-8d66-f27884dddb77",
    "userIp": "127.0.0.1",
    "environment": 0,
    "screenshot": "string",
    "clauses": [
      {
        "tag": "my_tag",
        "accepted": true
      }
    ],
    "fieldCollection": {
      "property1": "string",
      "property2": "string"
    }
  }'

Responses

Created

Bodyapplication/json
guidstring(uuid)
contractobject(SignedContractOutputViewModel)
fieldCollectionstring or null
signedContractDatestring(date-time)
platformstring or null
userIdentifierstring or null
clausesArray of objects or null(ClausesViewModel)
contractHashstring or null
externalIDstring or null
signedContractGroupGuidstring(uuid)
userIpstring or null
contractGuidstring(uuid)
Response
application/json
{
  "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
  "contract": {
    "version": "string",
    "enviroment": 0,
    "groupGuid": "57b4a4e2-6452-4a39-a08e-ed582f926ada",
    "nameOfContract": "string"
  },
  "fieldCollection": "string",
  "signedContractDate": "2019-08-24T14:15:22Z",
  "platform": "string",
  "userIdentifier": "string",
  "clauses": [
    { … }
  ],
  "contractHash": "string",
  "externalID": "string",
  "signedContractGroupGuid": "b9a34dd2-b917-48c8-8ecb-b0719876b2b9",
  "userIp": "string",
  "contractGuid": "f11813e8-afe1-4fa0-a053-9ccc430d3c1b"
}

Provides a filtered list of signedContracts

Request

Headers
apiKeystringrequired
Bodyapplication/json

The parameters to filter by

contractGroupGuidstring(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/SignedContract/List \
  -H 'Content-Type: application/json' \
  -H 'apiKey: string' \
  -d '{
    "contractGroupGuid": "a32e40b5-e5e1-4718-8453-0d0b1ced5aef",
    "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)
contractobject(SignedContractOutputViewModel)
fieldCollectionstring or null
contractGuidstring(uuid)
signedContractDatestring(date-time)
platformstring or null
userIdentifierstring or null
clausesArray of objects or null(ClausesViewModel)
blockchainProcessIdstring or null
blockchainTxHashstring or null
contractHashstring or null
blockchainStatusinteger(int32)(ConsentStatusEnum)
Enum012345678
blockchainStatusDatestring(date-time)
externalIDstring or null
blockchainUuidstring or null
pdfstring or null(byte)
signedContractGroupGuidstring(uuid)
userIpstring or null
screenshotstring or null(byte)
]
Response
application/json
[
  {
    "guid": "ee6a7af7-650d-499b-8e32-58a52ffdb7bc",
    "contract": { … },
    "fieldCollection": "string",
    "contractGuid": "f11813e8-afe1-4fa0-a053-9ccc430d3c1b",
    "signedContractDate": "2019-08-24T14:15:22Z",
    "platform": "string",
    "userIdentifier": "string",
    "clauses": [ … ],
    "blockchainProcessId": "string",
    "blockchainTxHash": "string",
    "contractHash": "string",
    "blockchainStatus": 0,
    "blockchainStatusDate": "2019-08-24T14:15:22Z",
    "externalID": "string",
    "blockchainUuid": "string",
    "pdf": "string",
    "signedContractGroupGuid": "b9a34dd2-b917-48c8-8ecb-b0719876b2b9",
    "userIp": "string",
    "screenshot": "string"
  }
]

Provides the audit trail pdf document for a specific signedContract

Request

Path
guidstring(uuid)required

The guid of the signedContract

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

Responses

Success

Bodyapplication/pdf
string(binary)

Provides the signed contract pdf document for a specific signedContract

Request

Path
guidstring(uuid)required

The guid of the signedContract

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

Responses

Success

Bodyapplication/pdf
string(binary)