1. Create an API Client

Click Create Client above. You'll receive a client_id and client_secret. Save the secret — it's shown only once.

2. Authenticate

Include your credentials in every API request:

curl -X GET https://your-domain/api/v2/envelopes \
  -H "X-SF-Client-Id: your_client_id" \
  -H "X-SF-Client-Secret: your_client_secret"

3. Create & Send an Envelope

# Step 1: Create an envelope
curl -X POST https://your-domain/api/v2/envelopes \
  -H "X-SF-Client-Id: your_client_id" \
  -H "X-SF-Client-Secret: your_client_secret" \
  -H "Content-Type: application/json" \
  -d '{
    "title": "Sales Agreement",
    "recipients": [
      {"email": "signer@example.com", "name": "John Doe", "role": "signer"}
    ]
  }'

# Step 2: Upload the document PDF
curl -X POST https://your-domain/api/v2/envelopes/{id}/document \
  -H "X-SF-Client-Id: ..." -H "X-SF-Client-Secret: ..." \
  -F "file=@contract.pdf"

# Step 3: Send for signing
curl -X POST https://your-domain/api/v2/envelopes/{id}/send \
  -H "X-SF-Client-Id: ..." -H "X-SF-Client-Secret: ..."

4. Listen for Events

Register a webhook endpoint to receive real-time notifications:

curl -X POST https://your-domain/api/v2/webhooks/endpoints \
  -H "X-SF-Client-Id: ..." -H "X-SF-Client-Secret: ..." \
  -H "Content-Type: application/json" \
  -d '{"url": "https://your-app.com/webhook", "events": ["envelope.completed"]}'

Events: envelope.sent, recipient.signed, envelope.completed, recipient.viewed, attachment.uploaded, webhook.test

5. Sandbox Mode

Create a Sandbox client to test your integration without sending real emails. Sandbox envelopes go through the full flow but skip email delivery.