Introduction

The following specification describes the PrizmDoc Markup JSON format. A formal JSON schema is also available for automated validation and can be found within the Use the Markup JSON Schema topic.

Specification

The Markup JSON format consists of a top-level object with a marks property that is an array of all marks related to a single document.

Example

The following Markup JSON example creates a rectangle annotation with red background and black border near the top-left corner of the first page in the document:

{
  "marks": [{
      "uid": "bmd3OF8yMDE5LTAxLTE4VDEyOjE5OjU2LjQ0M1pfNGY3MTFx",
      "interactionMode": "Full",
      "pageNumber": 1,
      "type": "RectangleAnnotation",
      "creationDateTime": "2019-01-18T12:19:56.442Z",
      "modificationDateTime": "2019-01-18T12:19:58.089Z",
      "data": {},
      "rectangle": {
        "x": 15.622641509433958,
        "y": 15.622641509433958,
        "width": 143.99999999999997,
        "height": 103.2452830188679
      },
      "pageData": {
        "width": 612,
        "height": 792
      },
      "borderColor": "#000000",
      "borderThickness": 4,
      "fillColor": "#ff0000",
      "opacity": 255
    }
  ]
}

Properties

• marks (Array of Objects) Required. Array of marks for a document. Each item must be an object that conforms to one of the supported marks with the following common properties:
  • type (String) Required. Type of mark. The following values are allowed:
    • "EllipseAnnotation"
    • "FreehandAnnotation"
    • "FreehandSignature"
    • "HighlightAnnotation"
    • "ImageStampAnnotation"
    • "ImageStampRedaction"
    • "LineAnnotation"
    • "PolylineAnnotation"
    • "RectangleAnnotation"
    • "RectangleRedaction"
    • "StampAnnotation"
    • "StampRedaction"
    • "StrikethroughAnnotation"
    • "TextAnnotation"
    • "TextAreaSignature"
    • "TextHyperlinkAnnotation"
    • "TextInputSignature"
    • "TextRedaction"
    • "TextSelectionRedaction"
    • "TextSignature"
    • "TransparentRectangleRedaction"
  • uid (String) Required. Unique id for this mark. This can be any globally-unique string, like a GUID.
  • interactionMode (String) Required. Interaction mode for this mark. The following values are allowed:
    • "Full" - Indicates that the mark is fully interactive using the mouse, touch-input, and API.
    • "SelectionDisabled" - Indicates that the mark cannot be selected.
  • pageNumber (Integer) Required. One-indexed page where this mark is located. For example, the first page of a document will be 1.
  • data (Object) A property bag of user-defined values. Property values are only allowed to be strings.
  • creationDateTime (String) Required. Date and time when this mark was created. Format is RFC 3339 Internet Date/Time profile of ISO 8601, e.g. "2016-11-05T08:15:30.494Z".
  • modificationDateTime (String) Required. Date and time when this mark was last modified. Format is RFC 3339 Internet Date/Time profile of ISO 8601, e.g. "2016-11-05T08:15:30.494Z".
  • conversation (Object) Comments and associated metadata for this mark.
    • data (Object) Required. A property bag of user-defined values. Property values are only allowed to be strings.
    • comments (Array of Objects) Array of comment objects for this mark. Items must contain:
      • data (Object) Required. A property bag of user-defined values. Property values are only allowed to be strings.
      • creationDateTime (String) Required. Date and time when this comment was created. Format is RFC 3339 Internet Date/Time profile of ISO 8601, e.g. "2016-11-05T08:15:30.494Z".
      • text (String) Required. Text of the comment.
  • Additional properties specific to each mark type are defined in the sections below.

Mark Specific Properties

EllipseAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• borderColor (String) Required. Color of the border specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red border. The special value "transparent" is also allowed which will create an invisible border.
• borderThickness (Integer) Required. Thickness of the border in pixels.
• fillColor (String) Required. Color of the background specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red background. The special value "transparent" is also allowed which will create an invisible background.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.

FreehandAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• color (String) Required. Color of the line specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red line.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.
• path (String) Required. An SVG-style path using M, L, and C commands used to draw a line.
• thickness (Number) Required. Thickness of the line in pixels. Value must be between 1 and 50.

