> This page is for Paperwork API, version v1 (default).
> For other versions, use one of these documentation indexes:
> - v1 (default): https://docs.cloudraker.com/paperwork/v1/llms.txt

> For clean Markdown of any page, append .md to the page URL.
> For a complete documentation index, see https://docs.cloudraker.com/llms.txt.
> For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://docs.cloudraker.com/_mcp/server.

# Collect e-signatures on a document

POST https://api.cloudraker.com/v1/sign
Content-Type: application/json

Sends a PDF out for signature and tracks the envelope until every required signing slot is complete.

Each signer verifies their email with a one-time code and signs by typing their name. The completed document gets a signature certificate and a tamper-evident cryptographic seal, and comes back as a new file alongside `output.auditUrl`.

**Where the signatures land** — `placement`:

* `page` (default) — a signature certificate page is appended to the document.
* `tags` — each required signing slot replaces a `[Signature N]` placeholder. Optional initials and date tags use the same slot number.

**Signing steps** — `routingOrder` defaults to 1 (parallel signing). Later steps wait. People with the same `signingGroup` share one `fieldIndex` slot; the first to sign completes it.

**Keeping others in the loop** — `cc`: informed-only recipients who do not sign. They receive no OTP or signature tag, and are emailed the sealed document when the envelope completes.

**Language** — `language`: `en` (default) or `fr`. Sets the language of every recipient-facing asset — invitation and code emails, the signing page, and the audit certificate — for all signers and CC parties.

**Always asynchronous.** The call returns `202` with `status: "needs_input"` as soon as the envelope exists, and stays there until every required signing slot completes.

**Managing the envelope** — every sign response, both the `202` and [the run](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run), carries `envelopeUrl`:

