Skip to main content
POST
Add a customer to an allowlist from a match

Authorizations

Authorization
string
header
required

An admin application key: Authorization: Api-Key <token> (or legacy x-api-key). Only tenant owners and admins can create one. Standard keys are refused with 403 on workspace management and tenant configuration routes.

Path Parameters

orgId
string
required

The organization (tenant) id. Must equal the tenant of the admin key.

listId
string
required

The custom list id.

Body

application/json

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.

match_id
string
required

The potential match id from a search response or GET /v2/search/matches.

workspace_id
string
required

The workspace the match belongs to.

reason
string
required
expires_at
string
required
record_uid
string | null

Add the covers to this existing entry instead of creating one. null creates or merges by the derived identity.

records

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.

Available options:
all_uncovered
name
string
aliases
string[]
entity_type
enum<string>
Available options:
individual,
organization,
unknown
date_of_birth
string | null
date_of_incorporation
string | null
countries
string[]

ISO 3166-1 alpha-2 codes the entry is limited to. Defaults to the screened country's code. If Minerva could not confirm the screened country, omitting this returns 400 country_unresolved and nothing is written; send the codes explicitly, or [] for no country.

identifiers
object

Optional identifiers. When set, a screened subject that carries a different value is not accepted (matched_on.comparison[].result: different).

customer_ids
string[]
scope

"known_records" (default), {"source": ["..."]} or {"category": "pep"}. A scope the workspace's allowlist.feedPolicy does not allow for the match's feed returns 400 with error: allowlist_scope_not_allowed.

Available options:
known_records
match_rules
object | null

A level looser than the workspace's effective level for the match's feeds returns 400 with error: allowlist_match_rules_not_allowed.

Example:
review_by
string | null
resolve_match
boolean
default:true

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.

resolve_other_open_matches
boolean
default:false

With resolve_match, also mark the profile's other open matches the entry covers (up to 200). Direct API matches have no profile, so there are none.

create_separate
boolean
default:false

true skips the similar-entry check (allowlist_similar_entry_exists) and creates a separate entry. It never skips the exact-identity check.

publish
boolean
default:false
expected_revision
integer

Required when publish is true.

Response

OK: the covers were merged into an existing entry.

data
object
required