Validate migration data

POST https://app.speybooks.com/api/v1/migrations/{id}/validate

Run all gate checks against the migration's current state. Gates verify that all required imports are attached, confirmed, and consistent.

If all gates pass and the migration is in an eligible status, it is advanced to ready_to_execute.

Returns the list of gates with pass/fail and messages.

Returns 422 if the migration is in a terminal state.

Path parameters

id string required

Migration ID (e.g. mig_1).

Response

200 Validation results. Returns ready boolean and per-gate pass/fail with messages.

Show response fields

gates array<object>

Show child attributes

code string

message string

passed boolean

ready boolean

Error codes

400 Invalid migration ID format.

404 Migration not found.

422 Migration is in a terminal state.

Request POST /v1/migrations/{id}/validate curl

curl -X POST https://api.speybooks.com/v1/migration/mig_1/validate \
  -H "Authorization: Bearer sk_test_..."

Response 200

{
  "success": true,
  "data": {
    "ready": true,
    "gates": [
      {
        "code": "CONTACTS_CONFIRMED",
        "passed": true,
        "message": "Contact import confirmed"
      },
      {
        "code": "BALANCES_CONFIRMED",
        "passed": true,
        "message": "Opening balance confirmed"
      },
      {
        "code": "RECONCILIATION_VALID",
        "passed": true,
        "message": "Debits equal credits"
      }
    ]
  }
}