Skip to content

Commit 8fd4fa3

Browse files
authored
A few small fixes for Risk Intelligence format doc (#99)
* Add missing word * Shorten to avoid having to scroll horizontally even on desktop * Add colon and move info block above
1 parent 6b9f06a commit 8fd4fa3

1 file changed

Lines changed: 7 additions & 6 deletions

File tree

docs/risk-intelligence/format.md

Lines changed: 7 additions & 6 deletions
Original file line numberDiff line numberDiff line change
@@ -3,17 +3,17 @@
33
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).
44

55
:::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.
77
:::
88

99
## Structure Overview
1010
The Risk Intelligence data is organized into three high level sections:
1111

1212
```json
1313
{
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.
14+
risk_scores: { ... }, // Overall risk scores per category (1-5).
15+
network: { ... }, // Information about the user's network and IP address.
16+
client: { ... }, // Detected browser or bot information.
1717
}
1818
```
1919

@@ -39,14 +39,15 @@ The available risk scores include:
3939

4040

4141
### Network Information
42-
The `network` section provides detailed information about the user's network and IP address. This includes.
4342

4443
:::info
4544
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.
4645

4746
You can compare this IP address to the one you see in your server logs to correlate the risk intelligence data with specific requests.
4847
:::
4948

49+
The `network` section provides detailed information about the user's network and IP address. This includes:
50+
5051
* `ip`: The IP address of the user when the risk intelligence data was gathered on the frontend.
5152
* `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.
5253
* `geolocation`: Geographic information about the user's IP address, including city, region, country.
@@ -1189,4 +1190,4 @@ Note
11891190

11901191
</details>
11911192

1192-
</details>
1193+
</details>

0 commit comments

Comments
 (0)