Transact Comply offers a transaction monitoring platform with an API-style output tailored for developer documentation. It enables users to analyze and evaluate transactions to detect suspicious activity using flexible scenarios and a comprehensive rule library. This document provides an overview of the API, authentication process, details on Transact Comply API usage, sample request and response structures, and specifications of data fields.
The Transact Comply API is designed to seamlessly integrate with third-party platforms, providing comprehensive transaction monitoring functionalities across various use cases.
The aim is to enable transaction monitoring functions in partners platform where monitoring can be done for single or multiple entities (via batch upload) for individuals and organizations
Please contact us for API related information.
API displayed in the documentation is for representation purpose.
It follows standard OAuth2.0 architecture for authentication and authorization. OAuth is a delegated authorization framework for REST APIs. It enables apps to obtain limited access (scopes) to a user’s data without giving away a user’s password. It decouples authentication from authorization and supports multiple use cases addressing different device capabilities.
Base URL: https://api.transactcomply.com/tmprocessor/tp/
End point : GetTokenEncryption
Content-Type : application/x-www-form-urlencoded
Method: POST
Example Request
{
"user_name": "i1XIJ8h4iGsPrRYUTaeNErxOEGAHTxI6PNA69Z9xYkO6DcHzdZ8zeU0GBxzI2sN+RVngn+PBRkZ0T+kUYyi5WI2BqrtcxMlVBW+YE/bAEoSIH3t3Z/MLJn5dad8g==",
"user_secret": "Vngn+PBRkZ0T+kUYyi5WI2BqrtcxMlVBW+YE/bAEoSIH3t3Z/MLJn5dad8g==i1XIJ8h4iGsPrRYUTaeNErxOEGAHTxI6PNA69Z9xYkO6DcHzdZ8zeU0GBxzI2sN+RVngn+PBRkZ0T+kUYyi5WI2BqrtcxMlVBW+YE/bAEoSIH3t3Z/MLJn5dad8g==",
"grant_type": "client_credentials"
}
Example Response:
{
"token": {
"access_token": "***************************************",
"expires_in": 30,
"token_type": "Bearer"
}
}
Base URL: https://api.transactcomply.com/tmprocessor/tp/
End point : TransactionProcessorAPI
Method: POST
Authentication: access token recieved from authentication API
Example Request
{
"Project_Id": 20,
"Customer_Id": "DIK1",
"Transaction_Id": "T11273",
"Transaction_Date": "2025-03-25",
"TransactionAdditionalDetailsJSON": {
"Transaction_Time": "10:27:01:144",
"Transaction_Amount": "16324",
"Transaction_Mode": "Cash",
"Transaction_Currency": "INR",
"Transaction_Type": "Purchase",
"Transaction_Status": "Completed",
"Transaction_Channel": "Internet Banking"
}
}
Example Response:
{
"Is_Success": true,
"message": "Transaction Processed Successfully",
"httpStatusCode": 200,
"CaseAlertResponseModel": {
"Entity_Id": 1784955843190784,
"Customer_Id": "DIK1",
"Transaction_Id": "T11273",
"Project_Id": 20,
"Transaction_Batch_Id": 3557,
"MasterCase_Display_Id": "TC.20699587424",
"Case_Display_Id": "TC.20901793213",
"Monitoring_Status": "Flag",
"Created_On": "2025-04-22T06:33:10.0570135Z",
"User_Id": 4,
"Username": "john.doe@zigram.tech",
"Case_Level_Id": 1,
"Case_Level": "Project Admin",
"Case_Workflow_Status": "Need Review",
"Monitoring_Type": "M",
"Entity_Alerts_Responses": [
{
"Rule_Display_Id": "TMR00213",
"Check_Name": "DEF.0001",
"Rule_Name": "Testing-01",
"Result_Json": "{\"Transaction_Amount\":\"INR 16,324,000\",\"Timestamp\":\"22-04-2025 06:33:09GMT\"}"
},
{
"Rule_Display_Id": "TMR00215",
"Check_Name": "DEF.0001",
"Rule_Name": "LiveRule-0001",
"Result_Json": "{\"Transaction_Amount\":\"INR 16,324,000\",\"Timestamp\":\"22-04-2025 06:33:09GMT\"}"
}
]
}
}
Base URL: https://api.transactcomply.com/tmprocessor/tp/
End point : EncryptedTransactionProcessorAPI
Method: POST
Authentication: access token recieved from authentication API
Example Request
i1XIJ8h4iGsPrRYUTaeNErxOEGAHTxI6PNA69Z9xYkO6DcHzdZ8zeU0GBxzI2sN+RVngn+PBRkZ0T+kUYyi5WI2BqrtcxMlVBW+YE/bAEoSIH3t3Z/MLJn5dad8g==
Example Response:
fDt0tT+/Z1lE+FbdX/JbEBkNSIS2uUo4L6+x3OAF/wxR4NzjVeuSfP7Oc9ZUUPZEKWu6OneddOcLUbmr+FWG2fYiGUw2k3tC5iXdG6kY0sJQJ7xa8OYofMxhr7Qguyis+oyMafj4nRKRfPryZGm13tkF1sdoD7wi3c6EE6cmfou9fr/GrdBfqgv31pEGbw2//QBuxgYvBKy+x3u
Data Field – Transaction Input
Datafield Name | Type | Required | Length | Single | Multiple | Description |
---|---|---|---|---|---|---|
Project_Id | Integer | Yes | 3 | Yes | No | Unique ID of the project. |
Transaction_Id | String | Yes | 50 | Yes | No | Unique identifier for the transaction. |
Customer_Id | String | Yes | 20 | Yes | No | Unique identifier assigned by the user to their customers |
Transaction_Date | Timestamp | Yes | 11 | Yes | No | Numeric representation of the date - dd MMM yyyy |
Transaction_Time | String | No | 12 | Yes | No | Time of the transaction. |
Transaction_Amount | Decimal | No | - | Yes | No | Transaction amount. |
Transaction_Currency | String | No | 3 | Yes | No | Currency code (e.g., INR, USD). |
Transaction_Type | String | No | 20 | Yes | No | Type of transaction (e.g., Refund, Payment). |
Transaction_Mode | String | No | 20 | Yes | No | Mode of the transaction (e.g., Cash, UPI). |
Transaction_Channel | String | No | 20 | Yes | No | Channel of the transaction (e.g., Internet Banking). |
Transaction_Status | String | No | 20 | Yes | No | Status of the transaction (e.g., Completed, Pending). |
Data Field – Case Outcome
Datafield Name | Type | Required | Length | Single | Multiple | Description |
---|---|---|---|---|---|---|
Is_Success | Boolean | Yes | 5 | Yes | No | Indicates if the operation was successful (true/false). |
HttpStatusCode | Int | Yes | 5 | Yes | No | Standard HTTP status code returned by the API, indicating the success or failure of the request. |
Message | String | Yes | - | No | Yes | Case generation result |
CaseAlertResponseModel | CaseAlertResponseModel | Yes | - | No | Yes | Detailed results of transaction monitoring. |
Data Field – Case Alert Response Model
Datafield Name | Type | Required | Length | Single | Multiple | Description |
---|---|---|---|---|---|---|
Username | String | Yes | 14 | Yes | No | Identifier of the user performing the actions |
Monitoring_Type | Char | Yes | 1 | Yes | No | Type of monitoring. |
Customer_Id | String | Yes | 20 | Yes | No | Unique ID of the customer. |
User_Id | Int | Yes | - | Yes | No | Unique identifier of the user |
Case_Level | String | Yes | 14 | Yes | No | Role of the allocated user. |
Transaction_Id | String | Yes | - | Yes | No | Unique ID of a transaction. |
Created_On | Timestamp | Yes | - | Yes | No | Timestamp when the case or alert was generated. |
Entity_Id | Long | Yes | - | Yes | No | Unique ID of the entity. |
Transaction_Batch_Id | Int | Yes | - | Yes | No | Unique ID assigned to a batch file. |
Master_Case_Display_Id | String | Yes | 14 | Yes | No | Unique ID assigned to a group of associated cases. |
Case_Level_Id | Int | Yes | 14 | Yes | No | Role of the allocated user. |
Project_Id | Int | Yes | 3 | Yes | No | Unique ID of the project. |
Rule_Display_Id | String | Yes | 50 | Yes | No | Unique ID for a rule(e.g. R.00065,R.00066) |
Case_Workflow_Status | String | Yes | 14 | Yes | No | Current status of the case workflow (e.g., Need Review, Under Review). |
Case_Display_Id | String | Yes | 14 | Yes | No | Unique ID assigned to a case. |
Rule_Name | String | Yes | 100 | Yes | No | Name of the rule applied and breached. |
Check_Name | String | Yes | 50 | Yes | No | Name of the specific check applied (e.g., Structuring, Pattern). |
Result_Json | JSON | Yes | 150 | Yes | No | Key-value result set capturing data points that triggered the rule. |
Code | Response | Description |
---|---|---|
401 | Error: response status is 401 | The token expired |
400 | Bad request | Invalid Type. Type can only be either Individual, Organization, Vessels or All. |
408 | Request Timeout Error | The server did not receive a complete request from the client within the server's allotted timeout period. |
409 | Too Many Requests | The user has sent too many requests |
500 | Internal Server Error | The server has encountered a situation that it does not know how to handle |
504 | Gateway Timeout | The server is acting as a gateway and cannot get a response in time for a request. |
200 | Ok | Request recieved |
Copyright © 2025 ZIGRAM Data Technologies Pvt Ltd