Skip to main content
PATCH
Update potential match status

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Path Parameters

match_id
string
required

The id of a stored potential match, from GET /v2/search/matches.

Body

application/json

Potential match status update request

Request body for updating the review status of a potential match returned by a search.

review_status
enum<string>
required

New review status for the potential match. Not case-sensitive, and leading or trailing spaces are ignored; always stored in lowercase. The legacy values true_match and false_match are also accepted. Any other value returns 400 and isn't saved.

Available options:
unresolved,
true_positive,
false_positive,
suppressed,
closed,
reopened,
not_found
Example:

"false_positive"

expected_review_status
string

Optional. The review status you last read for this match. When present, the update is applied only if the stored status still equals this value (compared exactly, ignoring leading or trailing spaces). If it doesn't, the response is 409 and nothing is written. Send it exactly as the API returned it.

Example:

"unresolved"

Response

Potential match status updated successfully

match
object