Skip to main content
API docs by Redocly

Tara - Payment Sanction Screening (PSS) (1.2.15)

Download OpenAPI specification:Download

URL: https://www.workfusion.com/digital-workers/tara-transaction-screening-analyst/

Transaction Screening or Payment Sanction Screening (PSS) Alert Disposition is the skill of the Digital Worker Tara. Tara is designed to identify real-time transactions or payments to or from sanctioned individuals, entities, or jurisdictions during on-boarding and throughout the customer relationship lifecycle that may pose a risk to financial institutions.

Tara

Submit payment message with screening alerts for Tara review

Submit a record for processing asynchronously. Acknowledge that the message was added to processing queue will be returned immediately. Asynchronous execution is the most efficient way for processing batches of records or high volume of records.

Authorizations:
oauth
path Parameters
signalId
required
string

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

Request Body schema: application/json

Alerts to be screened. All fields besides type and hits are optional.

sourceSystemId
string

Source system number.

id
required
string

Message identification number.

type
string
Default: "PAYMENT_TRANSFER"

Payment message type.

subtype
string

Payment message subtype.

content
string

Optional if content already parsed and {@link Hit} tagContent and tagType provided for each hit. Otherwise, required for parsing.

contentFormat
string
Enum: "FUF" "NATIVE" "SWIFT_MT" "SWIFT_MX" "SWIFT_NPP" "SWIFT_ADK"

Required when {@link #content} field is provided. Specifies format of the {@link #content}. Otherwise Optional

required
Array of objects (Hit)

Message hits. Message without hits will not be adjudicated.

object (PaymentInfo)

Payment details.

object

Any additional information, fields/values not specified elsewhere.

Responses

Request samples

Content type
application/json
{
  • "sourceSystemId": "string",
  • "id": "string",
  • "type": "SWF",
  • "subtype": "103",
  • "content": "string",
  • "contentFormat": "FUF",
  • "hits": [
    ],
  • "payment": {
    },
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Malformed request : Missing required fields",
  • "format": "RAW",
  • "error": "string"
}

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. Returned in start-record-raw response.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Malformed request : Missing required fields",
  • "format": "RAW",
  • "error": "string"
}

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. Returned in start-record-raw response.

Responses

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Malformed request : Missing required fields",
  • "decision": {
    },
  • "html_report_link": "string"
}

Process payment message with screening alerts

Process a record synchronously. This method returns completed processing result. Response time of this method may deteriorate under high load, please use asynchronous version for higher volumes.

Authorizations:
oauth
path Parameters
signalId
required
string

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

Request Body schema: application/json

Alerts to be screened. All fields besides type are optional.

sourceSystemId
string

Source system number.

id
required
string

Message identification number.

type
string
Default: "PAYMENT_TRANSFER"

Payment message type.

subtype
string

Payment message subtype.

content
string

Optional if content already parsed and {@link Hit} tagContent and tagType provided for each hit. Otherwise, required for parsing.

contentFormat
string
Enum: "FUF" "NATIVE" "SWIFT_MT" "SWIFT_MX" "SWIFT_NPP" "SWIFT_ADK"

Required when {@link #content} field is provided. Specifies format of the {@link #content}. Otherwise Optional

required
Array of objects (Hit)

Message hits. Message without hits will not be adjudicated.

object (PaymentInfo)

Payment details.

object

Any additional information, fields/values not specified elsewhere.

Responses

Request samples

Content type
application/json
{
  • "sourceSystemId": "string",
  • "id": "string",
  • "type": "SWF",
  • "subtype": "103",
  • "content": "string",
  • "contentFormat": "FUF",
  • "hits": [
    ],
  • "payment": {
    },
  • "customAttributes": {
    }
}

Response samples

Content type
application/json
{
  • "requestId": "string",
  • "status": "COMPLETED",
  • "statusDetails": "Malformed request : Missing required fields",
  • "decision": {
    },
  • "html_report_link": "string"
}