Skip to main content
API docs by Redocly

Evan - Adverse Media Monitoring (4.7.0)

Download OpenAPI specification:Download

URL: https://www.workfusion.com/digital-workers/evan-ai-agent-for-adverse-media-monitoring/

Rest Api for Evan Adverse Media Monitoring

Start an adverse media monitoring search

Starts an adverse media monitoring search.

Use AmmRequest to start a single investigation. Use AmmBatchRequest to start a batch investigation.

Authorizations:
oauth
path Parameters
signal-id
required
string
Example: cbdbe2a8-2f4b-4240-b3ad-2273ba34902b

This parameter identifies the signal ID for the BP where the record is to be sent. Defaults to null. The parameter type is string. It can be found in the data tab of the business process in Control Tower

Request Body schema: application/json
One of
search_request
required
string

Entity to search. Mandatory

gender
string
Enum: "MALE" "FEMALE"

Entity's gender

entity_type
string
Enum: "COMPANY" "INDIVIDUAL"
residence_operating_country
string

2 letter ISO Country code where the entity resides

citizenship_incorporation_country
string

2 letter ISO Country code where the entity has registered their nationality

subdivision
string

iso_3166_alpha_2_code of the subdivision (State / County / Province etc.)

city
string

City name. Residence country is required to use City in the search request

year_of_birth_incorporation
integer

This is used only if date_of_birth_incorporation is not set

date_of_birth_incorporation
string <Will use the preferred date format set in the Digital Worker settings>

This value will override year_of_birth_incorporation

search_period
integer

value is in days

batch_id
string

Batch identifier for grouping multiple investigations

batch_size
integer

The number of requests in batch. The combined and batch report will not be generated if this field is null

entity_id
string

External ID of the entity

external_id
string

External ID of the request

additional_information
string

Entity Additional Information

add_to_ongoing_monitor
boolean

Add the entity to ongoing monitor

ongoing_monitoring
boolean

Indicates whether the incoming request originates from an ongoing monitoring connector

cost_center_code
string

Cost center team code

cost_center_name
string

Cost center team name

sla_date
string <Will use the preferred date format set in the Digital Worker settings>

Service Level Agreement (SLA) date for filtering in the manual tasks

Array of objects (ArticleInputData)
business_line
string

Business line

screening_service
string

Screening service

investigation_date
string <ISO 8601 datetime format>

The date when investigation was started. Will be set to current time if empty.

initiator
string

Request initiator's name

sla_duration
string

SLA duration in a text format

related_entity_id
string

Related entity ID

_sys_mt_hit_assignee
string
_sys_mt_hit_assigned_user_groups
string
_sys_mt_hit_priority
integer
_sys_user_groups
string

User groups the manual task is restricted to

review_availability_date
string <ISO 8601 datetime format>

The review availability date. Investigations with a date earlier than the current date are filtered out and not displayed in the Workspace.

Responses

Request samples

Content type
application/json
Example
{
  • "search_request": "James Bond",
  • "entity_type": "INDIVIDUAL",
  • "residence_operating_country": "US",
  • "entity_id": "single-entity-001"
}

Response samples

Content type
application/json
{
  • "requestId": "6be8fc11-1701",
  • "status": "IN_PROGRESS",
  • "statusDetails": "In progress"
}

Evan - Adverse Media Monitoring - Check Results

Check status of running business process

Check the status of an adverse media search that has been started

Authorizations:
oauth
path Parameters
request-id
required
string
Example: asd1234

This parameter identifies the request ID for the record. It is returned by the start record operation.

Responses

Response samples

Content type
application/json
{
  • "requestId": "6be8fc11-1701",
  • "status": "IN_PROGRESS",
  • "statusDetails": "In progress"
}

Get adverse media monitoring result

Returns the completed result for an adverse media monitoring request.

The response may be either AmmResponse or BatchAmmResponse.

Authorizations:
oauth
path Parameters
request-id
required
string
Example: asd1234

This parameter identifies the request ID for the record. It is returned by the start record operation.

Responses

Response samples

