Provide feedback

PATCH

/v1/workspaces/{workspaceId}/documents/{documentId}/feedback

Last modified:2025-08-31 08:57:16

Allows clients to send feedback (e.g., corrections, accuracy ratings) for a specific document processing result.
This feedback loop helps Docpier's machine learning models improve accuracy and extraction quality.
Clients can submit an overall rating, general comments, and specific field-level corrections.

Request

Authorization

OAuth 2.0

Authorization Code

Client Credentials

Add the parameter

Authorization

to Headers，whose value is to concatenate the Token after the Bearer.

Example:

Authorization: Bearer ********************

Authorize URL: https://auth.docpier.com/oauth/authorize

Token URL: https://auth.docpier.com/oauth/token

Path Params

Body Params application/json

Examples

Responses

🟢200OK

Feedback successfully received. Thank you for your input!

This response does not have a body.

🟠400Bad Request

🟠401Unauthorized

🟠403Forbidden

🟠404Record Not Found

🔴500Server Error

Request Example

Shell

JavaScript

Java

Swift

curl --location --request PATCH '/v1/workspaces//documents//feedback' \
--header 'Content-Type: application/json' \
--data-raw '{
    "overallRating": 4,
    "comments": "The VAT amount was incorrectly extracted. It should be 7.70, not 7.07.",
    "fieldCorrections": {
        "documentType": "INVOICE",
        "externalDocumentId": "INV-2025-00123",
        "items": [
            {
                "correctedFields": {
                    "vatAmount": 7.7,
                    "description": "Corrected Service Description for Q2"
                }
            }
        ],
        "sender": {
            "correctedFields": {
                "emails": [
                    "corrected.info@docpier.com"
                ]
            }
        }
    }
}'

Response Example

400 - Example 1

{
    "code": "INVALID_FILE",
    "message": "The uploaded file is not a valid PDF."
}

Modified at 2025-08-31 08:57:16

Retrieve structured data

ApiError