Sign in
Document

Detect Document Fields

Changed on

Detects form fields in a PDF document using either PDF form annotations or Dropbox Sign text tags.

post/document/detect_fields

Request

  • Base URL: https://api.hellosign.com/v3
  • URL: https://api.hellosign.com/v3/document/detect_fields
  • Auth: one of:
    • HTTP basic
    • HTTP bearer

Request body

filestring binary

The PDF file to analyze.

This endpoint requires either file or file_url, but not both.

file_urlstring uri

The URL of the PDF file to analyze.

This endpoint requires either file or file_url, but not both.

page_rangestring

The zero-based page indexes to analyze. Accepts all, individual pages, inclusive ranges, or comma-separated combinations, such as 0-2,5,7-9. Defaults to all.

Example request

{
  "detection_mode": "annotations",
  "page_range": "0-2,5,7-9"
}

Response

successful operation

Example response

{
  "detection_result": {
    "detection_mode": "annotations",
    "pages_analyzed": "all"
  }
}

Changes