--- title: "Create Field(s) by Document ID" method: POST path: "/sign/envelopes/{envelopeID}/documents/{documentID}/fields" tags: ["Sign"] --- # Create Field(s) by Document ID `POST /sign/envelopes/{envelopeID}/documents/{documentID}/fields` The **Create Field(s) by Document ID** endpoint creates one or more fields on a document and assigns it to a participant. Accepts either a single field object or a bulk request with an 'items' array containing multiple field objects. ## Path parameters - `envelopeID` string, uuid, required - `documentID` string, uuid, required ## Request body - union - CreateCheckboxField — Parameters to create a Checkbox field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'checkbox', required - CreateCompanyField — Parameters to create a Company field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'company', required - CreateCustomField — Parameters to create a Custom field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'custom', required - `label` string — For custom field types, you must provide a descriptive label for the field. - CreateDateField — Parameters to create a Date field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'date', required - `format` string — 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 - `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. - CreateInitialsField — Parameters to create a Initials field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'initials', required - CreateNameField — Parameters to create a Name field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'name', required - CreateSignatureField — Parameters to create a Signature field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'signature', required - CreateTitleField — Parameters to create a Title field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'title', required - BulkFieldRequest — Create multiple fields wrapped in an items array - `items` union[], required — List of fields to create. Each field can be any supported field type. - union - object — Parameters to create a Checkbox field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'checkbox', required - object — Parameters to create a Company field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'company', required - object — Parameters to create a Custom field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'custom', required - `label` string — For custom field types, you must provide a descriptive label for the field. - object — Parameters to create a Date field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'date', required - `format` string — 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 - `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. - object — Parameters to create a Initials field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'initials', required - object — Parameters to create a Name field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'name', required - object — Parameters to create a Signature field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'signature', required - object — Parameters to create a Title field - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `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` 'title', required ## Response `200` Fields created successfully - union - CreateCheckboxFieldResponse — Create Checkbox Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateCompanyFieldResponse — Create Company Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateCustomFieldResponse — Create Custom Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `label` string, required — Descriptive label of the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateDateFieldResponse — Create Date Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `format` string — 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 - `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 - `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. - CreateInitialsFieldResponse — Create Initials Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateNameFieldResponse — Create Name Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateSignatureFieldResponse — Create Signature Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. - CreateTitleFieldResponse — Create Title Field Response - `type` 'signature' | 'name' | 'checkbox' | 'date' | 'initials' | 'company' | 'title' | 'custom', required — Enum that specifies which type of information an eSignature participant is expected to fill in. - `page` integer — The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. - `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](https://developers.gonitro.com/docs/build-nitro/bounding-box). - `required` boolean — A boolean that indicates whether the participant must complete the field. - `ID` string, uuid — Unique ID of the field - `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. ## Other responses - `201` — Single Field created successfully - `400` — Invalid request - `401` — Unauthorized - Invalid or missing JWT token - `404` — Envelope or document not found - `422` — The requested participant does not exist on the given package --- [API](https://skmtc.net/gonitro/apis/nitro-sign-public-api.md) · [All operations](https://skmtc.net/gonitro/apis/nitro-sign-public-api/llms.txt) · [OpenAPI document](https://skmtc-service-staging.skmtc.workers.dev/v1/apis/gonitro/nitro-sign-public-api/versions/26e3043a365b/schema)