Skip to main content
API docs by Redocly

Evelyn - Name Sanctions Screening (NSS) (2.0.0) (1.0)

Download OpenAPI specification:Download

URL: https://www.workfusion.com/digital-workers/evelyn

Name Screening AlertRequest Review for Sanctions and Politically Exposed Persons or Name Screening AlertRequest Review is a skill of the Digital Worker Evelyn and a critical component of "Know Your Customer" (KYC) and Anti-Money Laundering (AML) guidelines. The automation is designed to identify sanctioned individuals, entities, securities, or all relevant names during on-boarding and throughout the customer relationship's lifecycle that may pose a risk to the institution.

Evelyn NSS

Submit full alertRequest for screening

Authorizations:
oauth
path Parameters
signalId
required
string

signal ID for the BP where the record is to be sent

Request Body schema: application/json

AlertRequest to be screened. All fields besides input_id, input_full_name are optional.

input_id
string

Customer identification number

input_full_name
string

Customer Full Name

input_first_name
string

Customer First Name

input_middle_name
string

Customer Middle Name

input_last_name
string

Customer Last Name

input_record_type
string
Enum: "INDIVIDUAL" "ORGANIZATION" "SECURITIES"

Customer entity type

input_gender
string
Enum: "MALE" "FEMALE" "OTHER"

Customer gender in case Individual screening

Array of objects (Address)

Customer Address information

Array of objects (Date)

Customer Date information

input_aliases
Array of strings

Customer alias names

object

Customer identifiers

object

Customer Additional Data

category
string

Customer category

Array of objects (HitRequest)

Hits associated with this AlertRequest

object

Configuration parameters to be sent to Digital Worker

client_id
string

Unique identifier for each client

input_gold_resolution
string

Gold resolution for the alert.

add_to_ongoing_monitor
boolean

Add to ongoing monitor

Responses

Request samples

Content type
application/json
{
  • "input_id": "string",
  • "input_full_name": "string",
  • "input_first_name": "string",
  • "input_middle_name": "string",
  • "input_last_name": "string",
  • "input_record_type": "INDIVIDUAL",
  • "input_gender": "MALE",
  • "input_address": [
    ],
  • "input_date": [
    ],
  • "input_aliases": [
    ],
  • "identifiers": {
    },
  • "additional_data": {
    },
  • "category": "string",
  • "hits": [
    ],
  • "configuration": {
    },
  • "client_id": "string",
  • "input_gold_resolution": "string",
  • "add_to_ongoing_monitor": true
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Record Processing Started"
}

Trigger screening for Firco Trust

Authorizations:
oauth
path Parameters
signalId-firco
required
string

signal ID for the BP where the record is to be sent

Request Body schema: application/json

Trigger Firco Trust Screening

firco_trust_unit
Array of strings
firco_trust_b_unit
string

Responses

Request samples

Content type
application/json
{
  • "firco_trust_unit": [
    ],
  • "firco_trust_b_unit": "string"
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Record Processing Started"
}

Check record processing status

Checks a record status based on the specified requestId. Returns the record processing status.

Authorizations:
oauth
path Parameters
requestId
required
string

Request UUID to track a request

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Record Processing Started"
}

Get screening decision

Gets a screening decision based on the specified requestId. Returns the record results.

Authorizations:
oauth
path Parameters
requestId
required
string

Request UUID to track a request

Responses

Response samples

Content type
application/json
{
  • "input_id": "string",
  • "client_id": "string",
  • "alert_resolution": "string",
  • "alert_explanation": "string",
  • "hits": [
    ],
  • "html_report_link": "string",
  • "qc_report_link": "string",
  • "auto_qc": true
}

Get screening decision

Gets a screening decision based on the specified requestId. Returns the record results.

Authorizations:
oauth
path Parameters
firco-requestId
required
string

Request UUID to track a request

Responses

Response samples

Content type
application/json
{
  • "report_link": [
    ]
}