Update Potential Match Status

curl --request PATCH \
  --url https://api.gominerva.com/v2/search/matches/{match_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "review_status": "false_positive"
}
'

{
  "match": {
    "id": "665f1c2b16f5adbb8e1d3f41",
    "review_status": "false_positive"
  }
}

Potential Matches

Update Potential Match Status

Updates the review status of a potential match returned by a search. Use this endpoint after an analyst or downstream workflow has reviewed a search result and needs to record the disposition.

Supported review_status values:

unresolved: the potential match still needs review.
true_positive: the potential match has been confirmed as a true match.
false_positive: the potential match has been determined not to match the screened profile.
suppressed: the potential match is a repeated or previously known result with no material change.
closed: the potential match is closed and no longer part of the active review queue.
reopened: the potential match has been reopened for review.

PATCH

matches

{match_id}

Update Potential Match Status

curl --request PATCH \
  --url https://api.gominerva.com/v2/search/matches/{match_id} \
  --header 'Content-Type: application/json' \
  --header 'x-api-key: <api-key>' \
  --data '
{
  "review_status": "false_positive"
}
'

{
  "match": {
    "id": "665f1c2b16f5adbb8e1d3f41",
    "review_status": "false_positive"
  }
}

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.

Path Parameters

match_id

string

required

Potential match ID returned by Minerva search results.

Body

application/json

Potential match status update request

Request body for updating the review status of a potential match returned by a search.

review_status

enum<string>

required

New review status for the potential match.

Available options:

unresolved,

true_positive,

false_positive,

suppressed,

closed,

reopened

Example:

"false_positive"

Response

200 - application/json

Potential match status updated successfully

match

object

Show child attributes

Update Profile Group

⌘I