Requirements
- API key pair
- Fraud probability credits
Estimate Fraud Probability
Authorization:
API key pair
Method: POST
Endpoint: https://ivs.idenfy.com/fraud/estimate-fraud-probabilityAlthough none of the parameters below are individually required, the request must contain at least one of them.
Request Parameters
| Key | Required | Type | Constraints | Explanation |
|---|---|---|---|---|
userAgent | No | String | Max length 512 | The HTTP User-Agent header of the browser |
acceptLanguage | No | String | — | The HTTP Accept-Language header of the device |
ipAddress | No | String | ipv4 or ipv6 format | User’s IP address |
firstName | No | String | Max length 255 | User’s first name |
lastName | No | String | Max length 255 | User’s last name |
emailAddress | No | String | Max length 255 | User’s email address |
emailDomain | No | String | Max length 255 | The domain of the emailAddress |
streetAddress | No | String | Max length 255 | The first line of the user’s living address |
city | No | String | Max length 255 | User’s city |
country | No | String | Country alpha-2 code | User’s country |
postalCode | No | String | Max length 255 | The postal/zip code of user’s living address |
phoneNumber | No | String | Max length 255 | User’s phone number without country code |
phoneCountryCode | No | String | Max length 4 | User’s phone country code (e.g. +370) |
creditCardNumber6 | No | String | Length 6 | The first 6 digits of the user’s payment card |
creditCardLast4Digits | No | String | Length 4 | The last 4 digits of the user’s payment card |
Request Example
{
"userAgent": "Mozilla/5.0 (Android 7.0; Mobile; rv:54.0) Gecko/54.0 Firefox/54.0",
"acceptLanguage": "en-US,en;q=0.8",
"ipAddress": "64.236.213.12",
"firstName": "John",
"lastName": "Smith",
"emailAddress": "john@gmail.com",
"emailDomain": "gmail.com",
"streetAddress": "123 Address Rd.",
"city": "Boston",
"country": "US",
"postalCode": "34455",
"phoneNumber": "3439007998",
"phoneCountryCode": "1",
"creditCardNumber6": "410608",
"creditCardLast4Digits": "9930"
}
Response Example
{
"fraudLevel": "LOW"
}
Fraud Levels
| Key | Type | Possible Values |
|---|---|---|
fraudLevel | String | VERY_LOW, LOW, MEDIUM, HIGH, VERY_HIGH, NOT_CHECKED |