Create a document field (percent-of-page geometry)

Place a signature or data field on a draft document. Coordinates are percent-of-page (0–100), matching the web editor. Optional binding_key enables later POST /documents/apply-bindings.

POST/documents/fields

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.

Request body

requiredapplication/json

idstringrequired

field_typestringrequired

Allowed:signaturetextnumberdatecheckboxdropdownradioattachmentpayment

labelstringrequired

is_requiredboolean

pageintegerrequired

xnumberrequired

ynumberrequired

widthnumberrequired

heightnumberrequired

recipient_idstring

binding_keystring

propertiesobject

Responses

201

Created

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

Bodyapplication/json

Request body

Request

curl -X POST "https://api.seal.nyc/api/v1/documents/fields" \
  -H "Authorization: Bearer YOUR_TOKEN" \
  -H "Content-Type: application/json" \
  -d '{
  "id": "string",
  "field_type": "signature",
  "label": "string",
  "is_required": true,
  "page": 0,
  "x": 0,
  "y": 0,
  "width": 0,
  "height": 0,
  "recipient_id": "string",
  "binding_key": "string",
  "properties": {}
}'

const response = await fetch("https://api.seal.nyc/api/v1/documents/fields", {
  method: "POST",
  headers: {
    "Authorization": "Bearer YOUR_TOKEN",
    "Content-Type": "application/json"
  },
  body: "{\n  \"id\": \"string\",\n  \"field_type\": \"signature\",\n  \"label\": \"string\",\n  \"is_required\": true,\n  \"page\": 0,\n  \"x\": 0,\n  \"y\": 0,\n  \"width\": 0,\n  \"height\": 0,\n  \"recipient_id\": \"string\",\n  \"binding_key\": \"string\",\n  \"properties\": {}\n}"
});

import requests

response = requests.post(
    "https://api.seal.nyc/api/v1/documents/fields",
    headers={
        "Authorization": "Bearer YOUR_TOKEN",
        "Content-Type": "application/json"
    },
    data="{\n  \"id\": \"string\",\n  \"field_type\": \"signature\",\n  \"label\": \"string\",\n  \"is_required\": true,\n  \"page\": 0,\n  \"x\": 0,\n  \"y\": 0,\n  \"width\": 0,\n  \"height\": 0,\n  \"recipient_id\": \"string\",\n  \"binding_key\": \"string\",\n  \"properties\": {}\n}",
)

Response

Created

{
  "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"
}