FreehandSignature

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• color (String) Required. Color of the line specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red line.
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.
• path (String) Required. An SVG-style path using M, L, and C commands used to draw a line.
• thickness (Number) Required. Thickness of the line in pixels. Value must be between 1 and 50.

HighlightAnnotation

• fillColor (String) Required. Color of the highlight specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red highlight.
• startIndex (Integer) Required. First zero-indexed character in the first line of text selected for this mark.
• selectedText (String) Required. Text selected across all lines for this mark.
• textLength (Integer) Required. Number of characters across all lines of text selected for this mark.
• lineGroups (Array of Objects) Required. Array of objects describing the selected text on each page where this mark will be applied. Items must contain:
  • pageData (Object) Required. Metadata of the page where this mark is located.
    • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
    • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • pageNumber (Integer) Required. One-indexed page where the text selected by this line group is located. For example, the first page of a document will be 1.
  • startIndex (Integer) Required. First zero-indexed character of the text selected on this page.
  • textLength (Integer) Required. Number of characters selected across all lines on this page.
  • lines (Array of Objects) Required. Array of objects describing each line of the selected text on this page. Items must contain:
    • rectangle (Object) Required. Bounding rectangle dimensions of the selected text on a single line.
      • x (Number) Required. Distance from the left edge of the page to the left edge of the selected text.
      • y (Number) Required. Distance from the top edge of the page to the top edge of the selected text.
      • width (Number) Required. Width of the selected text bounding rectangle.
      • height (Number) Required. Height of the selected text bounding rectangle.

ImageStampAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• imageDataUrl (String) Required. Image data for this mark. Format is RFC 2397 data URL scheme, e.g. "data: image/png;base64,R0lGOD...". Only image/png and image/gif media types are supported for burning.
• imageId (String) Required. Unique id for this image. This can be any globally-unique string, like a GUID.

ImageStampRedaction

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• imageDataUrl (String) Required. Image data for this mark. Format is RFC 2397 data URL scheme, e.g. "data: image/png;base64,R0lGOD...". Only image/png and image/gif media types are supported for burning.
• imageId (String) Required. Unique id for this image. This can be any globally-unique string, like a GUID.

LineAnnotation

• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• endPoint (Object) Required. Ending point of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the end point of this mark.
  • y (Number) Required. Distance from the top edge of the page to the end point of this mark.
• startPoint (Object) Required. Starting point of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the start point of this mark.
  • y (Number) Required. Distance from the top edge of the page to the start point of this mark.
• color (String) Required. Color of the line specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red line.
• endHeadType (String) Required. Shape drawn at the end point of the line. Allowed values are:
  • "None" - Indicates no shape will be drawn at the end point of the line.
  • "FilledTriangle" - Indicates a filled triangle will be drawn at the end point of the line which makes the line look like an arrow.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.
• thickness (Number) Required. Thickness of the line in pixels. Value must be between 1 and 50.

PolylineAnnotation

• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• points (Array of Objects) Required. Array of objects describing each point on the line of this mark. Items must contain:
  • startPoint (Object) Required. Starting point of this mark on the page.
    • x (Number) Required. Distance from the left edge of the page to the start point of this mark.
    • y (Number) Required. Distance from the top edge of the page to the start point of this mark.
• color (String) Required. Color of the line specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red line.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.
• thickness (Number) Required. Thickness of the line in pixels. Value must be between 1 and 50.

RectangleAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• borderColor (String) Required. Color of the border specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red border. The special value "transparent" is also allowed which will create an invisible border.
• borderThickness (Integer) Required. Thickness of the border in pixels.
• fillColor (String) Required. Color of the background specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red background. The special value "transparent" is also allowed which will create an invisible background.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.

