Trident's Analyze API is used to perform Risk analysis using the data, that is, transaction and user profile details shared by the Calling application.
Endpoint
Endpoint URL Format: <domainname>/analyse/request
Example Endpoint URL:
http://127.0.0.1:8443/analyse/request
Method: POST
Content-Type: application/json
Request Parameters
Parameter | Description | Example |
---|---|---|
instanceId
|
| 8888 |
channelId
|
| 3DS |
async
|
| false |
details |
| false |
txnSourceType |
| Purchase |
partRequest |
| true |
lastDrop |
| true |
acctNumber |
| 4346781238815413 |
txnTimestamp |
| 20231015123045 |
clientTxnRefId |
| TXN12345UNIQUE |
purchaseAmount |
| 10000 |
Custom parameters | ||
messageType |
| Auth_init |
merchantCountryCode |
| 356 |
ip |
| 172.27.0.1 or FE80:CD00::211E:729C |
cardType |
| Debit |
userAgent |
| Mozilla/5.0 (Windows NT 10.0; Win64) |
mobileNumber |
| 9123456789 |
Custom parameters:
Trident supports any number of custom fields to be configured basis the use case.
Sample request
curl -X POST "http://127.0.0.1:8443/analyse/request" \
-H "Content-Type: application/json" \
-H "Authorization: Bearer YOUR_API_TOKEN" \
-d '{
"instanceId": "8888",
"channelId": "3DS",
"async": "false",
"details": "true",
"txnSourceType": "Purchase",
"partRequest": "true",
"lastDrop": "true",
"acctNumber": "4346781238815413",
"txnTimestamp": "20231015123045",
"ip": "172.27.0.1",
"merchantCountryCode": "356",
"purchaseAmount": "10000",
"cardType": "Debit",
"userAgent": "Mozilla/5.0 (Windows NT 10.0; Win64; x86_64) AppleWebKit/537.36 (KHTML, like Gecko) Chrome/91.0.4472.124 Safari/537.36",
"mobileNumber": "9123456789",
"clientTxnRefId": "TXN12345UNIQUE"
}'
Response parameters
When details = false
Parameter | Description | Example |
---|---|---|
ruleRating | Integer - Total risk score for the transaction. Higher scores indicate higher risk. | 60 |
clientId | String (UUID) - Unique transaction ID generated by Trident for tracking purposes. | 201809_86642221-1801-49aa-ad12-c409c0317451 |
ruleSuggestion | String - Trident's risk suggestion based on the risk evaluation table configured for the calling application. | ACCEPT |
stepUp | String (true/false) - Indicates if additional authentication is recommended. | true |
When details = true
Parameter | Description | Example |
---|---|---|
ruleRating |
| 60 |
clientId |
| 201809_86642221-1801-49aa-ad12-c409c0317451 |
ruleSuggestion |
| ACCEPT |
stepUp |
| true |
NodeId |
| 172.31.2.145::8443 |
frictionLess |
| false |
observationSummary |
| "observationSummary": { "SB-MAX-AMT-RULE": "10", "SB-BLK-IP-RULE": "10" } |
exceptions |
| [401 501] |
Sample response
{
"ruleRating": 60,
"clientId": "201809_86642221-1801-49aa-ad12-c409c0317451",
"ruleSuggestion": "ACCEPT",
"stepUp": "true",
"NodeId": "172.31.2.145::8443",
"frictionLess": "false",
"observationSummary": {
"SB-MAX-AMT-RULE": "10",
"SB-BLK-IP-RULE": "10"
},
"exceptions": []
}