Transactions
Transaction Intelligence: Accounts Receivable
An API to evaluate the risk of a specific funds transfer where the receiver is the business.
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
Fields | Type | Is Required | Description |
---|---|---|---|
payor | object | Yes | Information about the payor of the funds. |
payor.name | string | Yes | Name of the payour. |
payor.address | object | Yes | Address information of the payor. |
payor.address.street_1 | string | Yes | First line of the payor’s address. |
payor.address.street_2 | string | No | Second line of the payor’s address. |
payor.address.city | string | Yes | City of the payor’s address. |
payor.address.state | string | Yes | State of the payor’s address. |
payor.address.zip | string | Yes | Zip code of the payor’s address. |
payor.email | string | Yes | Email address of the payor. |
payor.phone | string | Yes | Phone number of the payor. |
payor.account_number | string | Yes | Payor’s bank account number. |
payor.routing_number | string | Yes | Payor’s bank routing number. |
payee | object | Yes | Information about the payee of the funds. |
payee.business_name | string | Yes | Name of the business receiving the funds. |
payee.email | string | Yes | Email address of the payee. |
payee.phone | string | Yes | Phone number of the payee. |
payee.account_number | string | Yes | Payee’s bank account number. |
payee.routing_number | string | Yes | Payee’s bank routing number. |
payee.tin | string | Yes | Tax Identification Number (TIN) of the payee. |
payee.trading_name | string | Yes | Trading name of the payee. |
payee.incorporation_state | string | Yes | State of incorporation of the payee. |
payee.industry | string | Yes | Industry of the payee. |
payee.address | object | Yes | Address information of the payee. |
payee.address.street_1 | string | Yes | First line of the payee’s address. |
payee.address.street_2 | string | No | Second line of the payee’s address. |
payee.address.city | string | Yes | City of the payee’s address. |
payee.address.state | string | Yes | State of the payee’s address. |
payee.address.zip | string | Yes | Zip code of the payee’s address. |
payee.beneficial_owners | array | Yes | List of beneficial owners of the payee. |
payee.beneficial_owners[].first_name | string | Yes | First name of the beneficial owner. |
payee.beneficial_owners[].last_name | string | Yes | Last name of the beneficial owner. |
payee.beneficial_owners[].email | string | Yes | Email address of the beneficial owner. |
payee.beneficial_owners[].phone | string | Yes | Phone number of the beneficial owner. |
payee.beneficial_owners[].dob | string | Yes | Date of birth of the beneficial owner in YYYY-MM-DD format. |
payee.beneficial_owners[].ssn9 | string | Yes | Last 4 digits of the Social Security Number (SSN) of the beneficial owner. |
payee.beneficial_owners[].address | object | Yes | Address information of the beneficial owner. |
payee.beneficial_owners[].address.street_1 | string | Yes | First line of the beneficial owner’s address. |
payee.beneficial_owners[].address.street_2 | string | No | Second line of the beneficial owner’s address. |
payee.beneficial_owners[].address.city | string | Yes | City of the beneficial owner’s address. |
payee.beneficial_owners[].address.state | string | Yes | State of the beneficial owner’s address. |
payee.beneficial_owners[].address.zip | string | Yes | Zip code of the beneficial owner’s address. |
payee.beneficial_owners[].is_beneficial_owner | boolean | Yes | Indicates if the person is a beneficial owner. |
payee.beneficial_owners[].is_director | boolean | Yes | Indicates if the person is a director. |
payee.beneficial_owners[].is_account_owner | boolean | Yes | Indicates if the person is an account owner. |
payee.beneficial_owners[].is_share_holder | boolean | Yes | Indicates if the person is a shareholder. |
payee.beneficial_owners[].is_significant_control_person | boolean | Yes | Indicates if the person is a significant control person. |
transaction | object | Yes | Information about the transaction. |
transaction.amount | number | Yes | Amount of the transaction. |
Response
Errors & Warnings
Error ( 400 )
Error ( 401 )
Error ( 422 )
Error ( 429 )
Error ( 500 )