API reference
Request fields
The userData fields isCredible understands.
Send whatever you have. Each scenario uses the fields it needs and is skipped when they are missing, so partial data never causes an error. Unknown fields are ignored.
Identity#
| Field | Type | Description |
|---|---|---|
email | string | The user's email address |
userId | string | Your stable ID for the user. Required for per-user history (logins). |
accountId / customerId | string | Alternatives to userId |
phone | string | Phone number, if collected |
Network and device#
| Field | Type | Description |
|---|---|---|
ip | string | The client's IP address |
deviceId | string | Stable device or browser ID (how) |
userAgent | string | The User-Agent header |
webdriver | boolean | navigator.webdriver |
browserPlugins | string[] | Plugin names |
screenResolution | object | { width, height } |
platform | string | navigator.platform |
geoLocation | object | { latitude, longitude, country } |
previousLocation | object | Location of the previous login |
timeBetweenLocations | number | Seconds since the previous login |
Event#
| Field | Type | Description |
|---|---|---|
accountCreation | boolean or ISO date | Set on signups |
paymentFingerprint | string | Card fingerprint from your processor |
loginAttempts | number | Failed attempts before this login |
passwordChanged | boolean | The user just changed their password |
sensitiveActionPerformed | boolean | A sensitive action is being performed |
Usage and behaviour#
| Field | Type | Description |
|---|---|---|
accountAge | number | Account age (hours for credit checks, days for usage checks) |
creditUsage / resourceUsage | number 0-1 or object | Share of free credits or plan resources used |
formCompletionTime, formInteractions, copyPasteEvents, hesitationPatterns, navigationFlow, referralSource | Signup form behaviour (details) |
Each built-in scenario documents its inputs in the dashboard, with sample data you can test.