Skip to content

Transaction monitoring

Transaction monitoring allows real-time analysis of financial operations based on your custom risk logic. Use this tool to evaluate payment parameters, such as directions and amounts, to automate decision-making and identify potentially suspicious activities.

Operations

Submit transaction

Request

Use this endpoint to submit transaction data for screening and monitoring. The system analyzes the payment parameters against your selected ruleset_id and delivers the result asynchronously to your callback_url. To identify the customer, you must provide either an internal applicant_id or your external_applicant_id.

Security
API-Key
Bodyapplication/jsonrequired
One of:
applicant_idstring, = 36 charactersrequired

A unique identifier of an applicant, that is assigned by our system after an applicant object was created with a “Create an applicant” request

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
external_applicant_idstring or null, [ 0 .. 50 ] characters

A unique identifier of your user in your system

Example:"8ba166fd-e9ba-49c6-b91a-fdbf0f63f939"
external_applicant_registered_atstring, = 19 characters

The date and time of user registration in the customer's system. Must be in UTC and follow the YYYY-MM-DD hh:mm:ss format. Cannot be a future date

Example:"2025-12-19 18:44:08"
transactionobjectrequired
ruleset_idstring, = 36 characters^[a-fA-F0-9]{36}$required

The unique 36-character hexadecimal identifier of the screening ruleset. This ID is automatically generated after you create a ruleset in the Dashboard. It determines which ruleset will be applied to the transaction

Example:"27c5caea93ee4656881ef9a30fadd21a3768"
callback_urlstring, (uri), <= 2048 charactersrequired

The endpoint URL where our system will send real-time webhook notifications via POST request. Your server should respond with a 200 OK status to acknowledge receipt

Example:"https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03"
{
  "applicant_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "external_applicant_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
  "external_applicant_registered_at": "2025-12-19 18:44:08",
  "transaction": {
    "direction": "incoming",
    "amount": "150.75",
    "asset": "USD",
    "created_at": "2024-07-01 15:27:15",
    "first_name": "Josh",
    "last_name": "Coffey",
    "payment_method": "credit_card",
    "payment_instrument_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
    "external_transaction_id": "8ba166fd-e9ba-49c6-b91a-fdbf0f63f939",
    "description": "Monthly subscription payment"
  },
  "ruleset_id": "27c5caea93ee4656881ef9a30fadd21a3768",
  "callback_url": "https://webhook.site/34374c1f-3b2b-4060-ad26-8a556478df03"
}

Responses

OK The request was successful, and our system returned an expected response.

Bodyapplication/json
statusstring
Example:"ok"
dataobject
Response
{
  "status": "ok",
  "data": {
    "service_request_id": "6bff21e17da144418b7643267ba4502930a9"
  }
}