Skip to main content
POST
/
sign
/
envelopes
/
{envelopeID}
/
documents
/
{documentID}
/
fields
Create Field by Document ID
curl --request POST \
  --url https://api.gonitro.dev/sign/envelopes/{envelopeID}/documents/{documentID}/fields \
  --header 'Authorization: Bearer <token>' \
  --header 'Content-Type: application/json' \
  --data '{
  "page": 123,
  "boundingBox": [
    123
  ],
  "required": true,
  "participantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "type": "checkbox"
}'
{
  "type": "signature",
  "page": 123,
  "boundingBox": [
    123
  ],
  "required": true,
  "format": "<string>",
  "modifiable": true,
  "ID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "participantID": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "documentID": "3c90c3cc-0d44-4b50-8888-8dd25736052a"
}

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
  • Checkbox
  • Company
  • Custom
  • Date
  • Initials
  • Name
  • Signature
  • Title

Parameters to create a Checkbox field

​
boundingBox
number[]
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

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

Field created successfully

  • Date Field
  • Custom Field
  • Signature Field
  • Name Field
  • Checkbox Field
  • Initials Field
  • Company Field
  • Title Field

Create Date 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[]
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
​
format
string
required

For date field types, you can specify the format that will automatically populate when a signer participant opens the document in an envelope.

The default value is the date on which the signer opens the envelope. The signer can manually edit the date after it auto-populates, if needed.

The following date format options are supported (examples use September 10, 2025):

  • MM/DD/YYYY → 09/10/2025
  • MM-DD-YYYY → 09-10-2025
  • MMM DD YYYY → Sep 10 2025
  • DD/MM/YYYY → 10/09/2025
  • DD MMM YYYY → 10 Sep 2025
  • DD MMMM YYYY → 10 September 2025
  • YYYY/MM/DD → 2025/09/10
  • YYYY-MM-DD → 2025-09-10
  • YYYY-MMM-DD hh:mm → 2025-Sep-10 14:30
​
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

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.

​
modifiable
boolean

A boolean that indicates that the participant can change value of the field. By default the value of the field is current date and the participant can't change the value.

​
ID
string<uuid>

Unique ID of the field

⌘I