You signed in with another tab or window. Reload to refresh your session.You signed out in another tab or window. Reload to refresh your session.You switched accounts on another tab or window. Reload to refresh your session.Dismiss alert
Copy file name to clipboardExpand all lines: docs/risk-intelligence/format.md
+7-6Lines changed: 7 additions & 6 deletions
Display the source diff
Display the rich diff
Original file line number
Diff line number
Diff line change
@@ -3,17 +3,17 @@
3
3
Risk Intelligence data is returned in a structured JSON format that includes various risk signals and scores. The exact structure of the data may vary depending on which modules you have enabled on your account (as of writing, all modules are included by default).
4
4
5
5
:::info
6
-
The structure of the Risk Intelligence data is subject to change. We always aim for backwards compatibility, your validation and parsing logic should be flexible enough to handle new fields being added in the future.
6
+
The structure of the Risk Intelligence data is subject to change. We always aim for backwards compatibility, but your validation and parsing logic should be flexible enough to handle new fields being added in the future.
7
7
:::
8
8
9
9
## Structure Overview
10
10
The Risk Intelligence data is organized into three high level sections:
11
11
12
12
```json
13
13
{
14
-
risk_scores: { ... }, // Overall risk scores summarizing the assessment into scores per category (1-5).
15
-
network: { ... }, // Information about the user's network and IP address.
16
-
client: { ... }, // Detected browser or bot information.
network: { ... }, // Information about the user's network and IP address.
16
+
client: { ... }, // Detected browser or bot information.
17
17
}
18
18
```
19
19
@@ -39,14 +39,15 @@ The available risk scores include:
39
39
40
40
41
41
### Network Information
42
-
The `network` section provides detailed information about the user's network and IP address. This includes.
43
42
44
43
:::info
45
44
The IP address is never stored on our servers in an unhashed format. We encode it into the risk intelligence token so that we can pass it on to you.
46
45
47
46
You can compare this IP address to the one you see in your server logs to correlate the risk intelligence data with specific requests.
48
47
:::
49
48
49
+
The `network` section provides detailed information about the user's network and IP address. This includes:
50
+
50
51
*`ip`: The IP address of the user when the risk intelligence data was gathered on the frontend.
51
52
*`as`: Information about the Autonomous System (AS) associated with the user's IP address, including ASN, AS name, company, description, domain, country, RIR, route and type.
52
53
*`geolocation`: Geographic information about the user's IP address, including city, region, country.
0 commit comments