API ReferenceValidationsRetrieve Validation

Retrieve Validation

GET /api/v1/payroll-migrations/{migration_id}/validations/{id}/

Returns the full validation report including field-level discrepancies between the source and target runs.

Authentication

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

Path Parameters

ParameterTypeDescription
migration_idstring (UUID)The ID of the payroll migration.
idstring (UUID)The ID of the validation.

Response

Status: 200 OK

{
  "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": "completed",
  "report": {
    "total_fields": 128,
    "matched_fields": 120,
    "discrepancies": [
      {
        "field_path": "employees[0].gross_pay",
        "source_value": "5000.00",
        "target_value": "5250.00",
        "severity": "high"
      },
      {
        "field_path": "employees[2].deductions.health_insurance",
        "source_value": "450.00",
        "target_value": null,
        "severity": "medium"
      }
    ]
  },
  "created_at": "2026-03-16T12:00:00Z"
}

Response Fields

FieldTypeDescription
idstring (UUID)Unique identifier for the validation.
migration_idstring (UUID)The migration this validation belongs to.
source_run_idstring (UUID)The source run used for comparison.
target_run_idstring (UUID)The target run used for comparison.
statusstringValidation status: pending, processing, completed, or failed.
reportobject or nullField-level discrepancy report. null until processing completes.
created_atstring (ISO 8601)Timestamp when the validation was created.

Report Object

FieldTypeDescription
total_fieldsintegerTotal number of fields compared.
matched_fieldsintegerNumber of fields that matched between source and target.
discrepanciesarrayList of field-level discrepancies.

Discrepancy Object

FieldTypeDescription
field_pathstringDot-notation path to the field with a discrepancy.
source_valuestring or nullThe value from the source run.
target_valuestring or nullThe value from the target run.
severitystringSeverity level: high, medium, or low.

Errors

StatusDescription
401Missing or invalid API key.
403API key does not have validations:read scope.
404Migration or validation not found.

Code Examples

curl https://api.parsifyhq.com/api/v1/payroll-migrations/d4e5f6a7-b8c9-0123-defa-234567890123/validations/c3d4e5f6-a7b8-9012-cdef-123456789012/ \
  -H "X-API-Key: YOUR_API_KEY"