API docs by Redocly

Tookitaki FRAML Prevention API Documentation (v1)

Download OpenAPI specification:Download

E-mail: [email protected] URL: https://www.tookitaki.com License: Tookitaki Terms of Service

Introduction

The Tookitaki FRAML Prevention API enables you to integrate your systems with our services. Our API follows the REST convention and accepts and returns JSON data.

All API requests must be made over HTTPS; calls made over plain HTTP will fail. API requests without authentication will also fail - see the Authentication section for information on correctly authenticating calls to the Tookitaki API.

Get Started

In order to start using FRAML Prevention real-time API, please follow the below steps to call the API with the right authentication to ensure you get the right results.

Steps 1 is must to get the necessary authorization token. This is only required to be repeated once the already existing token expires post the relevant expiry time. This is to prevent any unauthorized usage of the system.

Refer to the API Reference section for the detailed API Capabilities for both Authentication and FRAML Prevention Real-Time API

API flow Diagram:
API Flow Diagram

Responses & errors

We use standard HTTP status codes to indicate the success or failure of a request to our API.

Authentication API

The API uses API keys to authenticate requests. These APIß keys can be generated using below Auth APIs and must be supplied with each request.

All the API requests (Transaction Screening/ FRAML Prevention) has to hold Authorization header with valid token generated from our internal authentication system (gladiator).

'Authorization Token e9a3b57e-a6df-46a4-8c2b-58749195f93c'

Here is a sample API request you can use to generate an authentication token (Replace the respective app server URL and Referer here) and get the response back (Sample)

header Parameters
Accept
string

application/json, text/plain, /

Referer
Authorization
string

Basic dGRzczpUTIzNA==

Responses

Response samples

Content type
application/json
{
  • "token": "db32711b-b8db-4959-8a0b-0cc89236ba7d",
  • "name": "tdss",
  • "userId": 1,
  • "roleType": "Product User",
  • "rolesList": "[{}]",
  • "isPassExpired": false,
  • "isResetPassNeeded": false,
  • "authTypeInfo": {
    }
}

Realtime FRAML Prevention API

Successful requests to our API will have a 200 HTTP status code; the success and message key-value pairs will detail the status message and the content of the response. Additionally, alert will hold the details for the rule wise alert details.

The various possible alert level messages can be used to verify what a particular variant configured gave back as a response. Below are 5 possible states:
RuleNotTriggered:This suggests that a specific condition within the rule has not been met, preventing the rule from being triggered. All the values required to evaluate the condition is available. Detailed object level for each state is available in the response sample below
RuleTriggered:This implies that a particular condition or set of conditions within a rule has been met, prompting the rule to be triggered. Detailed object level for each state is available in the response sample below.
RuleNotApplicable:This indicates that the rule, regardless of its conditions, is not applicable for the current transaction basis the various conditions. Ex, the rule would be for e-wallet, whereas the current transaction is bank transfer. Essentially, the conditions for the rule to apply might exist, but the rule is deemed unsuitable or unnecessary. Detailed object level for each state is available in the response sample below.
RuleNotApplicableForGroupingKeys:Similar to "Rule Not Applicable," this term specifically relates to situations where rules aren't relevant when considering certain grouping keys. Detailed object level for each state is available in the response sample below.
RuleIncompleteFields:This indicates that there are missing or insufficient pieces of information necessary to satisfy the conditions set by a rule. Detailed object level for each state is available in the response sample below.

Unsuccessful requests to our API will have a non-200 HTTP status code and will contain message and success fields. The message field will contain any further information about the unsucessful request.

In case of FRAML API response, note that the message may have more details about the error.

path Parameters
productId
required
string

TDSS product ID

header Parameters
Authorization
required
string

auth token for the user

Request Body schema: application/json
required
required
object (FraudTransaction)
format
required
string

Format of the payload. Fixed value - "tt_json"

topicId
string

Externally configurable Kafka topic

version
string

API version

Responses

Request samples

Content type
application/json
{
  • "payload": {
    },
  • "format": "tt_json",
  • "topicId": "kafka_pipeline_topic",
  • "version": "1"
}

Response samples

Content type
application/json
{
  • "transactionKey": "TXN293DJHE8RH83",
  • "alert": {
    },
  • "version": "1",
  • "success": true,
  • "message": "success"
}