---
title: "Restore Search"
method: POST
path: "/v1/matters/{matter_id}/searches/{search_id}/restore"
tags: ["searches"]
---

# Restore Search

`POST /v1/matters/{matter_id}/searches/{search_id}/restore`

## 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}/searches/{search_id}/restore`
- Auth: HTTP bearer

## Path parameters

- `search_id` string, uuid, required
- `matter_id` string, uuid, required

## Request body

- ChangeMatterSearchArchive
  - `expected_version` integer, required

## Response `200`

Successful Response

- MatterSearch: A search retained in the matter-wide ledger. `result_summary` is set on history rows whose search type has structured extraction and whose result is retained.
  - `id` string, uuid, required
  - `matter_id` string, uuid, required
  - `operation_id` string, uuid, required
  - `origin` 'day_ones' | 'investigation', required
  - `search_type` 'abn_lookup' | 'afsa_notices' | 'aml_individual' | 'aml_organisation' | 'asic_ppsr_combined' | 'asset_search' | 'asic_business_current' | 'asic_business_historical' | 'asic_current' | 'asic_document_image' | 'asic_historical' | 'asic_individual' | 'asic_individual_historical' | 'asic_professional_register' | 'asic_unclaimed_monies' | 'banned_persons' | 'company_credit_report' | 'criminal_history' | 'insolvency_notices' | 'infotrack_other' | 'litigation_individual' | 'litigation_organisation' | 'national_property_individual' | 'national_property_organisation' | 'npii' | 'person_locator' | 'ppsr_historical_registration' | 'ppsr_individual' | 'ppsr_ordinal' | 'ppsr_organisation' | 'ppsr_registration' | 'ppsr_registration_certificate' | 'ppsr_serial' | 'title_address' | 'title_lot_plan' | 'title_owner' | 'title_plan_dealing' | 'property_certificate' | 'title_reference' | 'title_watch' | 'vehicle_search' | 'web_search', required: Every typed search result that can be retained with a matter.
  - `subject_kind` 'organisation' | 'individual' | 'property' | 'asset', required
  - `subject_key` string, required
  - `subject_id` string, uuid, nullable, required
  - `subject_label` string, nullable, required
  - `display_name` string, nullable, required
  - `director_id` string, uuid, nullable, required
  - `provider` 'infotrack' | 'manual' | 'asic_public', required
  - `state` 'queued' | 'dispatching' | 'unknown_outcome' | 'reconciling' | 'waiting' | 'completed' | 'failed' | 'cancelled' | 'not_required', required
  - `client_reference` string, required
  - `provider_order_id` string, nullable, required
  - `provider_price_aud` string, decimal, nullable, required
  - `actual_cost_aud` string, decimal, nullable, required
  - `actual_gst_aud` string, decimal, nullable, required
  - `actual_cost_supplier` string, nullable, required
  - `actual_cost_date` string, date, nullable, required
  - `actual_cost_invoice_document_id` string, uuid, nullable, required
  - `actual_cost_updated_by` string, uuid, nullable, required
  - `actual_cost_updated_by_name` string, nullable, required
  - `actual_cost_updated_at` string, date-time, nullable, required
  - `completed_at` string, date-time, nullable, required
  - `result_sha256` string, nullable, required
  - `result_count` integer, nullable, required
  - `extraction_status` 'extracting' | 'completed', nullable, required
  - `safe_issue_code` string, nullable, required
  - `safe_issue_detail` string, nullable, required
  - `archived_at` string, date-time, nullable, required
  - `replaces_search_id` string, uuid, nullable, required
  - `version` integer, required
  - `created_at` string, date-time, required
  - `updated_at` string, date-time, required
  - `result_summary` SearchResultSummary, required
    - `outcome` 'clear' | 'adverse_finding' | 'items_found' | 'extracting' | 'unavailable', required: What a retained result found, as the Searches list summarises it. `clear` means the source confirms no records, `adverse_finding` that at least one flag is adverse and `items_found` that records have no adverse flag. `extracting` and `unavailable` say the result cannot be summarised yet or at all, and are never shown as clear.
    - `facts` string[], required
    - `flags` SearchSummaryFlag[], required
      - `label` string, required
      - `adverse` boolean, required
    - `details` SearchSummaryDetail[], required
      - `label` string, required
      - `values` 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)
