curl --request PATCH \
--url https://api.gominerva.com/v2/search/matches/{match_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"review_status": "false_positive",
"expected_review_status": "unresolved"
}
'import requests
url = "https://api.gominerva.com/v2/search/matches/{match_id}"
payload = {
"review_status": "false_positive",
"expected_review_status": "unresolved"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({review_status: 'false_positive', expected_review_status: 'unresolved'})
};
fetch('https://api.gominerva.com/v2/search/matches/{match_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/v2/search/matches/{match_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'review_status' => 'false_positive',
'expected_review_status' => 'unresolved'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/v2/search/matches/{match_id}"
payload := strings.NewReader("{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.gominerva.com/v2/search/matches/{match_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/search/matches/{match_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}"
response = http.request(request)
puts response.read_body{
"match": {
"id": "665f1c2b16f5adbb8e1d3f41",
"record_id": "018f4300-0000-7000-8000-000000000001",
"review_status": "false_positive"
}
}{
"message": "review_status must be one of: unresolved, reopened, closed, true_positive, false_positive, suppressed, not_found, true_match, false_match."
}{
"message": "No Such Search Match Found"
}{
"message": "The match disposition changed after it was loaded.",
"current_review_status": "false_positive"
}Update potential match status
Updates the review status of a potential match returned by a search. Use this endpoint after an analyst or downstream workflow has reviewed a search result and needs to record the disposition.
Use the match id from GET /v2/search/matches as match_id, or the screening_match_id from a synchronous POST /v2/search response, which is the same value. The match id stays the same for as long as the match exists, so you can store it and update the match later. A new screening creates new matches with new IDs; it doesn’t reissue earlier ones. Don’t use record_id as match_id: it identifies the source record, not the match.
Supported review_status values:
unresolved: the potential match still needs review.true_positive: the potential match has been confirmed as a true match.false_positive: the potential match has been determined not to match the screened profile.suppressed: the potential match is a repeated or previously known result with no material change. See the Repeated Alert Suppression Guide.closed: the potential match is closed and no longer part of the active review queue.reopened: the potential match has been reopened for review.not_found: a recorded review outcome that neither confirms nor rejects the match. Likeclosed, it takes the match out of the open review queue. Shown as Not found in the Minerva dashboard.
The legacy values true_match and false_match are still accepted for older integrations.
review_status is not case-sensitive, and leading or trailing spaces are ignored. It is always stored in lowercase: CLOSED and False_Positive are stored as closed and false_positive. Requests that send the documented values are unaffected. Only a value outside the list above returns 400 and isn’t saved.
To avoid overwriting a decision someone else made in the meantime, send expected_review_status with the status you last read. The update is applied only if the match still has that status; otherwise the response is 409 with the current status. expected_review_status is compared exactly against the stored value, except that leading or trailing spaces are ignored, so send it exactly as the API returned it.
curl --request PATCH \
--url https://api.gominerva.com/v2/search/matches/{match_id} \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--data '
{
"review_status": "false_positive",
"expected_review_status": "unresolved"
}
'import requests
url = "https://api.gominerva.com/v2/search/matches/{match_id}"
payload = {
"review_status": "false_positive",
"expected_review_status": "unresolved"
}
headers = {
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.patch(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'PATCH',
headers: {'x-api-key': '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({review_status: 'false_positive', expected_review_status: 'unresolved'})
};
fetch('https://api.gominerva.com/v2/search/matches/{match_id}', options)
.then(res => res.json())
.then(res => console.log(res))
.catch(err => console.error(err));<?php
$curl = curl_init();
curl_setopt_array($curl, [
CURLOPT_URL => "https://api.gominerva.com/v2/search/matches/{match_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "PATCH",
CURLOPT_POSTFIELDS => json_encode([
'review_status' => 'false_positive',
'expected_review_status' => 'unresolved'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>"
],
]);
$response = curl_exec($curl);
$err = curl_error($curl);
curl_close($curl);
if ($err) {
echo "cURL Error #:" . $err;
} else {
echo $response;
}package main
import (
"fmt"
"strings"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/v2/search/matches/{match_id}"
payload := strings.NewReader("{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}")
req, _ := http.NewRequest("PATCH", url, payload)
req.Header.Add("x-api-key", "<api-key>")
req.Header.Add("Content-Type", "application/json")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.patch("https://api.gominerva.com/v2/search/matches/{match_id}")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/search/matches/{match_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Patch.new(url)
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"review_status\": \"false_positive\",\n \"expected_review_status\": \"unresolved\"\n}"
response = http.request(request)
puts response.read_body{
"match": {
"id": "665f1c2b16f5adbb8e1d3f41",
"record_id": "018f4300-0000-7000-8000-000000000001",
"review_status": "false_positive"
}
}{
"message": "review_status must be one of: unresolved, reopened, closed, true_positive, false_positive, suppressed, not_found, true_match, false_match."
}{
"message": "No Such Search Match Found"
}{
"message": "The match disposition changed after it was loaded.",
"current_review_status": "false_positive"
}Authorizations
Path Parameters
Body
Potential match status update request
Request body for updating the review status of a potential match returned by a search.
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.
unresolved, true_positive, false_positive, suppressed, closed, reopened, not_found "false_positive"
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.
"unresolved"