curl --request POST \
--url https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"workspace_id": "64b1c0de00000000000000a2",
"record_uid": null,
"records": "all_uncovered",
"name": "NatWest Bank",
"aliases": [
"NatWest"
],
"entity_type": "organization",
"scope": "known_records",
"match_rules": null,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14",
"resolve_match": true,
"resolve_other_open_matches": false,
"create_separate": false,
"publish": true,
"expected_revision": 41
}
'import requests
url = "https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match"
payload = {
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"workspace_id": "64b1c0de00000000000000a2",
"record_uid": None,
"records": "all_uncovered",
"name": "NatWest Bank",
"aliases": ["NatWest"],
"entity_type": "organization",
"scope": "known_records",
"match_rules": None,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14",
"resolve_match": True,
"resolve_other_open_matches": False,
"create_separate": False,
"publish": True,
"expected_revision": 41
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
match_id: '665f0d4c2d2f7c2b2f2f2f31',
workspace_id: '64b1c0de00000000000000a2',
record_uid: null,
records: 'all_uncovered',
name: 'NatWest Bank',
aliases: ['NatWest'],
entity_type: 'organization',
scope: 'known_records',
match_rules: null,
reason: 'Payee is NatWest Bank, the UK clearing bank',
expires_at: '2027-11-14',
resolve_match: true,
resolve_other_open_matches: false,
create_separate: false,
publish: true,
expected_revision: 41
})
};
fetch('https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match', 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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match",
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_id' => '665f0d4c2d2f7c2b2f2f2f31',
'workspace_id' => '64b1c0de00000000000000a2',
'record_uid' => null,
'records' => 'all_uncovered',
'name' => 'NatWest Bank',
'aliases' => [
'NatWest'
],
'entity_type' => 'organization',
'scope' => 'known_records',
'match_rules' => null,
'reason' => 'Payee is NatWest Bank, the UK clearing bank',
'expires_at' => '2027-11-14',
'resolve_match' => true,
'resolve_other_open_matches' => false,
'create_separate' => false,
'publish' => true,
'expected_revision' => 41
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match"
payload := strings.NewReader("{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}"
response = http.request(request)
puts response.read_body{
"data": {
"entry": {
"record_uid": "al_be8ed741b581485c4d5668ee",
"status": "active",
"name": "NatWest Bank",
"aliases": [
"NatWest",
"National Westminster Bank"
],
"entity_type": "organization",
"countries": [
"GB"
],
"scope": "known_records",
"covers": [
{
"category": "sanctions",
"source": "OFAC SDN",
"record_name": "Natwest Logistics LLC",
"added_by": {
"type": "user",
"id": "u_8d1e",
"name": "A. Analyst"
},
"added_at": "2026-11-14T10:02:00Z"
}
],
"match_rules": null,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14T00:00:00Z",
"added_by": {
"type": "user",
"id": "u_8d1e",
"name": "A. Analyst"
},
"added_at": "2026-11-14T10:02:00Z",
"custom_fields": {}
},
"working_set_revision": 43,
"published_version_id": "7c6b5a4d-3e2f-4a1b-8c9d-0e1f2a3b4c5e",
"resolved_match_ids": [],
"skipped": [
{
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"reason": "not_live_yet"
}
],
"warnings": []
}
}Add a customer to an allowlist from a match
Adds the screened customer of a potential match to an allowlist and covers the match’s records as captured, so a later change to a record alerts again (record_changed). Optionally publishes the list and marks the match, and the profile’s other open matches the entry covers, suppressed with suppression_reason: allowlist.
Order: authorize; read the match capture; check the workspace’s allowlist scope and match rules and the listed-party guard; when resolve_match is true and publish is false, require the entry to be live (resolve_requires_live_entry, nothing written); write the entry; publish when asked; resolve. A stale expected_revision returns 409 conflict and the entry stays in the working set. A match the entry cannot mark yet, because the version the entry is in is not yet readable by screening or the list’s live version changed while the request ran, is reported in skipped[] with not_live_yet, never as an error. The entry is saved.
Requires an admin API key, the Admin (tenant-wide) key type, which only an owner or admin of this organization can create. With x-user-token, the user must be an owner or admin.
curl --request POST \
--url https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match \
--header 'Authorization: <api-key>' \
--header 'Content-Type: application/json' \
--data '
{
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"workspace_id": "64b1c0de00000000000000a2",
"record_uid": null,
"records": "all_uncovered",
"name": "NatWest Bank",
"aliases": [
"NatWest"
],
"entity_type": "organization",
"scope": "known_records",
"match_rules": null,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14",
"resolve_match": true,
"resolve_other_open_matches": false,
"create_separate": false,
"publish": true,
"expected_revision": 41
}
'import requests
url = "https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match"
payload = {
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"workspace_id": "64b1c0de00000000000000a2",
"record_uid": None,
"records": "all_uncovered",
"name": "NatWest Bank",
"aliases": ["NatWest"],
"entity_type": "organization",
"scope": "known_records",
"match_rules": None,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14",
"resolve_match": True,
"resolve_other_open_matches": False,
"create_separate": False,
"publish": True,
"expected_revision": 41
}
headers = {
"Authorization": "<api-key>",
"Content-Type": "application/json"
}
response = requests.post(url, json=payload, headers=headers)
print(response.text)const options = {
method: 'POST',
headers: {Authorization: '<api-key>', 'Content-Type': 'application/json'},
body: JSON.stringify({
match_id: '665f0d4c2d2f7c2b2f2f2f31',
workspace_id: '64b1c0de00000000000000a2',
record_uid: null,
records: 'all_uncovered',
name: 'NatWest Bank',
aliases: ['NatWest'],
entity_type: 'organization',
scope: 'known_records',
match_rules: null,
reason: 'Payee is NatWest Bank, the UK clearing bank',
expires_at: '2027-11-14',
resolve_match: true,
resolve_other_open_matches: false,
create_separate: false,
publish: true,
expected_revision: 41
})
};
fetch('https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match', 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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match",
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_id' => '665f0d4c2d2f7c2b2f2f2f31',
'workspace_id' => '64b1c0de00000000000000a2',
'record_uid' => null,
'records' => 'all_uncovered',
'name' => 'NatWest Bank',
'aliases' => [
'NatWest'
],
'entity_type' => 'organization',
'scope' => 'known_records',
'match_rules' => null,
'reason' => 'Payee is NatWest Bank, the UK clearing bank',
'expires_at' => '2027-11-14',
'resolve_match' => true,
'resolve_other_open_matches' => false,
'create_separate' => false,
'publish' => true,
'expected_revision' => 41
]),
CURLOPT_HTTPHEADER => [
"Authorization: <api-key>",
"Content-Type: application/json"
],
]);
$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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match"
payload := strings.NewReader("{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}")
req, _ := http.NewRequest("POST", url, payload)
req.Header.Add("Authorization", "<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/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match")
.header("Authorization", "<api-key>")
.header("Content-Type", "application/json")
.body("{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}")
.asString();require 'uri'
require 'net/http'
url = URI("https://api.gominerva.com/custom-lists/v2/organizations/{orgId}/{listId}/records/from-match")
http = Net::HTTP.new(url.host, url.port)
http.use_ssl = true
request = Net::HTTP::Post.new(url)
request["Authorization"] = '<api-key>'
request["Content-Type"] = 'application/json'
request.body = "{\n \"match_id\": \"665f0d4c2d2f7c2b2f2f2f31\",\n \"workspace_id\": \"64b1c0de00000000000000a2\",\n \"record_uid\": null,\n \"records\": \"all_uncovered\",\n \"name\": \"NatWest Bank\",\n \"aliases\": [\n \"NatWest\"\n ],\n \"entity_type\": \"organization\",\n \"scope\": \"known_records\",\n \"match_rules\": null,\n \"reason\": \"Payee is NatWest Bank, the UK clearing bank\",\n \"expires_at\": \"2027-11-14\",\n \"resolve_match\": true,\n \"resolve_other_open_matches\": false,\n \"create_separate\": false,\n \"publish\": true,\n \"expected_revision\": 41\n}"
response = http.request(request)
puts response.read_body{
"data": {
"entry": {
"record_uid": "al_be8ed741b581485c4d5668ee",
"status": "active",
"name": "NatWest Bank",
"aliases": [
"NatWest",
"National Westminster Bank"
],
"entity_type": "organization",
"countries": [
"GB"
],
"scope": "known_records",
"covers": [
{
"category": "sanctions",
"source": "OFAC SDN",
"record_name": "Natwest Logistics LLC",
"added_by": {
"type": "user",
"id": "u_8d1e",
"name": "A. Analyst"
},
"added_at": "2026-11-14T10:02:00Z"
}
],
"match_rules": null,
"reason": "Payee is NatWest Bank, the UK clearing bank",
"expires_at": "2027-11-14T00:00:00Z",
"added_by": {
"type": "user",
"id": "u_8d1e",
"name": "A. Analyst"
},
"added_at": "2026-11-14T10:02:00Z",
"custom_fields": {}
},
"working_set_revision": 43,
"published_version_id": "7c6b5a4d-3e2f-4a1b-8c9d-0e1f2a3b4c5e",
"resolved_match_ids": [],
"skipped": [
{
"match_id": "665f0d4c2d2f7c2b2f2f2f31",
"reason": "not_live_yet"
}
],
"warnings": []
}
}Authorizations
Path Parameters
Body
Adds the screened customer of a potential match to an allowlist, covering the match's watchlist records exactly as Minerva captured them. This is the only way to pin a record's content (record_ref) from the API. Customer fields default to the screened subject when omitted.
Which of the match's records to cover: "all_uncovered" (the default), or a list of {category, source, record_name} taken from the match. A record that is not on the match returns 422 with error: record_not_on_match. With "all_uncovered", a match whose records are all already covered returns 422 with error: no_uncovered_records.
all_uncovered true (the default) also marks this match suppressed with suppression_reason: allowlist; send false to save the entry without resolving. The entry must be live: send publish: true, or the entry must already be in the live version, otherwise 400 with error: resolve_requires_live_entry and nothing is written.