Docparser · Schema

Docparser Parsed Result

Parsed data result returned for a document processed by a Docparser parser. Core fields are defined; custom extracted fields vary per parser configuration.

Document ParsingData ExtractionPDFOCRDocument AutomationInvoicesContractsREST API

Properties

Name Type Description
id string Unique identifier of the parsed document.
file_name string Original filename of the uploaded document.
remote_id string Custom identifier assigned at upload time for tracking.
media_link string URL to view the document in the Docparser web application.
page_count integer Number of pages in the document.
uploaded_at string ISO 8601 timestamp when the document was uploaded.
processed_at string ISO 8601 timestamp when parsing completed.
View JSON Schema on GitHub

JSON Schema

docparser-parsed-result.json Raw ↑
{
  "$schema": "https://json-schema.org/draft/2020-12/schema",
  "$id": "https://raw.githubusercontent.com/api-evangelist/docparser/main/json-schema/docparser-parsed-result.json",
  "title": "Docparser Parsed Result",
  "description": "Parsed data result returned for a document processed by a Docparser parser. Core fields are defined; custom extracted fields vary per parser configuration.",
  "type": "object",
  "properties": {
    "id": {
      "type": "string",
      "description": "Unique identifier of the parsed document.",
      "examples": ["doc_abc123"]
    },
    "file_name": {
      "type": "string",
      "description": "Original filename of the uploaded document.",
      "examples": ["invoice.pdf"]
    },
    "remote_id": {
      "type": "string",
      "description": "Custom identifier assigned at upload time for tracking.",
      "examples": ["order-9001"]
    },
    "media_link": {
      "type": "string",
      "format": "uri",
      "description": "URL to view the document in the Docparser web application."
    },
    "page_count": {
      "type": "integer",
      "minimum": 1,
      "description": "Number of pages in the document.",
      "examples": [1]
    },
    "uploaded_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when the document was uploaded."
    },
    "processed_at": {
      "type": "string",
      "format": "date-time",
      "description": "ISO 8601 timestamp when parsing completed."
    }
  },
  "additionalProperties": {
    "description": "Custom fields extracted by the parser rules (e.g., invoice_number, vendor_name, total_amount)."
  }
}