Capture a match for an allowlist entry
curl --request GET \
--url https://api.gominerva.com/v2/allowlist/match-capture/{match_id} \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.gominerva.com/v2/allowlist/match-capture/{match_id}"
headers = {
"x-workspace-id": "<x-workspace-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-workspace-id': '<x-workspace-id>', 'x-api-key': '<api-key>'}
};
fetch('https://api.gominerva.com/v2/allowlist/match-capture/{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/allowlist/match-capture/{match_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/v2/allowlist/match-capture/{match_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gominerva.com/v2/allowlist/match-capture/{match_id}")
.header("x-workspace-id", "<x-workspace-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/allowlist/match-capture/{match_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"match_id": "m_5b1c",
"workspace_id": "ws_payee",
"subject": {
"name": "NATWEST BANK PLC",
"entity_type": "organization",
"date": null,
"country": "United Kingdom",
"country_code": "GB",
"reg_id": null,
"personal_id": null,
"profile_id": null,
"external_id": "payee-88213"
},
"elements": [
{
"index": 0,
"category": "sanctions",
"source": "OFAC SDN",
"record_name": "Natwest Logistics LLC",
"record_key": "sanctions\u001fofac sdn\u001fnatwest logistics llc",
"fingerprint": "sha256:9341f26c078565780b5157f527395fb0bb82fc7f45e36a44aa871c579d5c97da",
"record_aliases": [
"NWL LLC",
"Natwest Logistics"
],
"covered_by": []
}
]
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}Allowlists
Capture a match for an allowlist entry
Read-only. Returns the screened subject of a potential match and, for each non-Internal watchlist record on it, the identity and content fingerprint an allowlist entry can cover, plus the live entries that already cover it. Most integrations call the Admin API’s POST /custom-lists/v2/organizations/{orgId}/{listId}/records/from-match instead, which captures, saves and resolves in one step.
Requires x-workspace-id and an Admin (tenant-wide) application key of the same tenant, or a dashboard owner or admin. Any other key returns 403. A match in another tenant or workspace returns 404.
GET
/
v2
/
allowlist
/
match-capture
/
{match_id}
Capture a match for an allowlist entry
curl --request GET \
--url https://api.gominerva.com/v2/allowlist/match-capture/{match_id} \
--header 'x-api-key: <api-key>' \
--header 'x-workspace-id: <x-workspace-id>'import requests
url = "https://api.gominerva.com/v2/allowlist/match-capture/{match_id}"
headers = {
"x-workspace-id": "<x-workspace-id>",
"x-api-key": "<api-key>"
}
response = requests.get(url, headers=headers)
print(response.text)const options = {
method: 'GET',
headers: {'x-workspace-id': '<x-workspace-id>', 'x-api-key': '<api-key>'}
};
fetch('https://api.gominerva.com/v2/allowlist/match-capture/{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/allowlist/match-capture/{match_id}",
CURLOPT_RETURNTRANSFER => true,
CURLOPT_ENCODING => "",
CURLOPT_MAXREDIRS => 10,
CURLOPT_TIMEOUT => 30,
CURLOPT_HTTP_VERSION => CURL_HTTP_VERSION_1_1,
CURLOPT_CUSTOMREQUEST => "GET",
CURLOPT_HTTPHEADER => [
"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"
"net/http"
"io"
)
func main() {
url := "https://api.gominerva.com/v2/allowlist/match-capture/{match_id}"
req, _ := http.NewRequest("GET", url, nil)
req.Header.Add("x-workspace-id", "<x-workspace-id>")
req.Header.Add("x-api-key", "<api-key>")
res, _ := http.DefaultClient.Do(req)
defer res.Body.Close()
body, _ := io.ReadAll(res.Body)
fmt.Println(string(body))
}HttpResponse<String> response = Unirest.get("https://api.gominerva.com/v2/allowlist/match-capture/{match_id}")
.header("x-workspace-id", "<x-workspace-id>")
.header("x-api-key", "<api-key>")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/v2/allowlist/match-capture/{match_id}")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Get.new(url)
request["x-workspace-id"] = '<x-workspace-id>'
request["x-api-key"] = '<api-key>'
response = http.request(request)
puts response.read_body{
"match_id": "m_5b1c",
"workspace_id": "ws_payee",
"subject": {
"name": "NATWEST BANK PLC",
"entity_type": "organization",
"date": null,
"country": "United Kingdom",
"country_code": "GB",
"reg_id": null,
"personal_id": null,
"profile_id": null,
"external_id": "payee-88213"
},
"elements": [
{
"index": 0,
"category": "sanctions",
"source": "OFAC SDN",
"record_name": "Natwest Logistics LLC",
"record_key": "sanctions\u001fofac sdn\u001fnatwest logistics llc",
"fingerprint": "sha256:9341f26c078565780b5157f527395fb0bb82fc7f45e36a44aa871c579d5c97da",
"record_aliases": [
"NWL LLC",
"Natwest Logistics"
],
"covered_by": []
}
]
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}{
"status": 400,
"code": "error/bad-request",
"message": "<string>",
"reason": "resolve_requires_live_entry"
}