improved

Scores available in API response

Some time ago, Castle launched a dedicated bot score as well as account takeover score, in addition to the more general Castle score, which looks more broadly at abusive behaviors. These three scores have been available to search, filter and create policies on in the Castle Dashboard for some time now, and today we're making them all available in the Risk and Filter API responses.

Below is an example payload response for the three risk scores:

{
  // ...
  "scores": {
    "account_abuse": {
      "score": 0.32
    },
    "account_takeover": {
      "score": 0.21
    },
    "bot": {
      "score": 0.54
    }
  }
  // ...
}

Worth noting is that what was previously called risk in the response has now moved into the account_abusescore section, allthough we're keeping the risk field to not break existing integrations relying on it. However, we strongly recommend switching to using the new account_abuseinstead.

You can see the full specification in our API reference docs