---
title: "Start Preflight"
method: POST
path: "/v1/matters/{matter_id}/voidables/preflights/{preflight_id}/runs"
tags: ["voidables"]
---

# Start Preflight

`POST /v1/matters/{matter_id}/voidables/preflights/{preflight_id}/runs`

## Request

- Base URL: `https://api.ender.au` (the document declares no server; this is the origin it was published from)
- URL: `https://api.ender.au/v1/matters/{matter_id}/voidables/preflights/{preflight_id}/runs`
- Auth: HTTP bearer

## Path parameters

- `preflight_id` string, uuid, required
- `matter_id` string, uuid, required

## Headers

- `Idempotency-Key` string, required

## Request body

- StartRunCommand
  - `version` integer, required
  - `source_review` SourceReviewCommand
    - `account_matches` object
    - `account_labels` object
    - `duplicate_keys` string[]
  - `context` RunContextInput, required
    - `matter_type` 'corporate' | 'bankruptcy', required
    - `debtor_names` string[], required
    - `asserted_insolvency_date` string, date, nullable
    - `directors` string[]
    - `associates` string[]
    - `related_entities` string[]
    - `known_creditors` KnownCreditorInput[]
      - `name` string, required
      - `debt_aud` string, decimal, nullable
    - `own_account_tokens` string[]
  - `matter_inputs_version` integer, nullable

## Response `202`

Successful Response

- RunStatus
  - `run_id` string, uuid, required
  - `created_by` string, uuid, required
  - `source_document_ids` string[], required
  - `state` 'queued' | 'parsing' | 'ready' | 'screening' | 'pattern_synthesis' | 'generating_workbook' | 'cancellation_requested' | 'complete' | 'failed' | 'cancelled', required
  - `stage` 'queued' | 'parsing' | 'ready' | 'screening' | 'pattern_synthesis' | 'generating_workbook' | 'cancellation_requested' | 'complete' | 'failed' | 'cancelled', required
  - `version` integer, required
  - `poll_url` string, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `progress` RunProgress, required: Worker progress counters, with the account review once sources parse.
    - `source_review` SourceReviewEvidence: The parsed accounts a preflight asks the practitioner to review.
      - `accounts` SourceReviewAccount[], required
        - `key` string, required
        - `label` string, required
        - `row_ids` integer[], required
        - `sources` SourceReviewSource[], required
          - `document_id` string, uuid, required
          - `filename` string, required
          - `date_from` string, date, required
          - `date_to` string, date, required
          - `row_count` integer, required
        - `duplicates_removed` integer, required
        - `possible_overlap_count` integer, required
        - `possible_duplicates` PossibleDuplicate[], required
          - `key` string, required
          - `reason` string, required
          - `rows` SourceReviewRecord[], required
            - `row_id` integer, required
            - `account_key` string, required
            - `account_source` string, required
            - `filename` string, required
            - `source_document_id` string, uuid, required
            - `source_row_ref` string, nullable, required
            - `date` string, date, required
            - `narration` string, required
            - `direction` 'in' | 'out', required
            - `amount_aud` string, decimal, required
  - `summary` VoidablesRunSummary, required: Stable public projection across historical and current analysis runs.
    - `analysis_stage` 'legal_screening' | 'pattern_synthesis', nullable, required
    - `pattern_synthesis_status` 'pending' | 'in_progress' | 'complete' | 'degraded', nullable, required
    - `total_transactions_reviewed` integer, required
    - `total_flagged` integer, required
    - `total_value_flagged_aud` string, decimal, required
    - `category_totals` object, nullable, required
    - `cash_metrics` CashMetrics, required
      - `total_debits_aud` string, decimal, nullable, required
      - `total_credits_aud` string, decimal, nullable, required
      - `net_cash_flow_aud` string, decimal, nullable, required
    - `category_counts` object, nullable, required
    - `pattern_observation_count` integer, nullable, required
    - `artifact_id` string, uuid, nullable, required
  - `issue` AppModulesVoidablesSchemasRunIssue, required
    - `code` string, required
    - `message` string, required
    - `retryable` boolean, required
    - `required_action` string, nullable, required
  - `warnings` RunWarning[], required
    - `code` string, required
    - `severity` 'warning' | 'info', required
    - `title` string, required
    - `message` string, required
    - `source_document_id` string, uuid, nullable, required
    - `filename` string, nullable, required
    - `count` integer, nullable, required
  - `artifacts` ArtifactAvailability, required
    - `generated` boolean, required
    - `latest_artifact_id` string, uuid, nullable, required
  - `allowed_actions` string[], required

## Other responses

- `422`: Validation Error

---

[API](https://skmtc.dev/ender/apis/ender-backend.md) - [All operations](https://skmtc.dev/ender/apis/ender-backend/llms.txt) - [OpenAPI document](https://skmtc.dev/ender/apis/ender-backend/revisions/bf4373130521?raw)