ClauseDrop Documentation

Introduction

The ClauseDrop API is organized around REST. Our API has predictable resource-oriented URLs, accepts form-encoded request bodies, returns JSON-encoded responses, and uses standard HTTP response codes, authentication, and verbs.

The ClauseDrop API uses API keys to authenticate requests. You can view and manage your API keys in the Agency Dashboard.

Authentication to the API is performed via HTTP Basic Auth. Provide your API key as the basic auth username value. You do not need to provide a password.

curl https://api.clausedrop.com/v3/rooms \
  -u cd_live_8a7b6c5d4e3f2g1h:

All API requests must be made over HTTPS. Calls made over plain HTTP will fail. API requests without authentication will also fail.

Provisions a new immutable contract execution environment. Once created, the scope and financial consideration cannot be altered without invalidating the room.

Request Parameters

{
  "client_name": "Acme Global Corp",
  "project_scope": "E-Commerce Backend Refactor",
  "contract_value": 1850000,
  "jurisdiction": "IND_ACT_1872",
  "enforce_ip_lock": true
}

{
  "id": "DR-9021",
  "object": "deal_room",
  "status": "draft",
  "url": "https://deals.clausedrop.com/r/DR-9021",
  "created_at": 1722512400,
  "metadata": {
    "client_hash": null
  }
}

ClauseDrop can send webhook events that notify your application any time a client views a room or executes a cryptographic signature. To ensure the payloads are genuinely originating from ClauseDrop infrastructure, you must verify the CD-Signature header.

<?php
// Extract the payload and signature header
$payload = file_get_contents('php://input');
$sig_header = $_SERVER['HTTP_CD_SIGNATURE'];
$endpoint_secret = 'whsec_live_example12345';

// Calculate expected hash
$expected_hash = hash_hmac('sha256', $payload, $endpoint_secret);

if (hash_equals($expected_hash, $sig_header)) {
    http_response_code(200);
    // Process the verified event (e.g., room.executed)
} else {
    http_response_code(400);
    exit('Invalid Cryptographic Signature');
}