Docs menu
Guides
API reference
Test mode and magic test addresses
Test keys let you build and test an integration against the real API without using your monthly quota, creating reviews or sending webhooks. Five magic addresses give fixed answers, so your tests can cover every verdict.
Last updated
Test keys
Create them in the console under Settings › Keys:
- a test secret API key:
bs_test_…(the "Test key" box), for/verify,/siteverify,/feedbackand/reviews; - a test site key:
bs_site_test_…(the "Test site key" box), for the browser script and/check.
The key decides the mode, per request: an account can use live and test keys side by side. The API host is the same, https://api.inlineshield.io. The former sandbox host, sandbox.api.inlineshield.io, now redirects to this page.
Magic addresses
With a test key, these addresses always give the same result, without running the screening engine. The part before @ is case-insensitive; the domain must be exactly test.inlineshield.io.
| Address | decision | action | recommendedAction | riskScore |
|---|---|---|---|---|
allow@test.inlineshield.io | ALLOWED | allow | allow | 0 |
nobonus@test.inlineshield.io | ALLOWED | allow | allow_no_bonus | 30 |
review@test.inlineshield.io | QUARANTINED | hold | review | 50 |
kyc@test.inlineshield.io | QUARANTINED | hold | require_kyc | 60 |
block@test.inlineshield.io | BLOCKED | block | block | 95 |
A held test screening (review@, kyc@, or any held test screening) answers action: "hold" with no reviewId: test mode creates no review. A live key screens these addresses like any other address. Any other address with a test key runs the real screening engine; the answer is real, and nothing is counted.
What test mode does and does not do
- Test screenings are recorded. History in the console shows them with "Show test data", marked Test.
- They never count against your monthly quota, and they never create a review, a webhook, a label, learning data or alert data.
- Feedback on a test screening is accepted but never recorded (
changed: false). - Live
/verifyand/checkresponses carry theX-Quota-*headers; test responses do not. - An account that is over its monthly quota gets
402 QUOTA_EXCEEDEDon test/verifyand/checkrequests too; nothing is counted. - A token from a test site key can be redeemed with a live secret key of the same account and the other way round; the result follows the mode of the screening.
- The console's setup checklist does not count test traffic: the "protected" state needs live traffic.
Limits
- 300 requests per minute per account on each of
/verifyand/check, separate from your live limits (/checkis also limited to 30 per minute per client IP). - 300 per minute per test key on
/siteverify. - 10,000 test screenings (
/verifyand/check) per account per UTC day. Past that,429 TEST_LIMITwithRetry-Afterset to the next UTC midnight.
Webhooks and reviews
No webhook is sent for test traffic. To check your endpoint, use Settings › Webhook › Send test ping in the console: it sends one signed test.ping delivery. To try a held sign-up end to end with a real reviewId, see Hold and review.