Add Risk Intelligence API documentation#98
Merged
greenberga merged 8 commits intomainfrom Mar 10, 2026
Merged
Conversation
greenberga
force-pushed
the
risk-intelligence-setup
branch
from
aeeb8fb to
d600ed0
Compare
rokostik
approved these changes
Mar 9, 2026
|
|
||
| ## Caching | ||
|
|
||
| The SDK caches generated tokens to improve performance and efficiency. For example, if two `sdk.riskIntelligence()` calls get made (with the same sitekey and to the same API endpoint), they will receive the same token. You can disable this behavior by setting the `bypassCache` configuration parameter. |
Contributor
There was a problem hiding this comment.
Should we mention that it's cached for roughly 15 minutes?
docs/risk-intelligence/index.md
Outdated
Comment on lines
10
to
12
| The primary way to get Risk Intelligence data is through the Risk Intelligence API. This allows you to collect a risk intelligence token in the frontend and send it to your backend for verification. | ||
| The primary way to get Risk Intelligence data is through the Risk Intelligence API. This allows you to collect a risk intelligence token in the frontend and send it to your backend to retrieve the data. | ||
|
|
||
| This functionality is currently in private beta and will be available for all **Advanced** and **Enterprise** plans later in Q1 2026. If you are interested in getting early access to this feature, please contact our support team. |
Contributor
There was a problem hiding this comment.
I would maybe link to the getting started section from here if the users wants to use the "primary" way?
greenberga
force-pushed
the
risk-intelligence-setup
branch
from
1092fc1 to
d5f6bc1
Compare
This file contains hidden or bidirectional Unicode text that may be interpreted or compiled differently than what appears below. To review, open the file in an editor that reveals hidden Unicode characters.
Learn more about bidirectional Unicode characters
Sign up for free
to join this conversation on GitHub.
Already have an account?
Sign in to comment
2 participants
Add this suggestion to a batch that can be applied as a single commit.This suggestion is invalid because no changes were made to the code.Suggestions cannot be applied while the pull request is closed.Suggestions cannot be applied while viewing a subset of changes.Only one suggestion per line can be applied in a batch.Add this suggestion to a batch that can be applied as a single commit.Applying suggestions on deleted lines is not supported.You must change the existing code in this line in order to create a valid suggestion.Outdated suggestions cannot be applied.This suggestion has been applied or marked resolved.Suggestions cannot be applied from pending reviews.Suggestions cannot be applied on multi-line comments.Suggestions cannot be applied while the pull request is queued to merge.Suggestion cannot be applied right now. Please check back later.
A bunch of this is auto-generated API documentation. I'd recommend just running this locally and reading through the documentation under Risk Intelligence/Getting Started, following links where necessary.
Closes https://github.com/FriendlyCaptcha/friendly-captcha/issues/3280
Closes https://github.com/FriendlyCaptcha/friendly-captcha/issues/3336