Add a recipient

Adds a recipient to a draft document.

POST/recipients

Authorization

AuthorizationBearer token · headerrequired

Pass your API key as a Bearer token. API keys are scoped to specific operations — configure scopes in your organization's Settings → Developer → API Keys.

Query parameters

document_idstringrequired

Request body

requiredapplication/json

emailstring<email>required

namestringrequired

roleRecipientRolerequired

signer — must provide a signature to complete the document
approver — must click Approve; no signature drawn
viewer — receives a copy but has no action required

Allowed:signerapproverviewer

orderinteger

Signing order position for sequential workflows

messagestring

Custom message for this recipient's invitation email

Responses

200

Recipient added

idstring

400

Invalid request parameters

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

401

Missing or invalid API key

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

404

Resource not found

typestringrequired

Machine-readable error code

statusintegerrequired

HTTP status code

titlestringrequired

Human-readable error message

detailsobject

Field-level validation errors

Try it

Server

Base URLCustom base URLOverrides the selected server when set.

Authorization

Bearer tokenRemember on this deviceInclude my values in samples

Parameters

document_idquery*

Bodyapplication/json

emailstring*namestring*rolestring*- `signer` — must provide a signature to complete the document - `approver` — must click Approve; no signature drawn - `viewer` — receives a copy but has no action required orderintegerSigning order position for sequential workflowsmessagestringCustom message for this recipient's invitation email

Request

curl -X POST "https://api.seal.nyc/api/v1/recipients?document_id=string" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "email": "jane@acme.com",
  "name": "Jane Smith",
  "role": "signer",
  "order": 1
}'

const response = await fetch("https://api.seal.nyc/api/v1/recipients?document_id=string", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"email\": \"jane@acme.com\",\n  \"name\": \"Jane Smith\",\n  \"role\": \"signer\",\n  \"order\": 1\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/recipients?document_id=string",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"email\": \"jane@acme.com\",\n  \"name\": \"Jane Smith\",\n  \"role\": \"signer\",\n  \"order\": 1\n}",
)

Response

{
  "id": "string"
}

{
  "type": "VALIDATION_ERROR",
  "status": 400,
  "title": "Validation failed",
  "details": {
    "email": [
      "Must be a valid email address"
    ]
  }
}

{
  "type": "AUTH_ERROR",
  "status": 401,
  "title": "Missing or invalid API key"
}

{
  "type": "NOT_FOUND",
  "status": 404,
  "title": "Document not found"
}