Dropbox Sign Developer Documentation

{
  "detection_result": {
    "document_hash": "string",
    "detection_mode": "string",
    "page_count": 1,
    "pages_analyzed": "all",
    "detected_at": 1,
    "form_fields_per_document": [
      {
        "api_id": "string",
        "document_index": 1,
        "height": 1,
        "name": "string",
        "page": 1,
        "required": true,
        "signer": "string",
        "type": "string",
        "width": 1,
        "x": 1,
        "y": 1
      }
    ],
    "form_field_groups": [
      {
        "group_id": "string",
        "group_label": "string",
        "requirement": "string"
      }
    ],
    "warnings": [
      {
        "warning_msg": "string",
        "warning_name": "string"
      }
    ],
    "errors": [
      {
        "error_msg": "string",
        "error_name": "string",
        "error_path": "string"
      }
    ],
    "suggestions": [
      "string"
    ]
  },
  "warnings": [
    {
      "warning_msg": "string",
      "warning_name": "string"
    }
  ]
}

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

Authentication

AuthorizationBasic

Use your API key with HTTP Basic authentication in the form Basic <api_key>. See Authentication for more information. ✅ Supported by Try it console (calls sent in test_mode only).

AuthorizationBearer

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See Authentication for more information. ❌ Not supported by Try it console.

You can use an Access Token issued through an OAuth flow to send calls to the Dropbox Sign API from your app. The access scopes required by this endpoint are listed in the gray box above. See [Authentication](/api/reference/authentication) for more information. ❌ **Not supported** by Try it console.

Request

This endpoint expects an object.

detection_modestringRequired

The field detection method to use. Set to annotations to detect PDF form annotations or text_tags to detect Dropbox Sign text tags.

filestringOptionalformat: "binary"

The PDF file to analyze.

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

file_urlstringOptionalformat: "uri"

The URL of the PDF file to analyze.

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

page_rangestringOptionalformat: "^(?:all|\d+(?:-\d+)?(?:,\d+(?:-\d+)?)*)$"

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.

Response headers

X-RateLimit-Limitinteger

The maximum number of requests per hour that you can make.

X-RateLimit-Remaininginteger

The number of requests remaining in the current rate limit window.

X-Ratelimit-Resetinteger

The Unix time at which the rate limit will reset to its maximum.

Response

successful operation

detection_resultobject

warningslist of objectsOptional

A list of warnings.

Errors

4XX

Client Request Error