DigiParserDigiParser
HomeSupportGet Started
GuidesAPI ReferenceChangelogLegal

Delete Documents

POST
/api/v1/process/{parserId}/documents/delete

Delete documents so their externalId values can be reused on re-upload.

Request body: Provide documentIds and/or externalIds.

  • If you send documentIds, externalIds is optional.
  • If you send externalIds, documentIds is optional.
  • You must provide at least one of them.

Authorization

bearerAuth
authorization<token>

Your API key. Include it directly in the Authorization header as the API key value (e.g., 'authorization: your-api-key-here')

In: header

Path Parameters

parserId*string

The ID of the parser

Formatuuid

Request Body

application/json

documentIds?array<>

Optional list of document UUIDs to delete.

externalIds?array<>

Optional list of external IDs to delete documents by externalId.

Response Body

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://app.digiparser.com/api/v1/process/d1458cd7-8692-488f-8b3f-0fddade05f9c/documents/delete" \  -H "Content-Type: application/json" \  -d '{}'
{
  "success": true,
  "deleted": 0,
  "ids": [
    "497f6eca-6276-4993-bfeb-53cbbbba6f08"
  ]
}
{
  "error": true,
  "message": "Parser ID mismatch"
}
{
  "error": true,
  "message": "Parser ID mismatch"
}
{
  "error": true,
  "message": "Document not found",
  "notFound": [
    {
      "type": "documentId",
      "value": "string"
    }
  ]
}
{
  "error": true,
  "message": "Parser ID mismatch"
}

Webhooks

Receive document.exported events and payload structure

Get Document Data GET

Retrieve the extracted data from a processed document. **What you need:** - **Parser ID**: Find it in Parser Settings → General Settings - Either: - **Document ID**: Get this from the upload response (`documentId` field), or - **externalId**: The external tracking ID you provided during upload - **API Key**: Generate it from Team Settings → API Keys **How to use:** - Endpoint: `GET /api/v1/process/{parserId}/files/data?documentId={documentId}` - OR: `GET /api/v1/process/{parserId}/files/data?externalId={externalId}` - Include your API key in the `Authorization` header **What you get:** - **data**: Extracted field values and table data matching your parser's schema - **metadata**: Document information including status, timestamps, and file details **Note:** If the document is still processing, the `data` field will be empty and `status` will be `processing`. Poll this endpoint periodically until `status` is `processed` or `failed`.