Skip to main content
GET
/
v1
/
search
/
{jobid}
Batch Search Results API
curl --request GET \
  --url https://api.minervaai.io/v1/search/{jobid} \
  --header 'x-api-key: <api-key>'
{
  "status": 200,
  "response": "complete",
  "submitted": 42,
  "completed": 42,
  "results": [
    {
      "id": "1624676726659826",
      "duration": 29.322528839111328,
      "jobid": "25e15c07-1322-4364-a26e-2a6ef25c81d4",
      "status": "complete",
      "uid": "YOUR ACCOUNT UID",
      "dashboardViewLink": "https://app.minervaai.io/dashboard?requestId=REQUEST_ID&jobId=JOB_ID#results",
      "request": {
        "name": "Alexander Lukashenko",
        "gender": "Male",
        "city": "Minsk",
        "type": "individual",
        "country": "Belarus",
        "custom_id": "1234567890",
        "feeds": [
          "Sanctions",
          "Criminal",
          "PEP",
          "Offshore",
          "News",
          "Social Media",
          "Open Source",
          "Ownership",
          "Legal",
          "Registries"
        ],
        "CRR": {
          "crossBorder": true,
          "allowRemote": true,
          "fastTransfer": false,
          "allowThirdParty": false
        },
        "global_filters": {
          "location_match_strictness": "state",
          "match_threshold": 0.8,
          "soft_match": "false"
        },
        "feed_filters": {}
      },
      "results": [
        {
          "score": 1,
          "type": 0,
          "last_updated": "Saturday, Jun 26 2021 - 03:05:55 GMT00:00",
          "name": {
            "value": "Alexander Ryhoravich Lukashenko",
            "first": {
              "value": "Alexander",
              "sources": [
                {}
              ]
            },
            "last": {
              "value": "Lukashenko",
              "sources": [
                {}
              ]
            },
            "other_names": [
              {
                "value": "Ryhoravich"
              }
            ]
          }
        }
      ]
    }
  ]
}

Authorizations

x-api-key
string
header
required

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

Path Parameters

jobid
string<uuid>
required

The job ID of a former search submission to the search POST endpoint.

Response

The job id was valid, and either the status or the full search results are returned.

status
integer
Example:

200

response
enum<string>

The current status of the batch search job

Available options:
complete,
pending,
error
Example:

"complete"

submitted
integer

Total number of search requests submitted in the batch

Example:

42

completed
integer

Number of search requests completed so far

Example:

42

results
object[]

Array of search results (only present when response is "complete")