API Documentation

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.

API Documentation

API Overview

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.

Authentication

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"
  }
}
				
			

Transact Comply API

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\"}"
      }
    ]
  }
}
				
			

Encrypted Transact Comply API

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 Details

Data Field – Transaction Input

Datafield Name TypeRequiredLengthSingleMultipleDescription
Project_IdIntegerYes3YesNoUnique ID of the project.
Transaction_IdStringYes50YesNoUnique identifier for the transaction.
Customer_IdStringYes20YesNoUnique identifier assigned by the user to their customers
Transaction_DateTimestampYes11YesNoNumeric representation of the date - dd MMM yyyy
Transaction_TimeStringNo12YesNoTime of the transaction.
Transaction_AmountDecimalNo-YesNoTransaction amount.
Transaction_CurrencyStringNo3YesNoCurrency code (e.g., INR, USD).
Transaction_TypeStringNo20YesNoType of transaction (e.g., Refund, Payment).
Transaction_ModeStringNo20YesNoMode of the transaction (e.g., Cash, UPI).
Transaction_ChannelStringNo20YesNoChannel of the transaction (e.g., Internet Banking).
Transaction_StatusStringNo20YesNoStatus of the transaction (e.g., Completed, Pending).

Data Field – Case Outcome

Datafield Name TypeRequiredLengthSingleMultipleDescription
Is_SuccessBooleanYes5YesNoIndicates if the operation was successful (true/false).
HttpStatusCodeIntYes5YesNo Standard HTTP status code returned by the API, indicating the success or failure of the request.
MessageStringYes-NoYesCase generation result
CaseAlertResponseModelCaseAlertResponseModelYes-NoYesDetailed results of transaction monitoring.

Data Field – Case Alert Response Model

Datafield Name TypeRequiredLengthSingleMultipleDescription
UsernameStringYes14YesNoIdentifier of the user performing the actions
Monitoring_TypeCharYes1YesNoType of monitoring.
Customer_IdStringYes20YesNo Unique ID of the customer.
User_IdIntYes-YesNoUnique identifier of the user
Case_LevelStringYes14YesNoRole of the allocated user.
Transaction_IdStringYes-YesNoUnique ID of a transaction.
Created_OnTimestampYes-YesNo Timestamp when the case or alert was generated.
Entity_IdLongYes-YesNoUnique ID of the entity.
Transaction_Batch_IdIntYes-YesNoUnique ID assigned to a batch file.
Master_Case_Display_IdStringYes14YesNoUnique ID assigned to a group of associated cases.
Case_Level_IdIntYes14YesNoRole of the allocated user.
Project_IdIntYes3YesNo Unique ID of the project.
Rule_Display_IdStringYes50YesNoUnique ID for a rule(e.g. R.00065,R.00066)
Case_Workflow_StatusStringYes14YesNoCurrent status of the case workflow (e.g., Need Review, Under Review).
Case_Display_IdStringYes14YesNoUnique ID assigned to a case.
Rule_NameStringYes100YesNoName of the rule applied and breached.
Check_NameStringYes50YesNoName of the specific check applied (e.g., Structuring, Pattern).
Result_JsonJSONYes150YesNoKey-value result set capturing data points that triggered the rule.

HTTP Response Code Description

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