> ## Documentation Index
> Fetch the complete documentation index at: https://docs.gominerva.com/llms.txt
> Use this file to discover all available pages before exploring further.

# API Changelog

> Additive changes and clarifications to the Minerva API, newest first.

This page lists changes to the Minerva API that integrations may notice. Unless an entry says otherwise, changes are additive: existing requests keep working and no client change is required.

**2026-11-19**

Match IDs in search responses

Existing fields are unchanged. This update adds two response fields, and clients that ignore them keep working as before.

**New response field: `screening_match_id`.** On a synchronous `POST /v2/search`, each match in `entity_matches` can now include `screening_match_id`, the stored match ID. It is the same value as `id` on `GET /v2/search/matches`, so you can send it as `match_id` to `PATCH /v2/search/matches/{match_id}` straight from the POST response. It is present only when Minerva can line up the stored matches with the matches in the response. If it is missing, read the IDs with `GET /v2/search/matches?request_id=<request_id>`. See [POST /v2/search](https://docs.gominerva.com/api-reference/search/submit-a-v2-search.md) and [Search History](https://docs.gominerva.com/api-reference/search-history.md#match-ids).

**New response field: `record_id`.** Matches returned by `GET /v2/search/matches` and `PATCH /v2/search/matches/{match_id}` can now include `record_id`, the data source's own identifier for the matched record, when the source supplied one. It isn't a match ID, so keep sending `id` as `match_id`. See [List stored potential matches](https://docs.gominerva.com/api-reference/search/list-stored-potential-matches.md).

**2026-11-18**

Search results and match review status

**New response field: `results_stored`.** On a synchronous `POST /v2/search`, an entity's `metadata` can now include `results_stored: false`. It appears only in the rare case that Minerva completed the search but couldn't store that entity's matches. When you see it, that entity's matches may be missing from `GET /v2/search/matches`. If you need them stored, run the search again. The field is absent on normal responses and never changes the status code or any other field, so clients that ignore it are unaffected. See [POST /v2/search](https://docs.gominerva.com/api-reference/search/submit-a-v2-search.md).

**Review status values are checked.** Requests that send the documented values are unaffected. `PATCH /v2/search/matches/{match_id}` accepts the documented `review_status` values in any letter case and stores them in lowercase, so `CLOSED` is stored as `closed`. Only a value outside that list, which Minerva doesn't recognize as a review status, now returns `400` and isn't saved. Before this change such a value was saved, and the match stayed open for review. `expected_review_status` is compared exactly against the stored status. See [Update potential match status](https://docs.gominerva.com/api-reference/potential-matches/update-potential-match-status.md).

**Documentation.** `GET /v2/search/matches` now has a [full reference page](https://docs.gominerva.com/api-reference/search/list-stored-potential-matches.md), and [Search History](https://docs.gominerva.com/api-reference/search-history.md#match-ids) explains how match IDs work: an `id` stays the same for as long as the match exists, and each new screening creates new matches with new IDs.


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.