Validate migration data

POSThttps://app.speybooks.com/api/v1/migration/{id}/validate

Run the gate checks against the migration's current state without finalising it. The gates confirm that the required imports are attached and confirmed, that the cutover dates align, that any contact conflicts are resolved, and that the opening balance reconciles (the clearing accounts net to zero and the ledger balances). If every gate passes and the migration is in an eligible state, it is advanced to ready_to_execute. The response lists each gate with its pass or fail and a message. Returns 422 if the migration is in a terminal state.

Path parameters

idstringrequired

Migration ID (e.g. mig_1).

Response

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

Show response fields

gatesarray<object>

Show child attributes

codestring

messagestring

passedboolean

readyboolean

Error codes

400Invalid migration ID format.

404Migration not found.

422Migration is in a terminal state.

RequestPOST/v1/migration/{id}/validatecurl

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

Response200

{
  "success": true,
  "data": {
    "ready": true,
    "gates": [
      {
        "code": "CONTACT_CONFLICTS_REMAIN",
        "passed": true,
        "message": "Contact conflicts resolved"
      },
      {
        "code": "AR_CLEARING_IMBALANCE",
        "passed": true,
        "message": "Clearing accounts balanced"
      },
      {
        "code": "CUTOVER_INVALID",
        "passed": true,
        "message": "Cutover dates aligned"
      }
    ]
  }
}