Fraud & AML API EndpointsTransactions

Check a transaction's risk

Evaluate customer activity for fraud risk and/or money laundering risk. Fraud risk may be associated with the customer or their device as well as the transactions that they performed. Money laundering risk is associated with financial transactions. You supply the details of the action or transaction, originator/customer and beneficiary/counter-party, along with any additional data such as device details, location information and any additional data you feel might be relevant. This API is extremely flexible and can be extended easily - please contact your FrankieOne account manager to discuss your options. Note: When performing a risk check for a Crypto activity type (CRYPTO_WITHDRAWAL, CRYPTO_DEPOSIT) you can provide additional information for the evaluated exchange value of the coin and value in the transaction. This can be provided by adding a `payment.alternative.value` and `payment.alternative.currencyCode` in the `activity.customerTransaction.extraData` field. For example: ``` { ... "extraData": { "payment.alternative.value": "10000.00", "payment.alternative.currencyCode": "USD" } ... } ```

Authentication

apiKeystring
API Key authentication via header

Headers

X-Frankie-CustomerIDstringRequired
Your Customer ID provided by FrankieOne
X-Frankie-CustomerChildIDstringOptional
Your Customer Child ID provided by FrankieOne
X-Frankie-BackgroundenumOptional
If this header parameter is supplied and set to 1, then the request will not wait for the process to finish, and will return a 202 if there are no obvious errors in the input. The request will then run in the background and send a notification back to the customer. See our callback API for details on this.
Allowed values:

Request

This endpoint expects an object.
riskTokenobjectRequired
Includes any data required for authorizations by upstream services. To confirm if this is required, please reach out to the FrankieOne Support team.
transactionIdstringRequired
Identifier for the transaction monitoring check, should be unique per transaction
customerobjectRequired
A party describes the details of one of the parties in a given assessment. It can be used to describe any participant.
activityobjectRequired
deviceobjectOptional
Wrapper that will contain additional device data for a given transaction. This may be captured through 3rd party services
extraDataobjectOptional

A generic map of Key/Value’s that can be used to define custom properties.

checkIdstringOptionalDeprecated

(Deprecated in favor of transactionId)

Response

The request was valid and able to be processed in some fashion. Results may or may not be successful, but it was completed as far as practical with no actual errors. Returns the entity object as it stands now. No docScan file data from any attached ID documents will be returned unless the /full variant is requested.

customerReferencestring or null
The customer's reference value
resultenum or null
The overall result of the transaction check, this will be based on the successful completion of a check to an upstream vendor for the transaction check
Allowed values:
entityIdstring or null
The unique identifier for a FrankieOne entity construct
checkIdstring or null
The unique identifier for a transaction monitoring check that was execute for a transaction
transactionIdstring or null
The unique identifier of a transaction as identified within the FrankieOne Transaction Monitoring system
riskScoredouble or null
Risk score as determined by the checking service
riskLevelenum or null
Level of risk as determined by the service.
Allowed values:
riskResultslist of objects or null
All the result sets available for the check, such as customer, device, and transaction
extraDataobject or null

A generic map of Key/Value’s that can be used to define custom properties.

errorsobject or null

Errors