Skip to main content
POST
/
v1
/
search-sync
Single Search Synchronous API (POST)
curl --request POST \
  --url https://api.minervaai.io/v1/search-sync \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "type": "individual",
  "name": "John Smith",
  "feeds": [
    "Sanctions",
    "PEP",
    "News"
  ],
  "gender": "Male",
  "year": 1970,
  "month": 6,
  "day": 11,
  "city": "Toronto",
  "state": "Ontario",
  "country": "Canada",
  "occupation": "Software Developer",
  "organization": "Minerva",
  "address": "<string>",
  "phone": "<string>",
  "email": "<string>",
  "personalID": "<string>",
  "ssn": "<string>",
  "regID": "<string>",
  "notes": "Personal website: www.johnsmith.com",
  "externalId": "12345678",
  "match_threshold": 123,
  "max_lookback_days": 123,
  "soft_match": true,
  "location_match_strictness": "city",
  "omit_open_source": true
}
'
{
  "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.

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:
["Sanctions", "PEP", "News"]
​
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).

​
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.

​
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, resolved using entity resolution technology