Transaction Intelligence evaluates the risk of a specific funds transfer between two entities. By supplying required information about the transaction—including details on the sender, receiver, and amount—you receive a structured response containing:

  • Risk Score – A floating-point value between 0 and 1 that represents the likelihood of a successful and legitimate transaction based on the attributes of the involved parties. A score closer to 0 indicates high risk, while a score closer to 1 reflects lower risk and greater confidence in the transaction’s integrity.
  • Validity Expiration – timestamp for when the evaluation should be refreshed.

This enables programmatic decisioning for when to allow, block, or escalate transactions based on risk posture.


Endpoint

POST /v1/transactions/score/ar

Request Body

{
  "payor": {
    "name": "John Smith",
    "address": {
      "street_1": "123 Main St",
      "street_2": "Suite 400",
      "city": "New York",
      "state": "NY",
      "zip": "10001"
    },
    "email": "[email protected]",
    "phone": "1234567890",
    "account_number": "1234567890",
    "routing_number": "021000021"
  },
  "payee": {
    "business_name": "Acme Corp",
    "email": "[email protected]",
    "phone": "9876543210",
    "account_number": "0987654321",
    "routing_number": "011000015",
    "tin": "123456789",
    "trading_name": "Acme",
    "incorporation_state": "DE",
    "industry": "Retail",
    "address": {
      "street_1": "456 Corporate Ave",
      "street_2": "",
      "city": "Boston",
      "state": "MA",
      "zip": "02110"
    },
    "beneficial_owners": [
      {
        "first_name": "Alice",
        "last_name": "Doe",
        "email": "[email protected]",
        "phone": "5551234567",
        "dob": "1980-01-01",
        "ssn9": "123456789",
        "address": {
          "street_1": "789 Owner Rd",
          "street_2": "Apt 2B",
          "city": "San Francisco",
          "state": "CA",
          "zip": "94105"
        },
        "is_beneficial_owner": true,
        "is_director": false,
        "is_account_owner": true,
        "is_share_holder": false,
        "is_significant_control_person": true
      }
    ]
  },
  "transaction": {
    "amount": 1000  }
}
FieldsTypeIs RequiredDescription
payorobjectYesInformation about the payor of the funds.
payor.namestringYesName of the payour.
payor.addressobjectYesAddress information of the payor.
payor.address.street_1stringYesFirst line of the payor’s address.
payor.address.street_2stringNoSecond line of the payor’s address.
payor.address.citystringYesCity of the payor’s address.
payor.address.statestringYesState of the payor’s address.
payor.address.zipstringYesZip code of the payor’s address.
payor.emailstringYesEmail address of the payor.
payor.phonestringYesPhone number of the payor.
payor.account_numberstringYesPayor’s bank account number.
payor.routing_numberstringYesPayor’s bank routing number.
payeeobjectYesInformation about the payee of the funds.
payee.business_namestringYesName of the business receiving the funds.
payee.emailstringYesEmail address of the payee.
payee.phonestringYesPhone number of the payee.
payee.account_numberstringYesPayee’s bank account number.
payee.routing_numberstringYesPayee’s bank routing number.
payee.tinstringYesTax Identification Number (TIN) of the payee.
payee.trading_namestringYesTrading name of the payee.
payee.incorporation_statestringYesState of incorporation of the payee.
payee.industrystringYesIndustry of the payee.
payee.addressobjectYesAddress information of the payee.
payee.address.street_1stringYesFirst line of the payee’s address.
payee.address.street_2stringNoSecond line of the payee’s address.
payee.address.citystringYesCity of the payee’s address.
payee.address.statestringYesState of the payee’s address.
payee.address.zipstringYesZip code of the payee’s address.
payee.beneficial_ownersarrayYesList of beneficial owners of the payee.
payee.beneficial_owners[].first_namestringYesFirst name of the beneficial owner.
payee.beneficial_owners[].last_namestringYesLast name of the beneficial owner.
payee.beneficial_owners[].emailstringYesEmail address of the beneficial owner.
payee.beneficial_owners[].phonestringYesPhone number of the beneficial owner.
payee.beneficial_owners[].dobstringYesDate of birth of the beneficial owner in YYYY-MM-DD format.
payee.beneficial_owners[].ssn9stringYesLast 4 digits of the Social Security Number (SSN) of the beneficial owner.
payee.beneficial_owners[].addressobjectYesAddress information of the beneficial owner.
payee.beneficial_owners[].address.street_1stringYesFirst line of the beneficial owner’s address.
payee.beneficial_owners[].address.street_2stringNoSecond line of the beneficial owner’s address.
payee.beneficial_owners[].address.citystringYesCity of the beneficial owner’s address.
payee.beneficial_owners[].address.statestringYesState of the beneficial owner’s address.
payee.beneficial_owners[].address.zipstringYesZip code of the beneficial owner’s address.
payee.beneficial_owners[].is_beneficial_ownerbooleanYesIndicates if the person is a beneficial owner.
payee.beneficial_owners[].is_directorbooleanYesIndicates if the person is a director.
payee.beneficial_owners[].is_account_ownerbooleanYesIndicates if the person is an account owner.
payee.beneficial_owners[].is_share_holderbooleanYesIndicates if the person is a shareholder.
payee.beneficial_owners[].is_significant_control_personbooleanYesIndicates if the person is a significant control person.
transactionobjectYesInformation about the transaction.
transaction.amountnumberYesAmount of the transaction.

Response

{
  "status": true,
  "message": null,
  "data": {
    "risk_score": 0.85,
    "validity_expiration": "2025-01-01 @ 02:00PM EST"
  }
}

Errors & Warnings

Error ( 400 )
{
  "status": false,
  "message": "Invalid Request Data",
  "data": null
}
Error ( 401 )
{
  "status": false,
  "message": "Unauthorized Request",
  "data": null
}
Error ( 422 )
{
  "status": false,
  "message": "Unprocessable Entity",
  "data": null
}
Error ( 429 )
{
  "status": false,
  "message": "Rate Limit Exceeded",
  "data": null
}
Error ( 500 )
{
  "status": false,
  "message": "Internal Server Error",
  "data": null
}