API reference

Built-in scenarios

The ready-made scenarios and the data each one needs.

Scenarios are groups of checks for one kind of abuse. They run automatically when the data they need is present. Pass scenarioId or scenarioIds to run specific ones.

Scenario ID	Protects against	Main inputs
`SYS_DISPOSABLE_EMAIL_001`	Throwaway email addresses	`email`
`SYS_MULTI_ACCOUNT_001`	One person, many accounts	`email`, `deviceId`, `ip`, `accountCreation`
`SYS_FREE_TRIAL_ABUSE_001`	Repeated free trials	`email`, `deviceId`, `ip`, `paymentFingerprint`
`SYS_CREDIT_ABUSE_MASTER_001`	Free-credit farming	`email`, `ip`, `deviceId`, `resourceUsage`, `accountAge`
`SYS_SIGNUP_FRAUD_001`	Scripted signups	Form behaviour fields
`SYS_BOT_DETECTION_001`	Bots and automation	`userAgent`, `clickStream`, `inputTiming`, `navigationTiming`
`SYS_DEVICE_FINGERPRINT_001`	Emulators and inconsistent browsers	`userAgent`, `deviceId`, browser details
`SYS_IP_LOCATION_001`	VPNs, proxies, impossible travel	`ip`, `geoLocation`, `previousLocation`
`SYS_ACCOUNT_TAKEOVER_001`	Account takeover at login	`userId`, `deviceId`, `geoLocation`, `loginAttempts`
`SYS_CREDENTIAL_STUFFING_001`	Password-guessing attacks	`loginAttempts`, `loginVelocity`, `ipData`
`SYS_SESSION_ANOMALY_001`	Unusual sessions	`sessionDuration`, `clickCount`, `featureAccess`
`SYS_ACCOUNT_SHARING_001`	Shared accounts	`deviceCount`, `concurrentSessions`, `accountType`
`SYS_BEHAVIOR_001`	Abusive usage behaviour	`creditUsage`, `accountAge`, `clickPattern`
`SYS_RESOURCE_ABUSE_001`	Resource draining	`resourceUsage`, `usageVelocity`, `engagementMetrics`
`SYS_API_ABUSE_001`	API scraping and key sharing	`usageMetrics`, `requestPattern`, `ipData`
`SYS_CONTENT_SPAM_001`	Spam posting	`contentVelocity`, `contentSimilarity`, `urlCount`
`SYS_FAKE_PROFILE_001`	Fake profiles	`profileData`, `profileConsistency`, `imageMetadata`
`SYS_REFERRAL_ABUSE_001`	Self-referrals	`referralData`, `referrerProfile`, `commonSignals`
`SYS_SUBSCRIPTION_FRAUD_001`	Subscription cycling	`accountHistory`, `subscriptionData`, `paymentData`
`FRD_CHARGEBACK_PREVENTION_001`	Chargebacks	`transaction`, `customer`, `device`, `payment`

Open a scenario in the dashboard to see its full input list and sample data, and to run it against test data.

Your own scenarios#

In the dashboard you can clone a built-in scenario and adjust it, or create your own from scratch. Your scenarios run instead of the built-in ones for your account; call with ?profileId=default to use the built-in set at any time.