Content type
application/json
Example
{
  • "runUUID": "a1b2c3d4-e5f6-7890-1234-567890abcdef",
  • "entityName": "James Bond",
  • "investigationStatus": "NEEDS_INVESTIGATION",
  • "articles": [ ]
}

Evan - Adverse Media Monitoring Webhook Triggers

Send manual review to webhook

Will send the alert details sent to manual review to the webhook url configured in Evan's settings

Authorizations:
oauth
Request Body schema: application/json
transactionUUID
string

Unique identifier assigned to the request

runUUID
string

Identifier of the run

batchId
string

Batch identifier for grouping multiple investigations (comes from the request data)

variationUUID
integer

Unique identifier of the variation that was used by investigation

entityId
string

Unique identifier of the screened entity (comes from the request data)

externalId
string

External identifier (comes from the request data)

timestamp
string <date-time>

Response time

startTime
string <date-time>

Execution start time

searchRequest
string

Entity name to be screened

investigationStatus
string
Enum: "FALSE_POSITIVE" "TRUE_POSITIVE" "NEEDS_INVESTIGATION" "NO_RESULTS_FOUND" "EXPIRED" "FAILED"

Status of the investigation

additionalInformation
string

Additional information that should be visible (comes from the request data)

manualTaskUrl
string

Link to the workspace's assignement

status
string

Status of the investigation

Array of objects (ManualReviewAlertArticleInfo)

Responses

Request samples

Content type
application/json
{}

Send final results to webhook

Will send the the final results to the webhook url configured in Evan's settings

Authorizations:
oauth
Request Body schema: application/json
transactionUUID
string

Unique identifier assigned to the request

runUUID
string

Identifier of the run

variationUUID
integer

Unique identifier of the variation that was used by investigation

batchId
string

Batch identifier for grouping multiple investigations (comes from the request data)

entityId
string

Unique identifier of the screened entity (comes from the request data)

externalId
string

External identifier (comes from the request data)

startTime
string <date-time>

Execution start time

reviewStartTime
string <date-time>

Manual task first creation time

reviewEndTime
string <date-time>

Manual task submission time

endTime
string <date-time>

Execution end time

timestamp
string <date-time>

Total execution time

investigationDate
string <date-time>

Investigation's creation date and time

searchRequest
string

Entity name to be screened

investigationStatus
string
Enum: "FALSE_POSITIVE" "TRUE_POSITIVE" "NEEDS_INVESTIGATION" "NO_RESULTS_FOUND" "EXPIRED" "FAILED"

Status of the investigation

mlInvestigationStatus
string
Enum: "FALSE_POSITIVE" "TRUE_POSITIVE" "NEEDS_INVESTIGATION" "NO_RESULTS_FOUND" "EXPIRED" "FAILED"

Investigation status calculated by the ML model

manualReviewInvestigationStatus
string
Enum: "FALSE_POSITIVE" "TRUE_POSITIVE" "NEEDS_INVESTIGATION" "NO_RESULTS_FOUND" "EXPIRED" "FAILED"

Investigation status set on the Manual task on the investigation level

mlModelId
string

Identifier of the ML model version

newsProviders
Array of strings
Items Enum: "GOOGLE" "BRAVE" "FACTIVA_HEADLINES" "LEXIS_NEXIS_LP_MEDIA" "WORLD_CHECK_ONE" "EXTERNAL_SOURCE"

Providers used to get the news

manualTaskExecuted
boolean

Flag to indicate if the manual task was executed

reviewerUUID
string

Unique identifier assigned to the user who reviewed the article

reviewerName
string

Name of User who reviewed the article.

reviewerEmail
string

Email of User who reviewed the investigation.

reviewComment
string

Comments made by the reviewer about the article

reportLink
string

Link to the human readable report generate by the business process

additionalInformation
string

Additional information that should be visible (comes from the request data)

status
string

Status of the investigation

Array of objects (ArticleResponseDto)
shorthandDecision
Array of strings

Pre-defined reason chosen in the Manual Task (values come from Evan settings "Shorthand list of predefined reasons")

mlInvestigationSummary
string

Descriptive summary of articles, generated either by the LLM (when LLM-generated summary is enabled) or from ML decisions + decision reapplication (when disabled). Only one engine produces it per investigation.

