curl --request POST \
  --url https://sigmaprod.sabipay.com/api/v1/transaction-monitoring/instant \
  --header 'Content-Type: application/json' \
  --header 'apiKey: <api-key>' \
  --header 'apiSecret: <api-key>' \
  --data '{
  "transactionData": {
    "reference": "<string>",
    "amount": 123,
    "receiverAccount": "<string>",
    "senderAccount": "<string>",
    "isExternalPayment": true,
    "balanceBefore": 123,
    "type": "debit",
    "channel": "card payment",
    "transactionDate": "2023-11-07T05:31:56Z",
    "vasReceiver": "<string>",
    "currency": "<string>",
    "isInternalAccount": true,
    "isStaffAccount": true,
    "sessionId": "<string>",
    "isDormantAccount": true
  },
  "device": {
    "deviceId": "<string>",
    "manufacturer": "<string>",
    "model": "<string>",
    "osName": "<string>",
    "osVersion": "<string>"
  },
  "anonymizedUserData": {
    "uniqueId": "<string>",
    "accountType": "individual",
    "businessCategory": "<string>",
    "isPhoneNumberVerified": true,
    "isBanned": true,
    "dateJoined": "2023-11-07T05:31:56Z",
    "age": 123,
    "isIdentityVerified": true,
    "state": "<string>",
    "city": "<string>",
    "country": "<string>"
  },
  "location": {
    "latitude": 123,
    "longitude": 123,
    "country": "<string>"
  },
  "thirdPartyUserData": {
    "uniqueId": "<string>",
    "cardPan": "<string>",
    "email": "jsmith@example.com"
  },
  "limits": {
    "dailyLimit": 123,
    "overdraftLimit": 123
  },
  "screeningData": {
    "senderName": "<string>",
    "receiverName": "<string>"
  },
  "beneficiary": {
    "isRegisteredBeneficiary": true,
    "isNewBeneficiary": true
  }
}'
{
  "transactionId": "<string>",
  "riskScore": "<string>",
  "action": {
    "result": "approved",
    "code": 0
  },
  "ruleResult": "<string>",
  "reason": {
    "code": "<string>",
    "message": "<string>",
    "severity": "high",
    "rule": {
      "id": "<string>",
      "name": "<string>"
    }
  },
  "screening": {
    "sender": {
      "pep": "<string>",
      "sanction": "<string>"
    },
    "receiver": {
      "pep": "<string>",
      "sanction": "<string>"
    }
  }
}

Authorizations

​
apiKey
string
header
required
​
apiSecret
string
header
required

Body

application/json
Transaction payload to be screened and monitored
​
transactionData
object
required
​
device
object
​
anonymizedUserData
object
​
location
object
​
thirdPartyUserData
object
​
limits
object
​
screeningData
object
​
beneficiary
object

Response

200
application/json
Transaction monitoring result
​
transactionId
string

The ID of the transaction that was checked for fraud

​
riskScore
string

A score indicating the level of risk associated with the transaction

​
action
object

Object providing info about the final decision taken on the transaction. Only returned when a final decision is taken

​
ruleResult
string

Result after the rules set have been executed (e.g., 'looks safe', 'needs review')

​
reason
object

Provides more detailed information about why the transaction is considered fraudulent

​
screening
object

Results of screening checks performed on transaction parties (Only returned when transaction screening module is enabled)