Overview
Base URLs, versioning and conventions used across the AbuseZero API.
The AbuseZero API is a JSON REST API. Every endpoint page includes a playground, so you can send real requests to the sandbox with a test key.
Base URLs
https://api.abusezero.comConventions
- All endpoints are versioned under
/v1. - Requests and responses use
application/json. - Timestamps are ISO 8601 strings in UTC.
- IDs are prefixed by type:
chk_for checks,ben_for benefits andrule_for rules.
Authentication
Send your secret key as a bearer token. See Authentication for key types.
Endpoints
Create a risk check POST
Scores an identity against device, network, email and benefit history
signals, then applies your rules to return a decision.
Retrieve a risk check GET
Check completed Webhook
Sent when an asynchronous check finishes scoring.
List benefit claims GET
Returns every benefit linked to an identity, newest first.
Record a benefit claim POST
Call this after you grant a benefit so future checks can see it.
List rules GET
Create a rule POST
Update a rule PATCH
Delete a rule DELETE
How is this guide?
Edit on GitHub
Last updated on