# Request file signatures

Send an uploaded PDF to named recipients for signature. Each recipient receives a private link and gives their own consent. Brigg preserves the original PDF and prepares a signed archive when everyone has signed.

POST https://api.brigg.app/v1/operations/signing.RequestFileSignatures

## Access & visibility

Allow `signing.RequestFileSignatures` on your API key.

**Workspace access by default.** Private member data requires [approved member delegation](https://developer.brigg.app/authentication#member-delegation) through `Brigg-Act-As`; the key supplies permissions while private ownership and project boundaries remain enforced.

[Set up authentication](https://developer.brigg.app/authentication) · [Choose permissions](https://developer.brigg.app/permissions)

## Request fields

Send a JSON object with the following fields. Required fields must be included; omit optional fields you do not need.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `file_id` | string | Yes | Use a file_id returned by this listing or by CompleteUpload. It is not an upload ID, storage path or filename. [documents.ListDocuments](https://developer.brigg.app/reference/documents/ListDocuments). At least 1 character. |
| `title` | string | Yes | Display title. At least 1 character. At most 200 characters. |
| `signers` | array of [object](#request-signers) | Yes | Named recipients and their individual signature states. At least 1 item. |
| `expires_at` | integer | No | Signing deadline in Unix milliseconds. |
| `message` | string | No | Message sent to the signature recipients with their invitation. At most 2000 characters. |
| `signature_method` | string | No | Signature method required for the request. Allowed: `"standard"`, `"bankid"`. Default: `"standard"`. |

### request.signers[]

| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `email` | string | Yes | Email address. Format: email. |
| `name` | string | No | The recipient's display name. Uses their account name or email when omitted. At most 120 characters. |

## Follow one signing request through completion

[Upload a readable PDF](https://developer.brigg.app/files), then [request signatures](https://developer.brigg.app/reference/signing/RequestFileSignatures) and keep `signing_request_id`. The request keeps a fixed source; replacing the original file later does not change what recipients sign.

Read [Get signing request](https://developer.brigg.app/reference/signing/GetSigningRequest) for per-recipient progress. `completed` means everyone signed, but the archive can still be preparing: wait for non-null `file_id` before requesting the signed PDF. [Get signing document](https://developer.brigg.app/reference/signing/GetSigningDocument) returns a short-lived URL for either the fixed original or the signed archive.

Notification failures do not undo the signing request. Remind the affected pending recipients instead of creating a duplicate request. Recipients sign themselves; a delegated API call cannot supply a recipient's signature. See the [complete signing workflow](https://developer.brigg.app/signing).

## Response

Returns **200 OK** with a JSON body.
| Field | Type | Required | Description |
| --- | --- | --- | --- |
| `signing_request_id` | string | Yes | Signing request identifier. |
| `status` | string | Yes | Current signing request or recipient state. A completed request may still be preparing its signed PDF. Allowed: `"pending"`. |
| `invitation_failures` | array of string | Yes | Recipient email addresses whose invitation was not delivered. The request exists; use RemindSigners to retry delivery. |

## Errors & retries

Set `BRIGG_REQUEST_ID` once for each logical action. The samples send it as `Idempotency-Key`. Reuse the same value and body on retries, including after a timeout; a missing response does not prove the action failed.

For rate limits, follow the server’s retry guidance and back off. See [HTTP errors](https://developer.brigg.app/http#errors) and [safe retries and limits](https://developer.brigg.app/reliability).

| HTTP status | Code | What to do |
| --- | --- | --- |
| 400 | `invalid_json` | Send a JSON object with Content-Type: application/json. |
| 400 | `invalid_input` | Check the request fields and types. Supply a stable Idempotency-Key containing 1–200 characters. |
| 401 | `invalid_key` | The workspace API key is missing, invalid or revoked. |
| 403 | `forbidden` | Check the key’s operation and resource grants. If Brigg-Act-As is supplied, the key must be authorized to delegate to that member. |
| 404 | `not_found` | The requested operation or resource is not available to this credential. |
| 429 | `rate_limited` | Wait for Retry-After before retrying. Reuse the original Idempotency-Key. |
| 422 | `pdf_required` | Upload a PDF before requesting signatures. |
| 422 | `invalid_pdf` | Upload a readable PDF without password encryption. |
| 402 | `insufficient_credits` | BankID requires sufficient workspace credit. Refill credit before retrying. |
| 503 | `bankid_not_configured` | BankID is not configured for this environment. Use an available signing method or contact support. |

## Next steps

- [Get signing request](https://developer.brigg.app/reference/signing/GetSigningRequest)
- [Get signing document](https://developer.brigg.app/reference/signing/GetSigningDocument)
- [Remind signers](https://developer.brigg.app/reference/signing/RemindSigners)
- [Send a document for signing](https://developer.brigg.app/signing)
- [List documents](https://developer.brigg.app/reference/documents/ListDocuments)

[Download OpenAPI](https://developer.brigg.app/openapi.json) · [Versioning & retirement](https://developer.brigg.app/versioning)

## Examples

### Example request

Fictional values. Replace IDs and business details with values from your workspace.
#### cURL


```sh
curl 'https://api.brigg.app/v1/operations/signing.RequestFileSignatures' \
  -H "Authorization: Bearer $BRIGG_API_KEY" \
  -H 'Content-Type: application/json' \
  -H "Idempotency-Key: $BRIGG_REQUEST_ID" \
  --data-raw '{
  "file_id": "f_example",
  "title": "Consulting agreement",
  "signers": [
    {
      "email": "alex@example.com",
      "name": "Alex Morgan"
    }
  ],
  "signature_method": "standard",
  "message": "Please review and sign our agreement."
}'
```

#### TypeScript


```typescript
const requestId = process.env.BRIGG_REQUEST_ID;
if (!requestId) throw new Error("Set BRIGG_REQUEST_ID once per action and reuse it on retries.");

const response = await fetch("https://api.brigg.app/v1/operations/signing.RequestFileSignatures", {
  method: "POST",
  headers: {
    Authorization: `Bearer ${process.env.BRIGG_API_KEY}`,
    "Content-Type": "application/json",
    "Idempotency-Key": requestId, // Create once per action; reuse on retries.
  },
  body: JSON.stringify({
    "file_id": "f_example",
    "title": "Consulting agreement",
    "signers": [
      {
        "email": "alex@example.com",
        "name": "Alex Morgan"
      }
    ],
    "signature_method": "standard",
    "message": "Please review and sign our agreement."
  }),
});
const result = await response.json();
if (!response.ok) throw new Error(`${response.status}: ${result.error} — ${result.message}`);
console.log(result);
```

#### Python


```python
import json
import os
from urllib.request import Request, urlopen
from urllib.error import HTTPError

request_id = os.environ["BRIGG_REQUEST_ID"]  # Reuse for retries of this action.
payload = {
  "file_id": "f_example",
  "title": "Consulting agreement",
  "signers": [
    {
      "email": "alex@example.com",
      "name": "Alex Morgan"
    }
  ],
  "signature_method": "standard",
  "message": "Please review and sign our agreement."
}
request = Request(
    "https://api.brigg.app/v1/operations/signing.RequestFileSignatures",
    data=json.dumps(payload).encode("utf-8"),
    headers={
        "Authorization": f"Bearer {os.environ['BRIGG_API_KEY']}",
        "Content-Type": "application/json",
        "Idempotency-Key": request_id,  # Create once per action; reuse on retries.
    },
    method="POST",
)
try:
    with urlopen(request) as response:
        print(json.load(response))
except HTTPError as error:
    print(error.code, json.load(error))
    raise
```

#### Response example


```json
{
  "signing_request_id": "sig_example",
  "status": "pending",
  "invitation_failures": []
}
```

## JSON schemas


```json-schema-request
{
  "type": "object",
  "properties": {
    "file_id": {
      "type": "string",
      "minLength": 1,
      "description": "Use a file_id returned by this listing or by CompleteUpload. It is not an upload ID, storage path or filename. [documents.ListDocuments](https://developer.brigg.app/reference/documents/ListDocuments)."
    },
    "title": {
      "type": "string",
      "minLength": 1,
      "maxLength": 200,
      "description": "Display title."
    },
    "signers": {
      "type": "array",
      "items": {
        "type": "object",
        "properties": {
          "email": {
            "type": "string",
            "format": "email",
            "description": "Email address."
          },
          "name": {
            "type": "string",
            "maxLength": 120,
            "description": "The recipient's display name. Uses their account name or email when omitted."
          }
        },
        "required": [
          "email"
        ],
        "additionalProperties": false
      },
      "minItems": 1,
      "description": "Named recipients and their individual signature states."
    },
    "expires_at": {
      "type": "integer",
      "description": "Signing deadline in Unix milliseconds."
    },
    "message": {
      "type": "string",
      "maxLength": 2000,
      "description": "Message sent to the signature recipients with their invitation."
    },
    "signature_method": {
      "type": "string",
      "enum": [
        "standard",
        "bankid"
      ],
      "default": "standard",
      "description": "Signature method required for the request."
    }
  },
  "required": [
    "file_id",
    "title",
    "signers"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "file_id": "f_example",
      "title": "Consulting agreement",
      "signers": [
        {
          "email": "alex@example.com",
          "name": "Alex Morgan"
        }
      ],
      "signature_method": "standard",
      "message": "Please review and sign our agreement."
    }
  ]
}
```


```json-schema-response
{
  "type": "object",
  "properties": {
    "signing_request_id": {
      "type": "string",
      "description": "Signing request identifier."
    },
    "status": {
      "type": "string",
      "enum": [
        "pending"
      ],
      "description": "Current signing request or recipient state. A completed request may still be preparing its signed PDF."
    },
    "invitation_failures": {
      "type": "array",
      "items": {
        "type": "string"
      },
      "description": "Recipient email addresses whose invitation was not delivered. The request exists; use RemindSigners to retry delivery."
    }
  },
  "required": [
    "signing_request_id",
    "status",
    "invitation_failures"
  ],
  "additionalProperties": false,
  "examples": [
    {
      "signing_request_id": "sig_example",
      "status": "pending",
      "invitation_failures": []
    }
  ]
}
```