Skip to main content
POST
/
api
/
v1
/
submission
/
extract
General Endpoint
curl --request POST \
  --url https://api.ferofill.com/api/v1/submission/extract \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "files": [
    null
  ]
}
'
{
  "data": [
    {
      "template_confidence": 94,
      "template": "acord_127_2023",
      "processing_time": "2.3s",
      "start_page": 1,
      "end_page": 2,
      "extracted_fields": [
        {
          "field_name": "applicant_name",
          "value": "ABC Transportation Inc",
          "confidence": 98,
          "location": {"page": 1, "x": 0.1, "y": 0.15, "width": 0.3, "height": 0.02},
          "data_type": "text"
        }
      ],
      "tables": [
        {
          "table_id": "vehicle_schedule",
          "title": "Schedule of Vehicles", 
          "confidence": 92,
          "location": {"page": 2, "x": 0.05, "y": 0.2, "width": 0.9, "height": 0.6},
          "structure": {
            "headers": ["Vehicle ID", "Year", "Make", "Model", "VIN"],
            "rows": [
              {
                "row_index": 0,
                "cells": [
                  {"column": "Vehicle ID", "value": "001"},
                  {"column": "Year", "value": "2022"}
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "error": null
}
Requests to the general endpoint will take longer than LOB specific extraction.

​
Request

​
files
file[]
required
Upload one or more documents for extraction. Supported file formats: pdf, jpeg, png, xlsx, docx, pptx, csv, and txt.
{
  "data": [
    {
      "template_confidence": 94,
      "template": "acord_127_2023",
      "processing_time": "2.3s",
      "start_page": 1,
      "end_page": 2,
      "extracted_fields": [
        {
          "field_name": "applicant_name",
          "value": "ABC Transportation Inc",
          "confidence": 98,
          "location": {"page": 1, "x": 0.1, "y": 0.15, "width": 0.3, "height": 0.02},
          "data_type": "text"
        }
      ],
      "tables": [
        {
          "table_id": "vehicle_schedule",
          "title": "Schedule of Vehicles", 
          "confidence": 92,
          "location": {"page": 2, "x": 0.05, "y": 0.2, "width": 0.9, "height": 0.6},
          "structure": {
            "headers": ["Vehicle ID", "Year", "Make", "Model", "VIN"],
            "rows": [
              {
                "row_index": 0,
                "cells": [
                  {"column": "Vehicle ID", "value": "001"},
                  {"column": "Year", "value": "2022"}
                ]
              }
            ]
          }
        }
      ]
    }
  ],
  "error": null
}

​
Response

All endpoints return a consistent response structure:
​
data
array
required
Array of extracted document data objects
​
error
string | null
Error message if processing failed, null if successful