Create Correction

POST /api/v1/jobs/{job_id}/corrections/

Submit a human correction to an extraction result. Corrections are used to flag and fix errors in the automated extraction output.

Authentication

Requires an API key with jobs:write scope. Pass via the X-API-Key header.

Path Parameters

Parameter	Type	Description
`job_id`	string (UUID)	The ID of the extraction job.

Request Body

Field	Type	Required	Description
`correction_type`	string	Yes	Type of correction. See values below.
`field_path`	string	Yes	Dot-notation path to the field being corrected (e.g., `employees[0].gross_pay`).
`original_value`	string	Yes	The original extracted value.
`corrected_value`	string	Yes	The corrected value.
`notes`	string	No	Optional explanation for the correction.

Correction Types

Value	Description
`wrong_value`	The field was extracted but has the wrong value.
`wrong_field`	The value was placed in the wrong field.
`missing_field`	A field that should have been extracted was missed.
`spurious`	A field was extracted that should not exist.

{
  "correction_type": "wrong_value",
  "field_path": "employees[0].gross_pay",
  "original_value": "5000.00",
  "corrected_value": "5250.00",
  "notes": "Verified against source document page 3"
}

Response

Status: 201 Created

{
  "id": "f6a7b8c9-0123-4567-89ab-cdef01234567",
  "job_id": "e5f6a7b8-c901-2345-6789-abcdef012345",
  "correction_type": "wrong_value",
  "field_path": "employees[0].gross_pay",
  "original_value": "5000.00",
  "corrected_value": "5250.00",
  "notes": "Verified against source document page 3",
  "created_at": "2026-03-16T12:00:00Z"
}

Response Fields

Field	Type	Description
`id`	string (UUID)	Unique identifier for the correction.
`job_id`	string (UUID)	The extraction job this correction belongs to.
`correction_type`	string	Type of correction applied.
`field_path`	string	Dot-notation path to the corrected field.
`original_value`	string	The original extracted value.
`corrected_value`	string	The corrected value.
`notes`	string or null	Optional explanation for the correction.
`created_at`	string (ISO 8601)	Timestamp when the correction was created.

Errors

Status	Description
`400`	Invalid request body or unknown `correction_type`.
`401`	Missing or invalid API key.
`403`	API key does not have `jobs:write` scope.
`404`	Extraction job not found.

Code Examples

curl -X POST https://api.parsifyhq.com/api/v1/jobs/e5f6a7b8-c901-2345-6789-abcdef012345/corrections/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "correction_type": "wrong_value",
    "field_path": "employees[0].gross_pay",
    "original_value": "5000.00",
    "corrected_value": "5250.00",
    "notes": "Verified against source document page 3"
  }'

import requests
 
resp = requests.post(
    "https://api.parsifyhq.com/api/v1/jobs/e5f6a7b8-c901-2345-6789-abcdef012345/corrections/",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
        "correction_type": "wrong_value",
        "field_path": "employees[0].gross_pay",
        "original_value": "5000.00",
        "corrected_value": "5250.00",
        "notes": "Verified against source document page 3",
    },
)
 
print(resp.json())

const resp = await fetch(
  "https://api.parsifyhq.com/api/v1/jobs/e5f6a7b8-c901-2345-6789-abcdef012345/corrections/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      correction_type: "wrong_value",
      field_path: "employees[0].gross_pay",
      original_value: "5000.00",
      corrected_value: "5250.00",
      notes: "Verified against source document page 3",
    }),
  }
);
 
const data = await resp.json();

Retrieve Validation List Corrections