manualReviewInvestigationSummary
string

Descriptive summary of articles built from manual review dispositions after the MT was submitted and LLM-generated summary is disabled

Responses

Request samples

Content type
application/json
{
  • "transactionUUID": "f5eff4b5-06bc-4016-8f7d-740ef1023629",
  • "runUUID": "f5eff4b5-06bc-4016-8f7d-740ef1023629",
  • "variationUUID": 7,
  • "batchId": "f5e0ef10236FdpgQf1f29Mp",
  • "entityId": "f5e0ef10236FdpgQf1f29Mp",
  • "externalId": "f5e0ef10236FdpgQf1f29Mp",
  • "startTime": "2019-08-24T14:15:22Z",
  • "reviewStartTime": "2019-08-24T14:15:22Z",
  • "reviewEndTime": "2019-08-24T14:15:22Z",
  • "endTime": "2019-08-24T14:15:22Z",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "investigationDate": "2019-08-24T14:15:22Z",
  • "searchRequest": "James Bond",
  • "investigationStatus": "FALSE_POSITIVE",
  • "mlInvestigationStatus": "NEEDS_INVESTIGATION",
  • "manualReviewInvestigationStatus": "FALSE_POSITIVE",
  • "mlModelId": "amm-classification-v1",
  • "newsProviders": "[\"GOOGLE\"]",
  • "manualTaskExecuted": true,
  • "reviewerUUID": "3b6875ef-78b0-4e9f-a45f-826a78fcf15",
  • "reviewerName": "John Smith",
  • "reviewerEmail": "jsmith@example.com",
  • "reviewComment": "Not relevant",
  • "reportLink": "https://demo.workfusion.io/doc-upload/adverse-media-monitoring/3.2.0-EXPERT-9503/3294af8d-2c98-48d0-a15d-df17057b58b4/084975ba-6950-4bce-ad33-e1d90d2cafd0/report/html/2023-01-10-James-Bond-needs-investigation-084975ba-6950-4bce-ad33-e1d90d2cafd0.html",
  • "additionalInformation": "The subject has a drug addiction",
  • "status": "COMPLETED",
  • "articles": [
    ],
  • "shorthandDecision": "[\"Approved\"]",
  • "mlInvestigationSummary": "string",
  • "manualReviewInvestigationSummary": "string"
}

Send error details to webhook

Will send the error details to the webhook url configured in Evan's settings

Authorizations:
oauth
Request Body schema: application/json
transactionUUID
string

Unique identifier assigned to the request

runUUID
string

Identifier of the run

variationUUID
integer

Unique identifier of the variation that was used by investigation

batchId
string

Batch identifier for grouping multiple investigations (comes from the request data)

batchSize
integer

The number of requests in batch. The combined and batch report will not be generated if this field is null

entityType
string
Enum: "COMPANY" "INDIVIDUAL"

Type of the screened entity

entityId
string

Unique identifier of the screened entity (comes from the request data)

externalId
string

External identifier (comes from the request data)

startTime
string <date-time>

Execution start time

originalSearchRequest
string

Original search request

timestamp
string <date-time>

Response time

status
string

Status of the investigation. Always "FAILED" for error response

errorMessage
string

Human-readable error message describing the failure

Responses

Request samples

Content type
application/json
{
  • "transactionUUID": "f5eff4b5-06bc-4016-8f7d-740ef1023629",
  • "runUUID": "f5eff4b5-06bc-4016-8f7d-740ef1023629",
  • "variationUUID": 7,
  • "batchId": "f5e0ef10236FdpgQf1f29Mp",
  • "batchSize": 20,
  • "entityType": "COMPANY",
  • "entityId": "f5e0ef10236FdpgQf1f29Mp",
  • "externalId": "f5e0ef10236FdpgQf1f29Mp",
  • "startTime": "2019-08-24T14:15:22Z",
  • "originalSearchRequest": "James Bond",
  • "timestamp": "2019-08-24T14:15:22Z",
  • "status": "FAILED",
  • "errorMessage": "Provider rate limit exceeded"
}