Fetch the details for a specific alert

GET

Path parameters

alertIdstringRequired

Unique identifier of a Transaction Check Alert

Headers

X-Frankie-CustomerIDstringRequired

Your Customer ID provided by FrankieOne

X-Frankie-CustomerChildIDstringOptional

Your Customer Child ID provided by FrankieOne

Response

Alert information

activityTypeenum

Type of the activity that was used for the check

alertIdstring

The unique identifier for an alert that has been created when customer configuration thresholds are breached.

checkIdstring

The unique identifier for a transaction monitoring check that was execute for a transaction

createdDatestring

ISO-8601 format date-time that the alert was created

entityIdstring

The unique identifier for a FrankieOne entity construct

issueTypeenum
Allowed values: DEVICETRANSACTIONAMLFRAUD

Enum of risk assessment groupings, such as customer, device, transaction, AML, PEP as determined by the risk checking service

lastUpdatedstring

ISO-8601 format date-time of the time that alert was last updated

resultIdstring

The unique identifier for a result that was returned from a transaction check

riskLevelenum
Allowed values: NONELOWMEDIUMHIGHVERY_HIGH

Level of risk as determined by the service.

sourcestring

Name of the upstream vendor of where the alert came from

statusenum
Allowed values: PENDINGAPPROVEDMANUALLY_APPROVEDMANUALLY_DECLINED

Current status of an alert

transactionTimestampstring

ISO-8601 format date-time that the transaction occurred

amountobjectOptional

The amount described in the transaction risk check

assignedTostringOptional

Current FrankieOne Portal user that is assigned to this user

deviceIdstringOptional

Identifier of the device that was used for this check, this would be provided from the initial request data

originatingCheckobjectOptional

A recorded activity that is/has been assessed by the Transaction Monitoring Service

paymentIdstringOptional

Identifier for the customer transaction, only populated for financial transaction checks

paymentTypeenumOptional
Allowed values: CARDBANKWIRECRYPTOOTHER

The type of payment that the transaction used.

riskTokenobjectOptional

Contains any data required for authorizations by upstream services. Please contact FrankieOne Support team for whether this is required.

subtypestringOptional

The subtype of the risk check

Built with