Get a risk assessment using IPQualityScore

POST 
/kyt/ipsqualityscore

Get a risk assessment for a given IP address using IPQualityScore. Requires the IPQualityScore provider.

Request

application/json

Body

required

apiKey stringnullable
ipValue stringnullable
userEmail stringnullable
userPhoneNumber stringnullable
customerId stringrequired

Responses

200

Successful response

application/json

Schema

Schema

anyOf
MOD1
error object required
anyOf
MOD1
success booleanrequired
message stringrequired
Possible values: [Invalid or unauthorized key. Please check the API key and try again.]
request_id stringrequired
MOD2
error stringrequired
Possible values: [UNKNOWN_ERROR]
message stringrequired
MOD3
error stringrequired
Possible values: [RESULT_PARSER_ERROR]
message stringrequired
data stringrequired
MOD2
ipVerification objectnullable
success booleanrequired
request_id stringrequired
message stringnullable
fraud_score integernullable
Possible values: <= 100
country_code stringnullable
region stringnullable
city stringnullable
ISP stringnullable
ASN numbernullable
organization stringnullable
is_crawler booleannullable
timezone stringnullable
mobile booleannullable
host stringnullable
proxy booleannullable
vpn booleannullable
tor booleannullable
active_vpn booleannullable
active_tor booleannullable
recent_abuse booleannullable
bot_status booleannullable
connection_type stringnullable
abuse_velocity stringnullable
zip_code stringnullable
latitude numbernullable
longitude numbernullable
emailVerification objectnullable
success booleanrequired
request_id stringrequired
message stringnullable
valid booleannullable
timed_out booleannullable
disposable booleannullable
first_name stringnullable
deliverability stringnullable
smtp_score numbernullable
overall_score numbernullable
catch_all booleannullable
generic booleannullable
common booleannullable
dns_valid booleannullable
honeypot booleannullable
frequent_complainer booleannullable
suspect booleannullable
recent_abuse booleannullable
fraud_score numbernullable
Possible values: <= 100
leaked booleannullable
suggested_domain stringnullable
domain_velocity stringnullable
user_activity stringnullable
associated_names objectnullable
status stringnullable
names string[]nullable
associated_phone_numbers objectnullable
status stringnullable
phone_numbers string[]nullable
first_seen objectnullable
human stringnullable
timestamp numbernullable
iso stringnullable
domain_age objectnullable
human stringnullable
timestamp numbernullable
iso stringnullable
spam_trap_score stringnullable
sanitized_email stringnullable
phoneVerification objectnullable
success booleanrequired
request_id stringrequired
message stringnullable
formatted stringnullable
local_format stringnullable
valid booleannullable
fraud_score numbernullable
Possible values: <= 100
recent_abuse booleannullable
VOIP booleannullable
prepaid booleannullable
risky booleannullable
active booleannullable
name stringnullable
carrier stringnullable
line_type stringnullable
country stringnullable
region stringnullable
city stringnullable
timezone stringnullable
zip_code stringnullable
dialing_code numbernullable
do_not_call booleannullable
leaked booleannullable
spammer booleannullable
active_status stringnullable
user_activity stringnullable
associated_email_addresses objectnullable
status stringnullable
emails string[]nullable
error stringnullable

Example (from schema)

{}

default

Error response

application/json

Schema

Schema

message stringrequired
code stringrequired
issues object[]
Array [
message stringrequired
]

Example (from schema)

{
  "message": "string",
  "code": "string",
  "issues": [
    {
      "message": "string"
    }
  ]
}

Loading...