* [GET /v1/runs/\{id}/envelope](https://docs.cloudraker.com/api/cloud-raker-api/runs/get-run-envelope) — roster and per-signer state.
* [POST /v1/runs/\{id}/signers/\{signerId}/resend](https://docs.cloudraker.com/api/cloud-raker-api/runs/resend-run-signer) — issue a fresh link.
* [POST /v1/runs/\{id}/void](https://docs.cloudraker.com/api/cloud-raker-api/runs/void-run-envelope) — kill every pending link.

```json
{
  "file": { "id": "a04d6597-4e34-4a99-94ea-964c289a4c68" },
  "signers": [{ "name": "Ada Lovelace", "email": "ada@example.com" }],
  "cc": [{ "name": "Charles Babbage", "email": "charles@example.com" }],
  "message": "Please countersign by Friday.",
  "placement": "page",
  "language": "en"
}
```

Sign runs are exempt from the run TTL, so an envelope outlives the 7-day maximum and waits for its signers. Signing links are signer-held secrets and never appear on the sender's API.

**Learn more:** [E-signature guide](https://docs.cloudraker.com/capabilities/sign)

Reference: https://docs.cloudraker.com/paperwork/api/capabilities/sign

## Authentication

- `Authorization` header (bearer token, required) — Bearer authentication of the form `Bearer <token>`, where token is your auth token.

## Request

### Query parameters

- `wait` (integer, optional, default: 60) — How many seconds to hold the request open waiting for the run to finish. Finishing inside the window returns `200` with the full run; running past it returns `202` with a `statusUrl` to poll. Send `0` to skip waiting entirely and always get the `202`.

### Body (application/json)

This endpoint expects a V1SignBody.

- `signers` (list of V1SignBodySignersItems, required) — Who can sign — up to 50 people, each with a `name` and an `email`. Omitted `routingOrder` means everyone signs in parallel. Set increasing steps for ordered signing; use a shared `signingGroup` for any-one signing. Every signer verifies their email with a one-time code, then signs by typing their name. Track them individually at `GET /v1/runs/{id}/envelope`.
- `file` (V1SignBodyFile, required) — An input file, given one of two ways. * `{ "url": "…", "name"?: "…", "processing"?: "…" }` — fetched over http(s) for this run and purged with it. * `{ "id": "…" }` — a file you already registered with `POST /v1/files`, reusable across runs and never re-parsed. * `{ "id": "…", "ephemeral": true }` — a file you uploaded only for this run, purged with it. Use it only on a file no other run uses.
- `expiresInDays` (integer, optional, default: 7) — Days recipients have to complete signing, measured from dispatch. From 1 to 90; defaults to 7.
- `templateId` (string, optional) — Identifies the template your org signs delegated envelopes from. Consent is granted per template, so this is the scope the signer agrees to. A document produced by `POST /v1/compose` or `POST /v1/fill` carries its template sealed inside it and that value is used; this field is then ignored. Send it only for a delegated envelope whose document has no sealed template. Ignored when no signer is `delegated`.
- `templateName` (string, optional) — Human-readable name of that template. Shown to the signer when their consent is requested, and printed on the audit page of every document signed under it. Like `templateId`, the value sealed into a composed or filled document wins. Required when any `signers[]` entry has `delegated: true` and the document carries no sealed template name: either the document has no seal, or its seal has no name. In the second case, also send the sealed `templateId`, or the run fails. Ignored otherwise.
- `message` (string, optional) — A note included in the invitation email each signer receives.
- `placement` (enum, optional, default: page) — Where signatures land in the document. `page` appends a signature certificate page. `tags` replaces `[Signature N]` placeholders for each required signing slot. Optional `[Initials N]` and `[Date N]` tags add initials and signing dates. Any-one groups share their `fieldIndex` slot.
  - Allowed values: `page`, `tags`
- `cc` (list of V1SignBodyCcItems, optional) — Informed-only recipients. CC parties do not sign, receive no OTP or signature tag, and are emailed the sealed document when the envelope completes.
- `language` (enum, optional, default: en) — Language of every recipient-facing asset — invitation and code emails, the signing page, and the audit certificate. Applies to all signers and CC parties. Defaults to en.
  - Allowed values: `en`, `fr`
- `metadata` (map from string to any, optional) — Arbitrary JSON you attach to the run and get back on every read of it. Use it to carry your own identifiers — an order number, a customer id — so a webhook or a polled run reconciles without a lookup table. Capped at 10 KB serialized.
- `webhook` (V1SignBodyWebhook, optional) — Where to deliver this run's events, given one of two ways. * `{ "url": "…" }` — a one-off https endpoint for this run only. * `{ "id": "whe_…" }` — a saved endpoint from `POST /v1/webhooks`. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too. Deliveries are at-least-once and signed — dedupe on `eventId` and verify against `GET /v1/webhooks/jwks.json`.
- `ttl` (integer, optional, default: 86400) — How long, in seconds, to keep this run and its files before purging them automatically. The maximum is 604800 (7 days). The deadline comes back as `expiresAt` on every read of the run. Call `POST /v1/runs/{id}/keep` before then to clear the TTL and move the results into a space permanently. E-signature runs are exempt — an envelope waits for its signers however long that takes.

## Response

### 200

The finished run.

- `object` ("sign_run", required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Waiting for an external action, such as an e-signature | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `expiresAt` (string, required, nullable)
- `statusUrl` (string, required)
- `files` (list of V1SignRunFilesItems, required)
- `envelopeUrl` (string, required)
- `file` (V1SignRunFile, optional)
- `error` (V1SignRunError, optional) — Why the run failed. Present whenever `status` is `failed`, and only then. `code` is the stable, snake_case reason (`input_unavailable`, `parse_failed`, …); `message` is the human-readable detail. Per-file and per-step failures are also reported in `files[].error` and, for a pipeline, `steps[].error`.
- `metadata` (map from string to any, optional)
- `output` (V1SignRunOutput, optional) — The signed document. Present once every required signing slot has completed. `file` is the sealed PDF, `signers[]` records who signed and when, and `auditUrl` points at the machine-readable audit trail.

### 202

Accepted — still running, or awaiting human input.

- `object` (string, required)
- `id` (string, required)
- `status` (enum, required) — Where the run is in its life. | Status | Meaning | | --- | --- | | `queued` | Accepted, not started | | `processing` | Work in flight | | `needs_input` | Waiting for an external action, such as an e-signature | | `processed` | Finished; `output` is populated | | `failed` | Finished unsuccessfully | | `cancelled` | Stopped on request | | `expired` | TTL elapsed and the data was purged | The last four are terminal.
  - Allowed values: `queued`, `processing`, `processed`, `failed`, `cancelled`, `expired`, `needs_input`
- `statusUrl` (string, required)
- `envelopeUrl` (string, optional)

## Errors

### 400 Bad Request Error

Invalid request (`invalid_request` / `invalid_schema`).

- `any`

### 422 Unprocessable Entity Error

Unusable input file or webhook endpoint.

- `any`

### 429 Too Many Requests Error

Rate limited. The `/v1` API allows at least **67 requests per minute per organization** (about 1,000 requests per 15 minutes) — a guaranteed floor, enforced per edge location, so a geographically spread caller may get more. Wait for the `Retry-After` interval and retry — the error is `retryable`.

- `code` (enum, required)
  - Allowed values: `rate_limited`
- `message` (string, required)
- `retryable` (boolean, required)
- `requestId` (string, required)
- `docUrl` (string, optional)

## Types

### V1SignBodySignersItems

- `name` (string, required)
- `email` (string, required)
- `delegated` (boolean, optional, default: false) — True if your organization signs on this person’s behalf instead of them signing directly. Requires the e-signature-delegation entitlement and `templateId`. Ignored on `cc`.
- `routingOrder` (integer, optional, default: 1) — Signing step. People in the same step sign in parallel; later steps wait.
- `signingGroup` (string, optional) — People with the same group share one signing slot. The first to sign completes it.
- `fieldIndex` (integer, optional) — Document tag number. A group shares one number; otherwise defaults to roster position.

### V1SignBodyFile

An input file, given one of two ways. * `{ "url": "…", "name"?: "…", "processing"?: "…" }` — fetched over http(s) for this run and purged with it. * `{ "id": "…" }` — a file you already registered with `POST /v1/files`, reusable across runs and never re-parsed. * `{ "id": "…", "ephemeral": true }` — a file you uploaded only for this run, purged with it. Use it only on a file no other run uses.

- V1SignBodyFile0
- V1SignBodyFile1

### V1SignBodyCcItems

- `name` (string, required)
- `email` (string, required)
- `delegated` (boolean, optional, default: false) — True if your organization signs on this person’s behalf instead of them signing directly. Requires the e-signature-delegation entitlement and `templateId`. Ignored on `cc`.

### V1SignBodyWebhook

Where to deliver this run's events, given one of two ways. * `{ "url": "…" }` — a one-off https endpoint for this run only. * `{ "id": "whe_…" }` — a saved endpoint from `POST /v1/webhooks`. Runs hold the reference, so pausing or re-pointing that endpoint applies to this run too. Deliveries are at-least-once and signed — dedupe on `eventId` and verify against `GET /v1/webhooks/jwks.json`.

- V1SignBodyWebhook0
- V1SignBodyWebhook1

### V1SignRunFilesItems

- `id` (string, required)
- `name` (string, required)
- `status` (string, required)
- `error` (string, optional)

### V1SignRunFile

- `id` (string, required)
- `name` (string, required)
- `status` (string, required)
- `error` (string, optional)

### V1SignRunError

Why the run failed. Present whenever `status` is `failed`, and only then. `code` is the stable, snake_case reason (`input_unavailable`, `parse_failed`, …); `message` is the human-readable detail. Per-file and per-step failures are also reported in `files[].error` and, for a pipeline, `steps[].error`.

- `code` (string, required)
- `message` (string, required)

### V1SignRunOutput

The signed document. Present once every required signing slot has completed. `file` is the sealed PDF, `signers[]` records who signed and when, and `auditUrl` points at the machine-readable audit trail.

- `files` (list of V1SignRunOutputFilesItems, required)
- `file` (V1SignRunOutputFile, optional)
- `envelopeId` (string, optional)
- `signers` (list of V1SignRunOutputSignersItems, optional)
- `cc` (list of V1SignRunOutputCcItems, optional)
- `auditUrl` (string, optional)

### V1SignBodyFile0

- `url` (string, required)
- `name` (string, optional)
- `processing` (enum, optional)
  - Allowed values: `auto`, `ocr`, `simple`, `transcribe`, `transcribe_diarize`

### V1SignBodyFile1

- `id` (string, required)
- `ephemeral` (boolean, optional) — Purge this file with the run (TTL expiry or `DELETE /v1/runs/{id}`), unless you `keep` the run. API workspace only: ignored under `/v1/spaces/{spaceId}/…`.

### V1SignBodyWebhook0

- `url` (string, required)

### V1SignBodyWebhook1

- `id` (string, required)

### V1SignRunOutputFilesItems

- `id` (string, required)
- `name` (string, required)
- `url` (string, optional)

### V1SignRunOutputFile

- `id` (string, required)
- `name` (string, required)
- `url` (string, optional)

### V1SignRunOutputSignersItems

- `name` (string, required)
- `email` (string, required)
- `signedAt` (string, optional)

### V1SignRunOutputCcItems

- `name` (string, required)
- `email` (string, required)

## Examples

### Example 1

**Request**

```json
{
  "signers": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "file": {
    "url": "string"
  }
}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "expiresAt": "string",
  "statusUrl": "string",
  "files": [
    {
      "id": "string",
      "name": "string",
      "status": "string",
      "error": "string"
    }
  ],
  "envelopeUrl": "string",
  "file": {
    "id": "string",
    "name": "string",
    "status": "string",
    "error": "string"
  },
  "error": {
    "code": "string",
    "message": "string"
  },
  "metadata": {},
  "output": {
    "files": [
      {
        "id": "string",
        "name": "string",
        "url": "string"
      }
    ],
    "file": {
      "id": "string",
      "name": "string",
      "url": "string"
    },
    "envelopeId": "string",
    "signers": [
      {
        "name": "string",
        "email": "string",
        "signedAt": "string"
      }
    ],
    "cc": [
      {
        "name": "string",
        "email": "string"
      }
    ],
    "auditUrl": "string"
  }
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/sign"

payload = {
    "signers": [
        {
            "name": "string",
            "email": "string"
        }
    ],
    "file": { "url": "string" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/sign';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"signers":[{"name":"string","email":"string"}],"file":{"url":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/sign"

	payload := strings.NewReader("{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/v1/sign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/v1/sign")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/sign', [
  'body' => '{
  "signers": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "file": {
    "url": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/sign");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "signers": [
    [
      "name": "string",
      "email": "string"
    ]
  ],
  "file": ["url": "string"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/sign")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```

### Example 2

**Request**

```json
{
  "signers": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "file": {
    "url": "string"
  }
}
```

**Response**

```json
{
  "object": "string",
  "id": "string",
  "status": "queued",
  "statusUrl": "string",
  "envelopeUrl": "string"
}
```

**SDK Code**

```python
import requests

url = "https://api.cloudraker.com/v1/sign"

payload = {
    "signers": [
        {
            "name": "string",
            "email": "string"
        }
    ],
    "file": { "url": "string" }
}
headers = {
    "Authorization": "Bearer <token>",
    "Content-Type": "application/json"
}

response = requests.post(url, json=payload, headers=headers)

print(response.json())
```

```javascript
const url = 'https://api.cloudraker.com/v1/sign';
const options = {
  method: 'POST',
  headers: {Authorization: 'Bearer <token>', 'Content-Type': 'application/json'},
  body: '{"signers":[{"name":"string","email":"string"}],"file":{"url":"string"}}'
};

try {
  const response = await fetch(url, options);
  const data = await response.json();
  console.log(data);
} catch (error) {
  console.error(error);
}
```

```go
package main

import (
	"fmt"
	"strings"
	"net/http"
	"io"
)

func main() {

	url := "https://api.cloudraker.com/v1/sign"

	payload := strings.NewReader("{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}")

	req, _ := http.NewRequest("POST", url, payload)

	req.Header.Add("Authorization", "Bearer <token>")
	req.Header.Add("Content-Type", "application/json")

	res, _ := http.DefaultClient.Do(req)

	defer res.Body.Close()
	body, _ := io.ReadAll(res.Body)

	fmt.Println(res)
	fmt.Println(string(body))

}
```

```ruby
require 'uri'
require 'net/http'

url = URI("https://api.cloudraker.com/v1/sign")

http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true

request = Net::HTTP::Post.new(url)
request["Authorization"] = 'Bearer <token>'
request["Content-Type"] = 'application/json'
request.body = "{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}"

response = http.request(request)
puts response.read_body
```

```java
import com.mashape.unirest.http.HttpResponse;
import com.mashape.unirest.http.Unirest;

HttpResponse<String> response = Unirest.post("https://api.cloudraker.com/v1/sign")
  .header("Authorization", "Bearer <token>")
  .header("Content-Type", "application/json")
  .body("{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}")
  .asString();
```

```php
<?php
require_once('vendor/autoload.php');

$client = new \GuzzleHttp\Client();

$response = $client->request('POST', 'https://api.cloudraker.com/v1/sign', [
  'body' => '{
  "signers": [
    {
      "name": "string",
      "email": "string"
    }
  ],
  "file": {
    "url": "string"
  }
}',
  'headers' => [
    'Authorization' => 'Bearer <token>',
    'Content-Type' => 'application/json',
  ],
]);

echo $response->getBody();
```

```csharp
using RestSharp;

var client = new RestClient("https://api.cloudraker.com/v1/sign");
var request = new RestRequest(Method.POST);
request.AddHeader("Authorization", "Bearer <token>");
request.AddHeader("Content-Type", "application/json");
request.AddParameter("application/json", "{\n  \"signers\": [\n    {\n      \"name\": \"string\",\n      \"email\": \"string\"\n    }\n  ],\n  \"file\": {\n    \"url\": \"string\"\n  }\n}", ParameterType.RequestBody);
IRestResponse response = client.Execute(request);
```

```swift
import Foundation

let headers = [
  "Authorization": "Bearer <token>",
  "Content-Type": "application/json"
]
let parameters = [
  "signers": [
    [
      "name": "string",
      "email": "string"
    ]
  ],
  "file": ["url": "string"]
] as [String : Any]

let postData = JSONSerialization.data(withJSONObject: parameters, options: [])

let request = NSMutableURLRequest(url: NSURL(string: "https://api.cloudraker.com/v1/sign")! as URL,
                                        cachePolicy: .useProtocolCachePolicy,
                                    timeoutInterval: 10.0)
request.httpMethod = "POST"
request.allHTTPHeaderFields = headers
request.httpBody = postData as Data

let session = URLSession.shared
let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in
  if (error != nil) {
    print(error as Any)
  } else {
    let httpResponse = response as? HTTPURLResponse
    print(httpResponse)
  }
})

dataTask.resume()
```