SIsignnow

Upload document with tags

This endpoint allows API users to upload a document with text tags.

Text tags can be of two types: simple and complex. Simple text tags use curly brackets and a notation system to define fields. Complex text tags use only field names on a document; field details are provided separately in the Tags array.

Only .doc, .docx, and .pdf formats are supported.

Additional parameters

parse_type: determines how the document text tags are parsed.

Possible values:

  • tag: parse only simple tags. All Adobe (fillable) fields will be removed from the document without saving.

  • adobe: parse only Adobe (fillable) fields. All simple tags will be removed from the document without saving.

  • all: parse both simple tags and Adobe (fillable) fields. Also parses simple tags added inside Adobe fields as their content.

  • default (or if parse_type not specified): parse simple and complex tags and Adobe (fillable) fields. Simple tags added as the content of Adobe fields will not be parsed.

For more information, see the Text tags guide or check out our video tutorials:

<details open>

<summary>Simple text tags video tutorial</summary>

<sub><sup>Note: The design shown in the video is outdated, but the flow is still accurate. You can go ahead and follow the steps as demonstrated.</sup></sub>

Simple text tags video tutorial

</details> <br> <details open>

<summary>Complex text tags video tutorial</summary>

<sub><sup>Note: The design shown in the video is outdated, but the flow is still accurate. You can go ahead and follow the steps as demonstrated.</sup></sub>

Complex text tags video tutorial

</details>
post/document/fieldextract

Request

Request body multipart/form-data

filestring binary required

@/path/to/your/file.pdf

Tags[]:string

A JSON array of complex text tags in the document. Example: { "tag_name": "EmployeeName", "role": "Employee", "label": "Your name", "required": true, "type": "text", "width": 100, "height": 20 }

parse_typestring

Determines the parse flow for document text tags. Possible values: tag, adobe, all, default.

passwordstring

Password to open a password-protected PDF.

Response

The document was uploaded and fields were created from its text tags.

idstring

ID of the uploaded document.

Changes

No recorded changes to this operation across all 1 revision of this API.