Record Fraud Login Event

Endpoint for recording a login event with Fraud Transaction Monitoring (FTM).

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
📘

Documentation

For more information on this endpoint, see Fraud Login Event.

Body Params
string

Channel through which the login was made. Recommended values are "online", "mobile". Further free text examples can be added to fit the use case.

date-time

The date in which the customer signed up to use Mobile/online banking

customerFlag
array of strings

Field to be used for specific customer flags that may determine treatment strategies. This is an array that can include free text values.

customerFlag
string
required

A unique identifier for the customer

string

The customer type, e.g Retail or Commercial

device
object

Details of the device used, not including the the ID

string

A unique identifier of the device performing the event, such as the mobile/cell phone used for a transaction (e.g. for Google/Apple pay transactions).

date-time
required

Date and time that the login occurred

string

ID of the initiating party, where this is not the account ID. This would be expected to be mandatory for commercial use cases

string

A human readable string identifying the initiator as indentified in the intiatiatingPartyId attribute.

string

The initiatingPartyId typically represents an individual user in the commercial banking setting. However it can also be used to represent the open banking entity that initiating the action. This attributes details how the initiating party is being used. Example values "User", "Open Banking".

string

The unique product indentifier

string
required

The unique code for the program manager

session
object

Session details for the login

string

Customer provided ID for tracking events

thirdPartyDetails
object

Details sent over by the third party provider

string

This is the final result of the verification, whether the customer was successful in verifiying themselves. The verificationType determines whether any specific verifications were failed or were successful (see description of verificationType). This attribute rolls that up into a single value such that if the customer was eventually successfully verified, such that they could proceed with the action, this should be set to "verificationResult": "SUCC". If the customer was trying to verify themselves and failed, such that they could not proceed with the action, you can set "verificationResult": "FAIL".

verificationType
object

This is a derived type that allows you to track multiple verifications required to perform the designated events. For each verification that took place, we expect a value of SUCC if the verification was successfull and FAIL if it failed. For example, for a online login where a customer failed in some biometric verification (e.g. fingerprint scanning) but then successfully entered their password to complete the login, we would expect to see

Responses
204

Login event successfully recorded

400

A required field is missing from the request body

Language
URL
LoadingLoading…