Beta API Versions
API versions labelled as Beta are not subject to our standard versioning policy. As such, they may undergo small breaking changes until they are transitioned to the stable version. We encourage you to exercise caution when using Beta API versions and take the necessary steps to ensure a smooth integration into your applications
From the Fraud Risk Metrics endpoint, you can retrieve the fraud score and metrics for a business.
️ Data Dependencies
- Fraud Risk Metrics have a start and an end date. For a given timeframe, the fraud risk metrics are dependent on the financial statements that exist up to that startDate (inclusive). Missing dependencies may result in incomplete fraud metrics.
- Fraud Risk Metrics will not be available if dependencies are missing or if the service provider connected does not support the data types required. See supported data types for more details.
All fraud risk metrics objects are part of an array of reports. See Reports data type for more details on the report structure and its meta-data.
|decimal||Benford Law Score from 0 to 100. A score of 100 implies perfect conformity to the distribution of first digits defined by Benford's law.|
|decimal||The average of outlier scores for all the accounting transactions, ranging from 0 to 1. A transaction is considered an outlier if it has an individual outlier score of above 0.6. An average above 0.4 most of the times will imply a lot or big outliers in the dataset. (Optional field, conditional on Accounting Transactions having |
|decimal||The number of outlier transactions divided by the total number of transactions. (Optional field, conditional on Accounting Transactions having |
|outlierTransactions||array||An array of outlier transactions. List of outlier transactions, defined as having a score greater than 0.6.|
|transactionKeywords||array||An array of transaction keywords. Count of transactions with keyword ("chargeback", "owner"), grouped by transaction type. (Optional field, conditional on Accounting Transactions having |
|transactionsSectionStats||array||An array of transaction section stats. Count of transactions with Railz section account classification. (Optional field, conditional on Accounting Transactions having |
|transactionPatterns||array||The top 5 transaction patterns, defined as a transaction with the same amount for the same subGroup that exists in more than one month. (Optional field, conditional on Accounting Transactions having |
|decimal||Rate of change for Current Ratio over the two most recent reporting periods. (Optional field, conditional on |
|decimal||Rate of change for Quick Ratio over the two most recent reporting periods. (Optional field, conditional on |
|decimal||Rate of change for Debt-to-Equity Ratio over the two most recent reporting periods. (Optional field, conditional on |
|decimal||Rate of change for Net Profit Margin over the two most recent reporting periods. (Optional field, conditional on |
|id||string||Accounting transaction id.|
|count||integer||Count of unique transaction type and keyword combination.|
|section||string||Highest level classification of an account. See Chart of Accounts.|
|count||integer||The number of occurrences of transactions with section account classification.|
|sdev||decimal||Standard deviation of transaction amounts per section account classification.|
|count||integer||Number of occurrences for the group and amount pairing.|
Step-by-step guide on utilizing this endpoint.