|The SEON APIs conform to the design principles of Representational State Transfer (REST). They have predictable resource-oriented URLs, accept form-encoded request bodies, return JSON-encoded responses and use standard HTTP response codes, authentication, and verbs.|
For a detailed overview of each API and its features, please read the Overview and Steps for SEON Sense Platform sections in the documentation.
Our APIs should be integrated within your systems wherever a transactional risk is involved, and the
action_type field should be used to identify the authentication point such as a payment or signup, or login.
All the fields are optional, but the more data fields you add to the API request payloads, the more accurate the risk-scoring algorithm will be.
As our platform is fully modular, you can choose to enable or disable our sub-APIs for further data enrichment (i.e. Email, Phone, IP) as well as the device fingerprinting module. These can be enabled by setting properties on the
config object as part of each API request.
Additional custom data points can be included in your requests in order to further enrich the data available for our machine learning system and scoring engine. These can be passed on each API request by using the
For a detailed list of the possible JSON properties, please use our API Reference.
Our Fraud API's response is real-time and provides a score (0-100), fraud state identifying actions to take as well as enriched data fields obtained through our Intelligence APIs, such as the Email or Phone API.
Please get in touch with your dedicated account manager for support in tailoring and validating the payloads for your business use case or if you need any help with the APIs.
The point when a customer is first seen in a system, such as a signup, is the only point when the Email and Phone API should be called as these data points are risk vectors that do not change during the customer journey. They should also be called when the phone number or email is changed for an account so as to catch potential account takeovers. These APIs fetch data from social networks, which can be a bottleneck in your response time. You can define a desired timeout threshold on the Settings page. We recommend at least 1000ms for a minimum of 95% accuracy.
In order to process the data successfully, please ensure you have familiarised yourself with the Device Fingerprint Documentation and pass the payload without any modification to the Fraud API. Please also check the common issues section of the documentation for troubleshooting.
Our Label API provides an invaluable feedback loop for flagging fraudulent transactions to SEON. This, in turn, helps refine our machine learning algorithms to help prevent false positives and negatives. Please read more about it in the Overview and Steps for Sense Platform section.