Skip to main content
POST
Single Search Synchronous API

Adverse media risk categories configuration

When News is included in feeds, use global_filters.adverse_media_risk_categories to replace the workspace’s Direct API category set for this search. Send raw category keys from the request schema. The override may narrow or widen the workspace set, and an empty array disables every category for this call. Omit the field to use workspace configuration. See Adverse Media Categories for category definitions, defaults, and precedence.

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-Minerva-Automatic-Disposition
enum<string>

Opts this search request out of Automatic Disposition. The header only has an effect when your organization has been opted into Automatic Disposition and an administrator has enabled it with the Direct API channel turned on in the workspace of the Application whose API key you are using; otherwise it is inert and the search behaves as if the feature is off. Send the value skip (matched case-insensitively) to leave every returned match unresolved even when the feature is enabled for the workspace. Other values are ignored.

Available options:
skip
Example:

"skip"

Body

application/json
type
enum<string>
required

The type of profile to search for.

Available options:
individual,
organization
Example:

"individual"

name
string
required

The full legal name of the search subject.

Example:

"John Smith"

feeds
string[]
required

Array of feeds to include in the search scope.

Example:
gender
string

The gender of the individual (individual searches only).

Example:

"Male"

year
integer

Birth year for individuals or founding year for organizations.

Example:

1970

month
integer

Birth/founding month (1 = January).

Required range: 1 <= x <= 12
Example:

6

day
integer

Birth/founding day.

Required range: 1 <= x <= 31
Example:

11

city
string

City, town, or municipality.

Example:

"Toronto"

state
string

State or province.

Example:

"Ontario"

country
string

Country or nationality.

Example:

"Canada"

occupation
string

Job title or role (individual searches only).

Example:

"Software Developer"

organization
string

Associated organization (individual searches only).

Example:

"Minerva"

address
string

Full address including lines 1 and 2.

phone
string

E.164 compliant international phone number.

email
string

Email address associated with the profile.

personalID
string

Personal ID such as passport or driver's license (individual searches only).

ssn
string

Social Security Number (individual searches only). Encrypted on server side.

regID
string

Registration ID (organization searches only).

notes
string

Additional notes or information.

Example:

"Personal website: www.johnsmith.com"

externalId
string

External identifier for tracking purposes.

Example:

"12345678"

match_threshold
number

Custom match threshold below which results will not be returned.

max_lookback_days
number

Max window in days for supported feeds (currently News feed only).

global_filters
object

Global filtering options that apply to all feeds in the search request.

soft_match
boolean

Whether to use soft matching (default behavior).

location_match_strictness
enum<string>

Geographic exclusion resolution level.

Available options:
city,
state,
country
omit_open_source
boolean

Whether to omit open source feed for feeds that include it automatically.

Response

Search successfully completed. Returns the search results synchronously.

Automatic Disposition (New): when the workspace that owns your API application has Automatic Disposition enabled with the Direct API channel turned on, Minerva analyzes every screened potential match in results[] - one carrying at least one risk flag (Sanctions, PEP, News, Criminal, Legal, and so on) in checklist.screen - before this response returns, which adds a few seconds per screened entity.

  • review_status changes only in Full Auto Mode: a prediction that meets the configured confidence threshold sets true_positive or false_positive, and the applied prediction is returned in automatic_disposition.
  • In Hint Mode the prediction is returned in disposition_hint and review_status stays unresolved - the annotation is advisory, for your integration to interpret in real time.
  • An analysis that completes without meeting a threshold returns disposition_hint with prediction: "undetermined" and the match stays unresolved.

Clean matches and workspaces without the feature enabled never carry these fields. The default response example shows annotated matches. Opt a single request out with the X-Minerva-Automatic-Disposition: skip header (inert unless the feature is enabled for the workspace), and see the Automatic Disposition Guide for consuming these fields in an integration.

status
integer
Example:

200

message
string
Example:

"Search successfully completed."

jobid
string
Example:

"adf48860-6a96-43a4-b008-37eccd139e3a"

duration
number

Elapsed execution time in seconds.

Example:

1.23

searchId
string

Search result identifier. Pass this value as searchResultId when generating a report with POST /v1/reports.

Example:

"69ba0b732908cb3209647d36"

pending
boolean

Whether the synchronous search still has pending work.

Example:

false

Example:

"https://app.gominerva.com/dashboard?requestId=REQUEST_ID&jobId=JOB_ID#results"

request
object
results
object[]

Up to 10 potential matches ranked by criteria match score, resolved using entity resolution technology. Each result is a Profile object containing rich profile information with source lineage.