Skip to main content
GET
/
v1
/
search-sync
Single Search Synchronous API (GET)
curl --request GET \
  --url https://api.minervaai.io/v1/search-sync \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "message": "Search successfully completed.",
  "jobid": "adf48860-6a96-43a4-b008-37eccd139e3a",
  "dashboardViewLink": "https://app.minervaai.io/dashboard?requestId=REQUEST_ID&jobId=JOB_ID#results",
  "request": {
    "type": "Individual",
    "name": "John Smith",
    "gender": "Male",
    "year": 1970,
    "month": 6,
    "day": 11,
    "city": "Toronto",
    "state": "Ontario",
    "country": "Canada",
    "occupation": "Software Developer",
    "organization": "MinervaAI",
    "email": "[email protected]",
    "phone": "+15555555555",
    "personalID": "A1234-BCDEF-GHIJK",
    "regID": "19288709",
    "notes": "Personal website: www.johnsmith.com",
    "externalId": "12345678",
    "global_filters": {
      "location_match_strictness": "city",
      "match_threshold": 0.8,
      "soft_match": true
    },
    "feed_filters": {
      "Sanctions": {
        "location_match_strictness": "country",
        "soft_match": true,
        "match_threshold": 0.9
      }
    },
    "custom_id": "customer_01"
  },
  "results": [
    {}
  ]
}

Authorizations

​
x-api-key
string
header
required

The uuidv4 API key associated with the MinervaAI account making the request.

Query Parameters

​
type
enum<string>
required

The type of profile to search for. Should be "individual" or "organization".

Available options:
individual,
organization
​
name
string
required

The full legal name of the search subject.

​
feeds
string
required

A comma-separated array of feeds to include in the scope of the search. Must be selected from "Sanctions", "PEP", "Criminal", "Legal", "Offshore", "Open Source", "Ownership", "News", "Registries", "Social Media", or "all". Use "all" to select all available feeds.

​
gender
string

The gender of the individual. Only applicable for individual type searches. Matched softly.

​
year
integer

The full year integer describing when the individual was born, or that the organization was founded.

​
month
integer

The month integer describing when the individual was born, or that the organization was founded. Corresponds to calendar month integers (1 = January).

Required range: 1 <= x <= 12
​
day
integer

The calendar day integer describing when the individual was born, or that the organization was founded.

Required range: 1 <= x <= 31
​
city
string

The currently known town, city, or municipality of the profile.

​
state
string

The currently known state or province of the profile.

​
country
string

The currently known country or nationality of the profile.

​
occupation
string

The current job title or role of the individual. Only applicable for individual type searches.

​
organization
string

The current organization that the individual is associated with. Only applicable for individual type searches.

​
notes
string

Additional notes or information to narrow the results.

​
externalId
string

External identifier for tracking purposes.

​
address
string

The currently known address of the profile. Can include lines 1 and 2 in a single line.

​
phone
string

A E.164 compliant international phone number string associated with the profile.

​
email
string

A known email address associated with the profile.

​
regID
string

The registration ID of the organization. Only applicable for organization type searches.

​
match_threshold
number

Custom match threshold on the profile match score, below which results will not be returned.

​
max_lookback_days
number

Applies a max window on time in days for supported feeds. Currently only supported on the "News" feed for adverse media.

​
soft_match
boolean

Determines whether or not to use soft match. All parameters are matched softly using the Minerva scoring algorithm.

​
location_match_strictness
enum<string>

Applies a hard exclusion for any data points that do not match the geography at the specified resolution. Allowed values are "city", "state", and "country".

Available options:
city,
state,
country
​
omit_open_source
boolean

Determines whether or not to omit the open source feed for certain feeds that automatically include open source (e.g., PEP).

Response

Search successfully completed. Returns the search results synchronously.

​
status
integer
Example:

200

​
message
string
Example:

"Search successfully completed."

​
jobid
string
Example:

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

​
dashboardViewLink
string
Example:

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

​
request
object
​
results
object[]

Up to 10 potential matches ranked by criteria match score