Skip to main content
GET
List stored potential matches

Authorizations

x-api-key
string
header
required

The Minerva API key used for this integration. Manage API keys in the Minerva dashboard under Administration > Developers.

Headers

x-workspace-id
string

Workspace to read from. When present, only matches from this workspace are returned.

Query Parameters

request_id
string

Return the matches of one search request. Use the request_id returned by POST /v2/search, or the id of an item from GET /v2/search/requests.

profile_id
string

Return the matches of one Minerva profile across all of its screenings.

match_ids
string[]

Return only these matches. Pass a comma-separated list or repeat the parameter. Each value must be a 24-character hexadecimal match id; any other value returns 400.

Pattern: ^[0-9a-fA-F]{24}$
review_status
enum<string>[]

Return matches with one of these review statuses, for example unresolved. Pass a comma-separated list or repeat the parameter. Values are compared exactly, so use the lowercase values the API returns.

Available options:
unresolved,
reopened,
true_positive,
false_positive,
suppressed,
closed,
not_found
suppression_reason
enum<string>[]

Filter suppressed matches by their current reason. no_material_change also matches suppressed matches stored without a reason. Unknown values return 400.

Available options:
allowlist,
no_material_change
allowlist_status
enum<string>[]

Filter by allowlist.status, how the allowlist screened the match. Unknown values return 400.

Available options:
suppressed,
would_suppress,
partially_covered,
subject_not_matched,
details_not_matched,
record_not_covered,
record_changed,
entry_expired,
entry_lifetime_exceeded
hit
string[]

Return matches that carry a hit on at least one of these feeds. Use the feed names that appear as keys of a match's hits, for example Sanctions, PEP, Criminal, Legal, News, Open Source, Social Media, Registries, Ownership, Offshore or Internal. Pass a comma-separated list or repeat the parameter. Feed names are case-sensitive.

created_at_from
string

Inclusive lower bound for the match created_at time. Provide an RFC 3339 date-time with a timezone, for example 2026-11-01T00:00:00Z, or a date such as 2026-11-01, which starts at 00:00:00 UTC. A value in any other format returns an empty page rather than an error.

created_at_to
string

Inclusive upper bound for the match created_at time. Provide an RFC 3339 date-time with a timezone, or a date such as 2026-11-30, which runs to 23:59:59.999 UTC. A value in any other format returns an empty page rather than an error.

sort_key
enum<string>
default:created_at

Field to sort by. score sorts by match score, and review_status groups matches by review status. Any other value sorts by created_at.

Available options:
created_at,
score,
review_status
sort_direction
enum<string>
default:desc

Sort direction. Any value other than asc sorts descending.

Available options:
asc,
desc
page
integer
default:1

One-based page number. Defaults to 1.

Required range: x >= 1
limit
integer
default:10

Number of matches per page. Defaults to 10. Values above 250 return 250 matches per page.

Required range: 1 <= x <= 250

Response

A page of stored potential matches.

pagination
object
required
matches
object[]
required
exclude_channels_applied
string[]
review_state_applied
string | null