API Documentation

curl -X POST https://api.agreements.ai/v1/documents \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Consulting Agreement",
    "content": "<h1>Consulting Agreement</h1><p>This Consulting Agreement (\"Agreement\") is entered into as of {{date}} by and between {{client_name}} (\"Client\") and {{consultant_name}} (\"Consultant\").</p><h2>1. Services</h2><p>Consultant shall provide the services described in Exhibit A attached hereto.</p><h2>2. Compensation</h2><p>Client shall pay Consultant a fee of ${{amount}} per hour for services rendered.</p><h2>3. Term</h2><p>This Agreement shall commence on {{start_date}} and continue for a period of {{term_months}} months.</p><p>IN WITNESS WHEREOF, the parties have executed this Agreement:</p><p>Client: ___________________________</p><p>Consultant: ___________________________</p>"
  }'

{
  "id": "doc_7kXm2pQ9",
  "title": "Consulting Agreement",
  "createdAt": "2026-02-12T10:00:00Z",
  "updatedAt": "2026-02-12T10:00:00Z",
  "wordCount": 156,
  "status": "draft"
}

curl -X POST https://api.agreements.ai/v1/envelopes \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "documentId": "doc_7kXm2pQ9",
    "name": "Consulting Agreement — Jane Smith",
    "message": "Hi Jane, please review and sign the attached consulting agreement.",
    "signers": [
      {
        "name": "Jane Smith",
        "email": "[email protected]",
        "role": "signer",
        "order": 1
      },
      {
        "name": "Bob Johnson",
        "email": "[email protected]",
        "role": "signer",
        "order": 2
      }
    ],
    "fields": [
      { "type": "signature", "signerEmail": "[email protected]", "page": 1, "x": 72, "y": 680, "width": 200, "height": 50 },
      { "type": "date", "signerEmail": "[email protected]", "page": 1, "x": 300, "y": 695, "width": 120, "height": 20 },
      { "type": "signature", "signerEmail": "[email protected]", "page": 1, "x": 72, "y": 740, "width": 200, "height": 50 },
      { "type": "date", "signerEmail": "[email protected]", "page": 1, "x": 300, "y": 755, "width": 120, "height": 20 }
    ],
    "settings": {
      "reminderDays": 3,
      "expirationDays": 30
    }
  }'

{
  "id": "env_Qr8sT4kL",
  "name": "Consulting Agreement — Jane Smith",
  "status": "sent",
  "documentId": "doc_7kXm2pQ9",
  "createdAt": "2026-02-12T10:01:00Z",
  "sentAt": "2026-02-12T10:01:00Z",
  "expiresAt": "2026-03-14T10:01:00Z",
  "signers": [
    {
      "id": "sig_A1b2C3",
      "name": "Jane Smith",
      "email": "[email protected]",
      "role": "signer",
      "order": 1,
      "status": "pending"
    },
    {
      "id": "sig_D4e5F6",
      "name": "Bob Johnson",
      "email": "[email protected]",
      "role": "signer",
      "order": 2,
      "status": "pending"
    }
  ]
}

curl https://api.agreements.ai/v1/envelopes/env_Qr8sT4kL \
  -H "Authorization: Bearer sk_live_abc123"

curl https://api.agreements.ai/v1/envelopes/env_Qr8sT4kL/document \
  -H "Authorization: Bearer sk_live_abc123" \
  -o signed_consulting_agreement.pdf

curl https://api.agreements.ai/v1/templates \
  -H "Authorization: Bearer sk_live_abc123"

{
  "data": [
    {
      "id": "tpl_NdA9Kx",
      "title": "Non-Disclosure Agreement",
      "category": "Business",
      "variables": ["party_a_name", "party_b_name", "effective_date", "duration_months"],
      "createdAt": "2026-01-15T08:00:00Z"
    },
    {
      "id": "tpl_Srv3Mx",
      "title": "Service Agreement",
      "category": "Services",
      "variables": ["client_name", "provider_name", "scope", "hourly_rate", "start_date"],
      "createdAt": "2026-01-20T12:00:00Z"
    }
  ],
  "total": 374,
  "page": 1,
  "pageSize": 20
}

curl -X POST https://api.agreements.ai/v1/templates/tpl_NdA9Kx/use \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "variables": {
      "party_a_name": "Acme Corporation",
      "party_b_name": "Jane Smith",
      "effective_date": "February 12, 2026",
      "duration_months": "24"
    }
  }'

