Skip to content

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"
externalIDstring, non-emptyrequired

Specifies your ID

Example:"d8b7fcd1-e607-4099-8d66-f27884dddb77"
userIpstring, non-emptyrequired

Specifies the ip address of the user

Example:"127.0.0.1"
environmentinteger, (int32)(EnviromentEnum)required
Enum:01
screenshotstring, (byte)required

Specifies the byte array that contains the screenshot

clausesArray of objects(ClausesViewModel)required

The list of clauses

fieldCollectionobjectrequired
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
{ "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" }