| Name | Type | Description | Notes |
|---|---|---|---|
document_hash*required |
str |
The SHA-256 hash of the analyzed document. | |
detection_mode*required |
str |
The field detection method used to analyze the document: annotations or text_tags. |
|
page_count*required |
int |
The total number of pages in the document. | |
pages_analyzed*required |
str |
The zero-based page indexes analyzed, represented by the requested page_range, or all when every page was analyzed. |
|
detected_at*required |
int |
The Unix timestamp when the field detection result was generated. | |
form_fields_per_document*required |
List[SubFormFieldsPerDocumentBase] |
The fields that should appear on the document, expressed as an array of objects. (For more details you can read about it here: Using Form Fields per Document.) NOTE: Fields like text, dropdown, checkbox, radio, and hyperlink have additional required and optional parameters. Check out the list of additional parameters for these field types. * Text Field use SubFormFieldsPerDocumentText* Dropdown Field use SubFormFieldsPerDocumentDropdown* Hyperlink Field use SubFormFieldsPerDocumentHyperlink* Checkbox Field use SubFormFieldsPerDocumentCheckbox* Radio Field use SubFormFieldsPerDocumentRadio* Signature Field use SubFormFieldsPerDocumentSignature* Date Signed Field use SubFormFieldsPerDocumentDateSigned* Initials Field use SubFormFieldsPerDocumentInitials* Text Merge Field use SubFormFieldsPerDocumentTextMerge* Checkbox Merge Field use SubFormFieldsPerDocumentCheckboxMerge |
|
form_field_groups*required |
List[SubFormFieldGroup] |
Group information for fields defined in form_fields_per_document. String-indexed JSON array with group_label and requirement keys. form_fields_per_document must contain fields referencing a group defined in form_field_groups. |
|
warnings*required |
List[WarningResponse] |
Non-fatal issues encountered during field detection. | |
errors*required |
List[ErrorResponseError] |
Errors encountered during field detection. Successfully detected fields may still be included in the response. | |
suggestions*required |
List[str] |
Suggestions for improving the field detection results. |