RectangleRedaction

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• borderColor (String) Required. Color of the border specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red border.
• borderThickness (Integer) Required. Thickness of the border in pixels.
• fillColor (String) Required. Color of the background specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red background.
• fontColor (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• reasons (String[]) or reason (String) Required. Text to display in the center of the redaction indicating why the redaction was made. You can provide either a plural reasons property with an array of strings or a singular reason property with a single string value. If you provide an array of reasons, they will be displayed together as a single string with a semicolon separating each reason.

StampAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• color (String) Required. Color of the stamp border and text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red stamp.
• label (String) Required. Text aligned in the center of the mark bounding rectangle.

StampRedaction

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• label (String) Required. Text aligned in the center of the mark bounding rectangle.

StrikethroughAnnotation

• color (String) Required. Color of the strikethrough line specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red strikethrough line.
• thickness (Number) Required. Thickness of the line in pixels. Value must be between 1 and 50.
• textLength (Integer) Required. Number of characters across all lines of text selected for this mark.
• startIndex (Integer) Required. First zero-indexed character in the first line of text selected for this mark.
• selectedText (String) Required. Text selected across all lines for this mark.
• lineGroups (Array of Objects) Required. Array of objects describing the selected text on each page where this mark will be applied. Items must contain:
  • pageData (Object) Required. Metadata of the page where this mark is located.
    • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
    • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • pageNumber (Integer) Required. One-indexed page where the text selected by this line group is located. For example, the first page of a document will be 1.
  • startIndex (Integer) Required. First zero-indexed character of the text selected on this page.
  • textLength (Integer) Required. Number of characters selected across all lines on this page.
  • lines (Array of Objects) Required. Array of objects describing each line of the selected text on this page. Items must contain:
    • rectangle (Object) Required. Bounding rectangle dimensions of the selected text on a single line.
      • x (Number) Required. Distance from the left edge of the page to the left edge of the selected text.
      • y (Number) Required. Distance from the top edge of the page to the top edge of the selected text.
      • width (Number) Required. Width of the selected text bounding rectangle.
      • height (Number) Required. Height of the selected text bounding rectangle.

TextAnnotation

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• borderColor (String) Required. Color of the border specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red border. The special value "transparent" is also allowed which will create an invisible border.
• borderThickness (Integer) Required. Thickness of the border in pixels.
• fillColor (String) Required. Color of the background specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red background. The special value "transparent" is also allowed which will create an invisible background.
• fontColor (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• fontName (String) Required. Font name for the text.
• fontSize (Number) Required. Font size for the text specified in pixels. Value must be between 0.1 and 288.
• fontStyle (String[]) Required. Font styling applied to the text. An array of String values. The following values are allowed:
  • "Bold"
  • "Italic"
  • "Strikeout"
  • "Underline"
• maxLength (Integer) Required. Maximum number of characters allowed. Value must be greater than or equal to 0. A value of 0 indicates a maximum length will not be enforced.
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.
• text (String) Required. Text of this mark.
• opacity (Integer) Required. Opacity of this mark. Value must be between 0 and 255. A value of 0 will create an invisible mark. A value of 255 will create a fully opaque mark.

TextAreaSignature

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• fontColor (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• fontName (String) Required. Font name for the text.
• fontStyle (String[]) Required. Font styling applied to the text. An array of String values. The following values are allowed:
  • "Bold"
  • "Italic"
  • "Strikeout"
  • "Underline"
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.
• maxFontSize (Integer) Required. Maximum size of the font specified in pixels. Value must be greater than or equal to 0. A value of 0 indicates a maximum font size will not be enforced.
• maxLength (Integer) Required. Maximum number of characters allowed. Value must be greater than or equal to 0. A value of 0 indicates a maximum length will not be enforced.
• text (String) Required. Text of this mark.

TextHyperlinkAnnotation

• fillColor (String) Required. Color of the background specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create a red background.
• textLength (Integer) Required. Number of characters across all lines of text selected for this mark.
• startIndex (Integer) Required. First zero-indexed character in the first line of text selected for this mark.
• selectedText (String) Required. Text selected across all lines for this mark.
• lineGroups (Array of Objects) Required. Array of objects describing the selected text on each page where this mark will be applied. Items must contain:
  • pageData (Object) Required. Metadata of the page where this mark is located.
    • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
    • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • pageNumber (Integer) Required. One-indexed page where the text selected by this line group is located. For example, the first page of a document will be 1.
  • startIndex (Integer) Required. First zero-indexed character of the text selected on this page.
  • textLength (Integer) Required. Number of characters selected across all lines on this page.
  • lines (Array of Objects) Required. Array of objects describing each line of the selected text on this page. Items must contain:
    • rectangle (Object) Required. Bounding rectangle dimensions of the selected text on a single line.
      • x (Number) Required. Distance from the left edge of the page to the left edge of the selected text.
      • y (Number) Required. Distance from the top edge of the page to the top edge of the selected text.
      • width (Number) Required. Width of the selected text bounding rectangle.
      • height (Number) Required. Height of the selected text bounding rectangle.
• href (String) Required. URL of the hyperlink.

TextInputSignature

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• mask (Object) Required. Object defining the input mask for this mark. An input mask defines the format of the requested data and automatically rejects invalid input from the user. For example, the following input mask for a US telephone number allows only parentheses, dashes and numbers: "(###) ###-####". A value of null indicates an input mask should not be applied.
  • value (String) Required. String representation of the mask. The user input will look like this string once they have finished their input. Each character in this string that does not have a translation will be represented to the user literally.
  • translations (Object) Required. Translations to use for the given mask character. The key represents a character present in the mask value, and the value is a regular expression which validates the acceptable user input for that character. For example, the translation object { "#" : "/\\d/" } specifies that the "#" character in a mask string will allow only a number to be entered.
• fontColor (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• fontName (String) Required. Font name for the text.
• maxLength (Integer) Required. Maximum number of characters allowed. Value must be greater than or equal to 0. A value of 0 indicates a maximum length will not be enforced.
• text (String) Required. Text of this mark.
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.

TextRedaction

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• fontColor (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• fontName (String) Required. Font name for the text.
• fontSize (Number) Required. Font size for the text specified in pixels. Value must be between 0.1 and 288.
• maxLength (Integer) Required. Maximum number of characters allowed. Value must be greater than or equal to 0. A value of 0 indicates a maximum length will not be enforced.
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.
• text (String) Required. Text of this mark.

TextSelectionRedaction

• lineGroups (Array of Objects) Required. Array of objects describing the selected text on each page where this mark will be applied. Items must contain:
  • pageData (Object) Required. Metadata of the page where this mark is located.
    • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
    • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • pageNumber (Integer) Required. One-indexed page where the text selected by this line group is located. For example, the first page of a document will be 1.
  • startIndex (Integer) Required. First zero-indexed character of the text selected on this page.
  • textLength (Integer) Required. Number of characters selected across all lines on this page.
  • lines (Array of Objects) Required. Array of objects describing each line of the selected text on this page. Items must contain:
    • rectangle (Object) Required. Bounding rectangle dimensions of the selected text on a single line.
      • x (Number) Required. Distance from the left edge of the page to the left edge of the selected text.
      • y (Number) Required. Distance from the top edge of the page to the top edge of the selected text.
      • width (Number) Required. Width of the selected text bounding rectangle.
      • height (Number) Required. Height of the selected text bounding rectangle.
• reasons (String[]) or reason (String) Required. Text to display in the center of the redaction indicating why the redaction was made. You can provide either a plural reasons property with an array of strings or a singular reason property with a single string value. If you provide an array of reasons, they will be displayed together as a single string with a semicolon separating each reason.
• selectedText (String) Required. Text selected across all lines for this mark.
• startIndex (Integer) Required. First zero-indexed character in the first line of text selected for this mark.
• textLength (Integer) Required. Number of characters across all lines of text selected for this mark.

TextSignature

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
• color (String) Required. Color of the text specified as a 6-character hexadecimal color string with a leading # sign. For example, a value of "#FF0000" will create red text.
• fontName (String) Required. Font name for the text.
• horizontalAlignment (String) Required. Horizontal alignment applied to the text of this mark. The following values are allowed:
  • "Left" - The left edge of the mark will be horizontally anchored to the left of the mark bounding rectangle.
  • "Center" - The center of the mark will be horizontally anchored to the center of the mark bounding rectangle.
  • "Right" - The right edge of the mark will be horizontally anchored to the right of the mark bounding rectangle.
• text (String) Required. Text of this mark.

TransparentRectangleRedaction

• rectangle (Object) Required. Bounding rectangle dimensions of this mark on the page.
  • x (Number) Required. Distance from the left edge of the page to the left edge of this mark.
  • y (Number) Required. Distance from the top edge of the page to the top edge of this mark.
  • width (Number) Required. Width of the mark bounding rectangle.
  • height (Number) Required. Height of the mark bounding rectangle.
• pageData (Object) Required. Metadata of the page where this mark is located.
  • width (Number) Required. Width of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.
  • height (Number) Required. Height of the page, in pixels, at the time the mark is saved. Value must be greater than or equal to 0.