> ## Documentation Index > Fetch the complete documentation index at: https://developers.gonitro.com/docs/llms.txt > Use this file to discover all available pages before exploring further. # Create Field(s) by Document ID > 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. ## OpenAPI ````yaml https://api.gonitro.dev/openapi.json post /sign/envelopes/{envelopeID}/documents/{documentID}/fields openapi: 3.1.0 info: title: Nitro Sign Public API description: REST API for Nitro Sign version: '0.1' servers: - url: https://api.gonitro.dev security: - bearerAuth: [] paths: /sign/envelopes/{envelopeID}/documents/{documentID}/fields: post: tags: - Sign summary: Create Field(s) by Document ID description: > 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. operationId: createField parameters: - name: envelopeID in: path description: A unique string that identifies the envelope in the Nitro system. required: true schema: type: string format: uuid - name: documentID in: path description: A unique string that identifies the document in the Nitro system. required: true schema: type: string format: uuid requestBody: description: > 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 content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateCheckboxField' - $ref: '#/components/schemas/CreateCompanyField' - $ref: '#/components/schemas/CreateCustomField' - $ref: '#/components/schemas/CreateDateField' - $ref: '#/components/schemas/CreateInitialsField' - $ref: '#/components/schemas/CreateNameField' - $ref: '#/components/schemas/CreateSignatureField' - $ref: '#/components/schemas/CreateTitleField' - $ref: '#/components/schemas/BulkFieldRequest' examples: Single Field: description: Single Field value: participantID: 3fa85f64-5717-4562-b3fc-2c963f66afa6 page: 1 boundingBox: - 100 - 200 - 150 - 250 required: true type: signature Bulk Fields: description: Bulk Fields value: items: - participantID: 3fa85f64-5717-4562-b3fc-2c963f66afa6 page: 1 boundingBox: - 100 - 200 - 150 - 250 required: true type: signature - participantID: 3fa85f64-5717-4562-b3fc-2c963f66afa6 page: 1 boundingBox: - 200 - 300 - 150 - 50 required: false type: date format: MM/DD/YYYY modifiable: true required: true responses: '200': description: Fields created successfully content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateCheckboxFieldResponse' - $ref: '#/components/schemas/CreateCompanyFieldResponse' - $ref: '#/components/schemas/CreateCustomFieldResponse' - $ref: '#/components/schemas/CreateDateFieldResponse' - $ref: '#/components/schemas/CreateInitialsFieldResponse' - $ref: '#/components/schemas/CreateNameFieldResponse' - $ref: '#/components/schemas/CreateSignatureFieldResponse' - $ref: '#/components/schemas/CreateTitleFieldResponse' example: 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 '201': description: Single Field created successfully content: application/json: schema: oneOf: - $ref: '#/components/schemas/CreateCheckboxFieldResponse' - $ref: '#/components/schemas/CreateCompanyFieldResponse' - $ref: '#/components/schemas/CreateCustomFieldResponse' - $ref: '#/components/schemas/CreateDateFieldResponse' - $ref: '#/components/schemas/CreateInitialsFieldResponse' - $ref: '#/components/schemas/CreateNameFieldResponse' - $ref: '#/components/schemas/CreateSignatureFieldResponse' - $ref: '#/components/schemas/CreateTitleFieldResponse' example: 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 '400': description: Invalid request content: application/problem+json: schema: $ref: '#/components/schemas/BadRequestProblemDetail' '401': description: Unauthorized - Invalid or missing JWT token content: application/problem+json: schema: $ref: '#/components/schemas/UnauthorizedProblemDetail' '404': description: Envelope or document not found content: application/problem+json: schema: $ref: '#/components/schemas/NotFoundProblemDetail' '422': description: The requested participant does not exist on the given package content: application/problem+json: schema: $ref: '#/components/schemas/UnprocessableEntityProblemDetail' components: schemas: CreateCheckboxField: description: Parameters to create a Checkbox field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - checkbox title: type required: - boundingBox - participantID - type title: Checkbox CreateCompanyField: description: Parameters to create a Company field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - company title: type required: - boundingBox - participantID - type title: Company CreateCustomField: description: Parameters to create a Custom field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - custom title: type label: type: string description: >- For custom field types, you must provide a descriptive label for the field. minLength: 1 required: - boundingBox - participantID - type title: Custom CreateDateField: description: Parameters to create a Date field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - date title: type format: type: string description: > 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: type: boolean description: >- 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. required: - boundingBox - participantID - type title: Date CreateInitialsField: description: Parameters to create a Initials field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - initials title: type required: - boundingBox - participantID - type title: Initials CreateNameField: description: Parameters to create a Name field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - name title: type required: - boundingBox - participantID - type title: Name CreateSignatureField: description: Parameters to create a Signature field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - signature title: type required: - boundingBox - participantID - type title: Signature CreateTitleField: description: Parameters to create a Title field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - title title: type required: - boundingBox - participantID - type title: Title BulkFieldRequest: type: object description: Create multiple fields wrapped in an items array properties: items: type: array description: >- List of fields to create. Each field can be any supported field type. items: oneOf: - description: Parameters to create a Checkbox field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - checkbox title: type required: - boundingBox - participantID - type title: Checkbox - description: Parameters to create a Company field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - company title: type required: - boundingBox - participantID - type title: Company - description: Parameters to create a Custom field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - custom title: type label: type: string description: >- For custom field types, you must provide a descriptive label for the field. minLength: 1 required: - boundingBox - participantID - type title: Custom - description: Parameters to create a Date field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - date title: type format: type: string description: > 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: type: boolean description: >- 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. required: - boundingBox - participantID - type title: Date - description: Parameters to create a Initials field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - initials title: type required: - boundingBox - participantID - type title: Initials - description: Parameters to create a Name field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - name title: type required: - boundingBox - participantID - type title: Name - description: Parameters to create a Signature field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - signature title: type required: - boundingBox - participantID - type title: Signature - description: Parameters to create a Title field properties: page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. type: type: string enum: - title title: type required: - boundingBox - participantID - type title: Title minItems: 1 title: Items required: - items title: Bulk Field CreateCheckboxFieldResponse: type: object description: Create Checkbox Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Checkbox CreateCompanyFieldResponse: type: object description: Create Company Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Company CreateCustomFieldResponse: type: object description: Create Custom Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. label: type: string description: Descriptive label of the field. minLength: 1 ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - label - participantID - type title: Custom CreateDateFieldResponse: type: object description: Create Date Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. format: type: string description: > 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: type: boolean description: >- 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: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Date CreateInitialsFieldResponse: type: object description: Create Initials Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Initials CreateNameFieldResponse: type: object description: Create Name Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Name CreateSignatureFieldResponse: type: object description: Create Signature Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Signature CreateTitleFieldResponse: type: object description: Create Title Field Response properties: type: type: string description: >- Enum that specifies which type of information an eSignature participant is expected to fill in. enum: - signature - name - checkbox - date - initials - company - title - custom page: type: integer format: int32 description: >- The page number where the field appears. Pages follow 1-based indexing, so the first page is 1. boundingBox: type: array description: > 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). items: type: number format: float maxItems: 4 minItems: 4 required: type: boolean description: >- A boolean that indicates whether the participant must complete the field. ID: type: string format: uuid description: Unique ID of the field participantID: type: string format: uuid description: >- The unique identifier of the participant assigned to the field. Fields can only be created for participants with the signer role. documentID: type: string format: uuid description: ID of the document to which this field belongs. required: - boundingBox - documentID - participantID - type title: Title BadRequestProblemDetail: type: object description: Bad Request error details example: type: https://developers.gonitro.com/docs/build-nitro/errors#400-bad-request title: Bad Request status: 400 detail: Request validation failed instance: /sign/envelopes validation_errors: name: must not be blank properties: type: type: string description: A URI reference that identifies the problem type title: type: string description: A short, human-readable summary of the problem type status: type: integer format: int32 description: The HTTP status code detail: type: string description: A human-readable explanation specific to this occurrence instance: type: string description: A URI reference that identifies the specific occurrence extensions: type: object additionalProperties: {} description: Additional problem-specific properties UnauthorizedProblemDetail: type: object description: Unauthorized error details example: type: >- https://developers.gonitro.com/docs/build-nitro/errors#401-unauthorized title: Unauthorized status: 401 detail: Missing or invalid Authorization header instance: /sign/envelopes properties: type: type: string description: A URI reference that identifies the problem type title: type: string description: A short, human-readable summary of the problem type status: type: integer format: int32 description: The HTTP status code detail: type: string description: A human-readable explanation specific to this occurrence instance: type: string description: A URI reference that identifies the specific occurrence extensions: type: object additionalProperties: {} description: Additional problem-specific properties NotFoundProblemDetail: type: object description: Not Found error details example: type: https://developers.gonitro.com/docs/build-nitro/errors#404-not-found title: Not Found status: 404 detail: Envelope with ID 'envelop-123' not found instance: /sign/envelopes/envelop-123 properties: type: type: string description: A URI reference that identifies the problem type title: type: string description: A short, human-readable summary of the problem type status: type: integer format: int32 description: The HTTP status code detail: type: string description: A human-readable explanation specific to this occurrence instance: type: string description: A URI reference that identifies the specific occurrence extensions: type: object additionalProperties: {} description: Additional problem-specific properties UnprocessableEntityProblemDetail: type: object description: Unprocessable Entity error details example: type: >- https://developers.gonitro.com/docs/build-nitro/errors#422-unprocessable-entity title: Unprocessable Entity status: 422 detail: Too many documents in envelope instance: /sign/envelopes properties: type: type: string description: A URI reference that identifies the problem type title: type: string description: A short, human-readable summary of the problem type status: type: integer format: int32 description: The HTTP status code detail: type: string description: A human-readable explanation specific to this occurrence instance: type: string description: A URI reference that identifies the specific occurrence extensions: type: object additionalProperties: {} description: Additional problem-specific properties securitySchemes: bearerAuth: type: http scheme: bearer bearerFormat: JWT ````