Batch Asynchronous Search API

curl --request POST \
  --url https://api.minervaai.io/v1/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "requests": [
    {
      "type": "Individual",
      "name": "John Smith",
      "gender": "Male",
      "year": 1970,
      "month": 6,
      "day": 11,
      "city": "Toronto",
      "state": "Ontario",
      "country": "Canada",
      "occupation": "Software Developer",
      "organization": "MinervaAI",
      "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.8
        }
      }
    }
  ],
  "feeds": [
    "Sanctions",
    "PEP",
    "Criminal",
    "Legal",
    "Ownership",
    "Open Source",
    "Offshore",
    "Registries",
    "News",
    "Social Media"
  ]
}
'

{
  "status": 200,
  "message": "Requests successfully submitted",
  "id": "25e15c07-1322-4364-a26e-2a6ef25c81d4"
}

Batch Asynchronous Search API

“I want to submit a batch of multiple searches at once to Minerva in an asynchronous way so that I can query the long running job later.”

“I want to submit large volumes of searches at once and query the results overnight to update my systems.”

The search endpoint submits a search job and returns a job id which should be used to check on the status of the search. The search is performed in real-time and queries a combination of Minerva internal data as well as open web data.

Performance: The average completion time of a Minerva search varies based on the feeds requested. A full EDD search, which includes all Minerva feeds, usually completes within 45 seconds. For Sanctions and PEP searches, the search time is often in the 300 millisecond to 3 second range.

Matching Algorithm: All parameters are matched softly against the database, using the Minerva scoring algorithm. This means that searches for “Male” gender will not necessarily exclude “Female” gender results if other criteria match strongly enough to the requested parameters. The same is true for geography parameters, where results from nearby cities/states may be returned if enough other criteria match strongly.

Note: This is the batch asynchronous search API endpoint, which is best used for longer running jobs that include lists of multiple searches at once. Obtaining the search results from this endpoint requires storing the job id to query later, or to poll until completion. If your intent is to submit a search for a single profile at a time and obtain the results for those searches immediately, then it would be better to apply the synchronous search API.

POST

Batch Asynchronous Search API

curl --request POST \
  --url https://api.minervaai.io/v1/search \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "requests": [
    {
      "type": "Individual",
      "name": "John Smith",
      "gender": "Male",
      "year": 1970,
      "month": 6,
      "day": 11,
      "city": "Toronto",
      "state": "Ontario",
      "country": "Canada",
      "occupation": "Software Developer",
      "organization": "MinervaAI",
      "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.8
        }
      }
    }
  ],
  "feeds": [
    "Sanctions",
    "PEP",
    "Criminal",
    "Legal",
    "Ownership",
    "Open Source",
    "Offshore",
    "Registries",
    "News",
    "Social Media"
  ]
}
'

{
  "status": 200,
  "message": "Requests successfully submitted",
  "id": "25e15c07-1322-4364-a26e-2a6ef25c81d4"
}

Authorizations

x-api-key

string

header

required

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

Body

application/json

requests

object[]

required

A list of JSON objects, each object corresponding to a single individual or entity in the batch.

Show child attributes

feeds

enum<string>[]

required

The allowed values for MinervaAI search feeds in the request. Provide one or a combination of the feed names, or the "all" value, which will automatically engage all the available search feeds.

Show child attributes

Response

Requests successfully submitted. Returns a job ID that should be used with the /searchStatus endpoint to check on the status of the search and retrieve results when complete.

status

integer

Example:

200

message

string

Example:

"Requests successfully submitted"

string<uuid>

Use this ID in the /searchStatus endpoint to get the status of the job and the search results.

Example:

"25e15c07-1322-4364-a26e-2a6ef25c81d4"

Batch Search Results API Send API Result to User

⌘I

API Documentation

Core - Endpoints

Admin API - Endpoints

CLM API - Endpoints

Batch Asynchronous Search API

Authorizations

Body

Response