Test ongoing monitoring (API)

Some data providers offer ongoing monitoring for PEPs, sanctions, and adverse media checks.

With ongoing monitoring, after the check has been run the first time, the profile is monitored for any new matches. If they're discovered, they're displayed on the task.

To find out if you're using ongoing monitoring, first check the configuration article for your data provider to see if ongoing monitoring can be used and whether it's enabled by default. If a configuration option needs to be enabled, use the Policy Builder to see if the configuration option is in use on your account.

To see what happens when new ongoing monitoring results are returned, follow these steps in your demo environment:

  1. Create a profile.
  2. Run the check (via the portal or via the API).
  3. If there are any matches, resolve them. The fastest way to do this is to go to the task in the portal, click the checkbox next to Name, and click Ignore.
  4. Pass the task. Note that your configuration may pass the task automatically when no matches are returned or when all matches are resolved.
  5. Make a request to the endpoint below (or use the cURL command provided) to create a new unresolved event (a.k.a. match) on the profile. If the task becomes incomplete and the new match is displayed in the results, the test is working as expected.
Learn more about what happens when new ongoing monitoring results are returned.

Request endpoint:

POST https://api.passfort.com/4.0/profiles/{profile_id}/events

Body parameters:

Key

Value

Description

data

Required

Object

See the sample requests below for sample values.

Object containing information about the event.

data.event_type

Required

String

One of:

  • PEP_FLAG
  • SANCTION_FLAG
  • ADVERSE_MEDIA_FLAG
  • REFER_FLAG

The type of event.

data.pep

Optional

Object

See the sample request for a PEP match below for a sample value.

Object containing additional information about PEP matches .

data.pep.match

Optional

Boolean

true or false

Whether the match is current.

If this string is not sent, the match will not display the "PEP" flag in the portal.

data.sanctions

Optional

Array of objects

See the sample request for a sanctions match below for a sample value.

Array of objects containing additional information about sanctions matches.

data.sanctions.is_current

Optional

Boolean

true or false

Whether the match is current.

If this field is not sent, the match will not display the "Sanctions" flag in the portal.

resolution

Optional

String

UNRESOLVED

While there are additional values for resolution, you should send UNRESOLVED for the purposes of this test.

Whether the match is a true match, a false positive, or a match that has not been resolved as either.

If no value is sent, the resolution will be UNRESOLVED.

Learn more about the Create a new profile event endpoint, including additional values you can pass in the request, in the Developer Resources.

Sample request for a PEP match

Sample request body:

{
"resolution": "UNRESOLVED",
"data": {
"event_type": "PEP_FLAG",
"match_name": "Blake Carr",
"pep": {
"match": true
}
}
}

Sample cURL command:

curl --location --request POST 'https://api.passfort.com/4.0/profiles/6e39cbec-d338-11ea-85bc-c20bbea0206f/events' \
--header 'apikey: adc5788e3b7fecc161d2a36916750ee10480a8c75841bd' \
--header 'Content-Type: application/json' \
--data-raw '{
"resolution": "UNRESOLVED",
"data": {
"event_type": "PEP_FLAG",
"match_name": "Blake Carr",
"pep": {
"match": true
}
}
}'

Sample request for a sanctions match

Sample request body:

{
"resolution": "UNRESOLVED",
"data": {
"event_type": "SANCTION_FLAG",
"match_name": "Blake Carr",
"sanctions": [
{
"is_current": true
}
]
}
}

Sample cURL command:

curl --location --request POST 'https://api.passfort.com/4.0/profiles/6e39cbec-d338-11ea-85bc-c20bbea0206f/events' \
--header 'apikey: adc5788e3b7fecc161d2a36916750ee10480a8c75841bd' \
--header 'Content-Type: application/json' \
--data-raw '{
"resolution": "UNRESOLVED",
"data": {
"event_type": "SANCTION_FLAG",
"match_name": "Blake Carr",
"sanctions": [
{
"is_current": true
}
]
}
}'
Replace the sample API key with your own when using the cURL commands.


How did we do?


Powered by HelpDocs (opens in a new tab)