Resolve open matches with an allowlist entry
curl --request POST \
--url https://api.gominerva.com/v2/allowlist/resolve \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"match_ids": [
"MATCH_ID"
],
"list_id": "LIST_ID",
"record_uid": "al_ENTRY_UID",
"version_id": "VERSION_ID"
}
'import requests
url = "https://api.gominerva.com/v2/allowlist/resolve"
payload = {
"match_ids": ["MATCH_ID"],
"list_id": "LIST_ID",
"record_uid": "al_ENTRY_UID",
"version_id": "VERSION_ID"
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
match_ids: ['MATCH_ID'],
list_id: 'LIST_ID',
record_uid: 'al_ENTRY_UID',
version_id: 'VERSION_ID'
})
};
fetch('https://api.gominerva.com/v2/allowlist/resolve', 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/allowlist/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'match_ids' => [
'MATCH_ID'
],
'list_id' => 'LIST_ID',
'record_uid' => 'al_ENTRY_UID',
'version_id' => 'VERSION_ID'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-workspace-id: <x-workspace-id>"
],
]);
$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/allowlist/resolve"
payload := strings.NewReader("{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
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.post("https://api.gominerva.com/v2/allowlist/resolve")
.header("x-workspace-id", "<x-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/allowlist/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}"
response = http.request(request)
puts response.read_body{
"resolved_match_ids": [
"m_5b1c"
],
"skipped": [
{
"match_id": "m_77aa",
"reason": "record_not_covered"
}
]
}{
"status": 400,
"code": "error/bad-request",
"message": "The named version exceeds the supported allowlist size, so it cannot be used for this list.",
"reason": "resolve_requires_live_entry"
}{
"status": 403,
"code": "auth/unauthorized",
"message": "This credential cannot manage allowlists: an admin tenant key or an owner/admin user is required."
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}Allowlists
Resolve open matches with an allowlist entry
Marks open matches (no review status, or unresolved) as suppressed with suppression_reason: allowlist when the named live entry covers them, using the same rules as screening. Each accepted match is updated once, with the caller recorded as the actor. Matches that are not accepted, not open, unknown or in another workspace are returned in skipped[], never as an error, so one bad id does not hide the others. The response is 200 even when every match is skipped.
Most integrations use from-match with resolve_match: true instead. Same credential rule as the capture route.
POST
/
v2
/
allowlist
/
resolve
Resolve open matches with an allowlist entry
curl --request POST \
--url https://api.gominerva.com/v2/allowlist/resolve \
--header 'Content-Type: application/json' \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>' \
--data '
{
"match_ids": [
"MATCH_ID"
],
"list_id": "LIST_ID",
"record_uid": "al_ENTRY_UID",
"version_id": "VERSION_ID"
}
'import requests
url = "https://api.gominerva.com/v2/allowlist/resolve"
payload = {
"match_ids": ["MATCH_ID"],
"list_id": "LIST_ID",
"record_uid": "al_ENTRY_UID",
"version_id": "VERSION_ID"
}
headers = {
"x-workspace-id": "<x-workspace-id>",
"x-api-key": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {
'x-workspace-id': '<x-workspace-id>',
'x-api-key': '<api-key>',
'Content-Type': 'application/json'
},
body: JSON.stringify({
match_ids: ['MATCH_ID'],
list_id: 'LIST_ID',
record_uid: 'al_ENTRY_UID',
version_id: 'VERSION_ID'
})
};
fetch('https://api.gominerva.com/v2/allowlist/resolve', 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/allowlist/resolve",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "POST",
CURLOPT_POSTFIELDS => json_encode([
'match_ids' => [
'MATCH_ID'
],
'list_id' => 'LIST_ID',
'record_uid' => 'al_ENTRY_UID',
'version_id' => 'VERSION_ID'
]),
CURLOPT_HTTPHEADER => [
"Content-Type: application/json",
"x-api-key: <api-key>",
"x-workspace-id: <x-workspace-id>"
],
]);
$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/allowlist/resolve"
payload := strings.NewReader("{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
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.post("https://api.gominerva.com/v2/allowlist/resolve")
.header("x-workspace-id", "<x-workspace-id>")
.header("x-api-key", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/allowlist/resolve")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["x-api-key"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_ids\": [\n \"MATCH_ID\"\n ],\n \"list_id\": \"LIST_ID\",\n \"record_uid\": \"al_ENTRY_UID\",\n \"version_id\": \"VERSION_ID\"\n}"
response = http.request(request)
puts response.read_body{
"resolved_match_ids": [
"m_5b1c"
],
"skipped": [
{
"match_id": "m_77aa",
"reason": "record_not_covered"
}
]
}{
"status": 400,
"code": "error/bad-request",
"message": "The named version exceeds the supported allowlist size, so it cannot be used for this list.",
"reason": "resolve_requires_live_entry"
}{
"status": 403,
"code": "auth/unauthorized",
"message": "This credential cannot manage allowlists: an admin tenant key or an owner/admin user is required."
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}Authorizations
Body
application/json