{
  "id": "doc_Pm4nR7",
  "title": "Non-Disclosure Agreement",
  "templateId": "tpl_NdA9Kx",
  "createdAt": "2026-02-12T10:05:00Z",
  "status": "draft"
}

curl -X POST https://api.agreements.ai/v1/envelopes \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "documentId": "doc_Pm4nR7",
    "name": "NDA — Jane Smith",
    "signers": [
      { "name": "Jane Smith", "email": "[email protected]", "role": "signer" }
    ],
    "fields": [
      { "type": "signature", "signerEmail": "[email protected]", "page": 1, "x": 72, "y": 700, "width": 200, "height": 50 }
    ]
  }'

curl -X POST https://api.agreements.ai/v1/webhooks \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "url": "https://your-app.com/webhooks/agreements",
    "events": [
      "envelope.sent",
      "envelope.completed",
      "envelope.voided",
      "envelope.declined",
      "signer.completed",
      "signer.declined"
    ],
    "secret": "whsec_your_webhook_secret_key"
  }'

{
  "id": "wh_Kj9mN2",
  "url": "https://your-app.com/webhooks/agreements",
  "events": ["envelope.sent", "envelope.completed", "envelope.voided", "envelope.declined", "signer.completed", "signer.declined"],
  "active": true,
  "createdAt": "2026-02-12T10:10:00Z"
}

const express = require('express');
const crypto = require('crypto');
const app = express();

app.use('/webhooks/agreements', express.raw({ type: 'application/json' }));

app.post('/webhooks/agreements', (req, res) => {
  // 1. Verify signature
  const signature = req.headers['x-agreements-signature'];
  const expected = crypto
    .createHmac('sha256', process.env.WEBHOOK_SECRET)
    .update(req.body)
    .digest('hex');

  if (!crypto.timingSafeEqual(Buffer.from(signature), Buffer.from(expected))) {
    return res.status(401).send('Invalid signature');
  }

  // 2. Parse and handle event
  const event = JSON.parse(req.body);

  switch (event.event) {
    case 'envelope.completed':
      console.log(`Envelope ${event.data.envelopeId} completed!`);
      // Update your database, notify your team, trigger next steps...
      break;

    case 'signer.completed':
      console.log(`${event.data.signerName} signed envelope ${event.data.envelopeId}`);
      break;

    case 'envelope.declined':
      console.log(`Envelope ${event.data.envelopeId} declined: ${event.data.reason}`);
      // Alert sales team, follow up...
      break;
  }

  res.status(200).json({ received: true });
});

app.listen(3000);

const crypto = require('crypto');

function verifyWebhookSignature(rawBody, signature, secret) {
  const expected = crypto
    .createHmac('sha256', secret)
    .update(rawBody)
    .digest('hex');

  return crypto.timingSafeEqual(
    Buffer.from(signature, 'utf8'),
    Buffer.from(expected, 'utf8')
  );
}

// Usage:
const isValid = verifyWebhookSignature(req.body, req.headers['x-agreements-signature'], process.env.WEBHOOK_SECRET);
if (!isValid) return res.status(401).send('Invalid signature');

curl -X PUT https://api.agreements.ai/v1/envelopes/env_Qr8sT4kL/recipients \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "signers": [
      {
        "id": "sig_A1b2C3",
        "name": "Jane Smith-Williams",
        "email": "[email protected]"
      },
      {
        "name": "Carol Davis",
        "email": "[email protected]",
        "role": "cc"
      }
    ]
  }'

curl -X POST https://api.agreements.ai/v1/envelopes/env_Qr8sT4kL/remind \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{
    "message": "Friendly reminder: this agreement is awaiting your signature.",
    "signerIds": ["sig_D4e5F6"]
  }'

{
  "reminded": ["sig_D4e5F6"],
  "skipped": [],
  "message": "Reminder sent to 1 signer"
}

# Void the existing envelope
curl -X POST https://api.agreements.ai/v1/envelopes/env_Qr8sT4kL/void \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "reason": "Document updated with revised payment terms" }'

# Create a new envelope with the updated document
curl -X POST https://api.agreements.ai/v1/envelopes \
  -H "Authorization: Bearer sk_live_abc123" \
  -H "Content-Type: application/json" \
  -d '{ "documentId": "doc_Updated1", "name": "Revised Agreement", ... }'