DigiParser DocsDigiParser Docs
Overview

#DigiParser API

DigiParser provides a powerful document processing API that helps you extract structured data from various document formats.

Key features:

  • Extract data from PDFs, images, scanned documents, and digital files
  • Process documents via direct file upload or URLs
  • Convert unstructured documents into structured JSON data
  • Support for async processing for large documents
  • Automated data extraction with high accuracy
  • Flexible output formats with both key-value pairs and raw data

This API documentation provides all the endpoints and methods needed to integrate document processing capabilities into your applications.

Authentication

Generate an API key from the DigiParser dashboard at https://app.digiparser.com/?redirect=api-keys. Include the key in every request using the Authorization header:

Authorization: YOUR-API-KEY
plain
Endpoint:https://app.digiparser.com/api/v1

#Upload a document file for processing

Submit a file to DigiParser for extraction. Include Authorization=YOUR-API-KEY in the request headers. The document is processed asynchronously and returns an operation reference.

#path Parameters

  • parserIdrequiredstring

    Identifier of the parser configured in your workspace.

#Headers

  • Authorizationrequiredstring

    DigiParser API key. Pass the raw key value, e.g. Authorization: YOUR-API-KEY.

#Request Body

  • filestring

    Binary content of the document to process.

#Responses

    • successbooleanoptional
    • resultobject[]optional

#Upload a document via URL for processing

Provide publicly reachable document URLs to ingest the files asynchronously. Include Authorization=YOUR-API-KEY in the request headers.

#path Parameters

  • parserIdrequiredstring

    Identifier of the parser configured in your workspace.

#Headers

  • Authorizationrequiredstring

    DigiParser API key. Pass the raw key value, e.g. Authorization: YOUR-API-KEY.

#Request Body

  • urlsstring

    One or more URLs to documents. Provide multiple values by repeating the parameter.

#Responses

    • successbooleanoptional
    • resultobject[]optional

#Retrieve processed document data

Fetch structured data for a previously uploaded document using its documentId. Include Authorization=YOUR-API-KEY in the request headers.

#path Parameters

  • parserIdrequiredstring

    Identifier of the parser configured in your workspace.

#query Parameters

  • documentIdrequiredstring

    Document identifier returned by the upload endpoint.

#Headers

  • Authorizationrequiredstring

    DigiParser API key. Pass the raw key value, e.g. Authorization: YOUR-API-KEY.

#Responses

    • metadataobjectoptional
    • dataobjectoptional