Create Validation

POST /api/v1/payroll-migrations/{migration_id}/validations/

Compares a source run against a target run to generate a validation report. The report contains field-level discrepancies between the source and target extraction results.

Authentication

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

Path Parameters

Parameter	Type	Description
`migration_id`	string (UUID)	The ID of the payroll migration.

Request Body

Field	Type	Required	Description
`source_run_id`	string (UUID)	Yes	The ID of the source run to compare.
`target_run_id`	string (UUID)	Yes	The ID of the target run to compare against.

{
  "source_run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "target_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
}

Response

Status: 201 Created

{
  "id": "c3d4e5f6-a7b8-9012-cdef-123456789012",
  "migration_id": "d4e5f6a7-b8c9-0123-defa-234567890123",
  "source_run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
  "target_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
  "status": "pending",
  "report": null,
  "created_at": "2026-03-16T12:00:00Z"
}

Response Fields

Field	Type	Description
`id`	string (UUID)	Unique identifier for the validation.
`migration_id`	string (UUID)	The migration this validation belongs to.
`source_run_id`	string (UUID)	The source run used for comparison.
`target_run_id`	string (UUID)	The target run used for comparison.
`status`	string	Validation status: `pending`, `processing`, `completed`, or `failed`.
`report`	object or null	Field-level discrepancy report. `null` until processing completes.
`created_at`	string (ISO 8601)	Timestamp when the validation was created.

The report field is populated asynchronously. Poll the Retrieve Validation endpoint to check for completion.

Errors

Status	Description
`400`	Invalid request body or run IDs do not belong to this migration.
`401`	Missing or invalid API key.
`403`	API key does not have `validations:write` scope.
`404`	Migration not found.

Code Examples

curl -X POST https://api.parsifyhq.com/api/v1/payroll-migrations/d4e5f6a7-b8c9-0123-defa-234567890123/validations/ \
  -H "X-API-Key: YOUR_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{
    "source_run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
    "target_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901"
  }'

import requests
 
resp = requests.post(
    "https://api.parsifyhq.com/api/v1/payroll-migrations/d4e5f6a7-b8c9-0123-defa-234567890123/validations/",
    headers={
        "X-API-Key": "YOUR_API_KEY",
        "Content-Type": "application/json",
    },
    json={
        "source_run_id": "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
        "target_run_id": "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    },
)
 
print(resp.json())

const resp = await fetch(
  "https://api.parsifyhq.com/api/v1/payroll-migrations/d4e5f6a7-b8c9-0123-defa-234567890123/validations/",
  {
    method: "POST",
    headers: {
      "X-API-Key": "YOUR_API_KEY",
      "Content-Type": "application/json",
    },
    body: JSON.stringify({
      source_run_id: "a1b2c3d4-e5f6-7890-abcd-ef1234567890",
      target_run_id: "b2c3d4e5-f6a7-8901-bcde-f12345678901",
    }),
  }
);
 
const data = await resp.json();

Update Run List Validations