Skip to content

Commit 7ff7399

Browse files
authored
Merge pull request #93 from FriendlyCaptcha/ri-docs
Risk Intelligence page in docs
2 parents d4275d8 + 637a0e3 commit 7ff7399

23 files changed

Lines changed: 4480 additions & 13 deletions

LICENSE

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -1,6 +1,6 @@
11
MIT License
22

3-
Copyright (c) 2020-2024 Friendly Captcha GmbH
3+
Copyright (c) 2020-2026 Friendly Captcha GmbH
44

55
Permission is hereby granted, free of charge, to any person obtaining a copy
66
of this software and associated documentation files (the "Software"), to deal

README.md

Lines changed: 1 addition & 1 deletion
Original file line numberDiff line numberDiff line change
@@ -2,7 +2,7 @@
22

33
This is the source code of [Friendly Captcha](https://friendlycaptcha.com)'s [Developer Hub](https://developer.friendlycaptcha.com).
44

5-
This website uses [Docusaurus 2](https://docusaurus.io/).
5+
This website uses [Docusaurus 3](https://docusaurus.io/).
66

77
## Am I using V1 or V2
88

docs/api/siteverify.md

Lines changed: 10 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -35,9 +35,10 @@ The response body is a JSON object which has a `success` field that tells you wh
3535
"data": {
3636
"event_id": "ev_CkK-YXwlFf-15_f", // Unique identifier for the siteverify request.
3737
"challenge": {
38-
"timestamp": "2025-03-18T13:01:25Z", // ISO 8601 timestamp when the captcha challenge was completed.
38+
"timestamp": "2026-02-05T13:01:25Z", // ISO 8601 timestamp when the captcha challenge was completed.
3939
"origin": "https://example.com" // Origin where the challenge happened. This can be empty if unknown.
40-
}
40+
},
41+
"risk_intelligence": null // `null` unless you have enabled Risk Intelligence on your account. See below.
4142
}
4243
}
4344
```
@@ -94,6 +95,13 @@ It is better to temporarily accept bots or spam than to reject all requests. *Do
9495
:::
9596

9697

98+
## Risk Intelligence
99+
The `risk_intelligence` field in the successful response is `null` unless you have enabled [*Risk Intelligence on Captcha Challenge*](../risk-intelligence/on-captcha-challenge.md) on your account.
100+
101+
Risk Intelligence allows you to receive risk scores and details about the solver of the request. This can help you make more informed decisions about how to handle the request, and allows you to feed the risk data into your fraud detection systems.
102+
103+
This is a paid add-on feature that is available on **Friendly Captcha Advanced** and **Enterprise** plans.
104+
97105
## Troubleshooting & Tips
98106

99107
### `method_not_allowed`

docs/getting-started/verify.md

Lines changed: 3 additions & 2 deletions
Original file line numberDiff line numberDiff line change
@@ -48,9 +48,10 @@ The response body is a JSON object which has a `success` field that tells you wh
4848
"data": {
4949
"event_id": "ev_CkK-YXwlFf-15_f", // Unique identifier for the siteverify request.
5050
"challenge": {
51-
"timestamp": "2025-03-18T13:01:25Z", // ISO 8601 timestamp when the captcha challenge was completed.
51+
"timestamp": "2026-02-05T13:01:25Z", // ISO 8601 timestamp when the captcha challenge was completed.
5252
"origin": "example.com" // Origin where the challenge happened. This can be empty if unknown.
53-
}
53+
},
54+
"risk_intelligence": null // `null` unless you have enabled Risk Intelligence on your account.
5455
}
5556
}
5657
```

0 commit comments

Comments
 (0)