Skip to main content
POST
/
sign
/
envelopes
/
{envelopeID}
/
documents
/
{documentID}
/
fields
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID}/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '
{
  "participantID": "3fa85f64-5717-4562-b3fc-2c963f66afa6",
  "page": 1,
  "boundingBox": [
    100,
    200,
    150,
    250
  ],
  "required": true,
  "type": "signature"
}
'
{
  "items": [
    {
      "ID": "987e6543-e21b-12d3-a456-426614174999",
      "participantID": "123e4567-e89b-12d3-a456-426614174000",
      "documentID": "456e7890-e12b-34d5-a678-426614175000",
      "page": 1,
      "boundingBox": [
        100,
        200,
        150,
        250
      ],
      "required": true,
      "type": "signature"
    },
    {
      "ID": "654e3210-e21b-12d3-a456-426614174888",
      "participantID": "123e4567-e89b-12d3-a456-426614174000",
      "documentID": "456e7890-e12b-34d5-a678-426614175000",
      "page": 1,
      "boundingBox": [
        200,
        300,
        150,
        50
      ],
      "required": false,
      "type": "date",
      "format": "MM/DD/YYYY",
      "modifiable": true
    }
  ]
}

Authorizations

​
Authorization
string
header
required

Bearer authentication header of the form Bearer <token>, where <token> is your auth token.

Path Parameters

​
envelopeID
string<uuid>
required

A unique string that identifies the envelope in the Nitro system.

​
documentID
string<uuid>
required

A unique string that identifies the document in the Nitro system.

Body

application/json

Field creation request. Can be a single field object or bulk with 'items' array. The type field determines which properties are required:

  • checkbox - Checkbox field
  • company - Company field
  • custom - Custom text field
  • date - Date field
  • initials - Initials field
  • name - Name field
  • signature - Signature field
  • title - Title field

Parameters to create a Checkbox field

​
boundingBox
number<float>[]
required

An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page:

  • x, y are the coordinates of the top-left corner, measured in points (pt).
  • w, h are the width and height of the bounding box, also in points (pt).

For more information on calculating positions, see the Bounding Box Guide.

Required array length: 4 elements
​
participantID
string<uuid>
required

The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.

​
type
enum<string>
required
Available options:
checkbox
​
page
integer<int32>

The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.

​
required
boolean

A boolean that indicates whether the participant must complete the field.

Response

Fields created successfully

Create Checkbox Field Response

​
type
enum<string>
required

Enum that specifies which type of information an eSignature participant is expected to fill in.

Available options:
signature,
name,
checkbox,
date,
initials,
company,
title,
custom
​
boundingBox
number<float>[]
required

An array of numbers in the format [x, y, w, h] that defines the field’s bounding box on the page:

  • x, y are the coordinates of the top-left corner, measured in points (pt).
  • w, h are the width and height of the bounding box, also in points (pt).

For more information on calculating positions, see the Bounding Box Guide.

Required array length: 4 elements
​
participantID
string<uuid>
required

The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role.

​
documentID
string<uuid>
required

ID of the document to which this field belongs.

​
page
integer<int32>

The page number where the field appears. Pages follow 1-based indexing, so the first page is 1.

​
required
boolean

A boolean that indicates whether the participant must complete the field.

​
ID
string<uuid>

Unique ID of the field