clientIpGeoLocation
required |
ClientIpGeoLocation
ClientIpGeoLocation |
The geolocation information of the client's IP address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ClientIpGeoLocation:
| Field |
Type |
Description |
|---|
ipAddress
required |
string
|
The IP address of the client.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| continent
required |
string
|
The estimated continent where the IP address is located.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| countryCode
required |
string
|
The estimated ISO-3166 alpha-2 country code of the IP address.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| countryName
required |
string
|
The full name of the estimated country where the IP address is located.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| region
required |
string
|
The region or state within the estimated country where the IP address is located.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| city
required |
string
|
The estimated city where the IP address is located.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| zipCode
required |
string
|
The estimated ZIP code or postal code of the area where the IP address is located.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| latitude
required |
number (double)
|
The estimated latitude coordinate of the IP address location.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| longitude
required |
number (double)
|
The estimated longitude coordinate of the IP address location.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isp
required |
string
|
The estimated Internet Service Provider (ISP) associated with the IP address.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| timezone
required |
string
|
The estimated timezone of the location where the IP address is situated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| domainName
required |
string
|
The estimated domain name associated with the IP address.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| elevation
required |
integer (int32)
|
The estimated elevation (in meters) of the location where the IP address is situated.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
Whether the IP address is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| usageTypes
required |
array of string
array of |
The estimated usage type(s) associated with the IP address.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isProxy
required |
boolean
|
Whether the IP address is from a known anonymous proxy server.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| proxyType
required |
string
|
The type of proxy, if the IP address is associated with a known proxy service.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
shippingAddressEvaluation
required |
ShippingAddressEvaluation
ShippingAddressEvaluation |
The evaluation results for the shipping address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of ShippingAddressEvaluation:
| Field |
Type |
Description |
|---|
isAddressShipForward
required |
boolean
|
A value indicating whether the shipping address is identified as a known ship-forward address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isBillingCountryMatch
required |
boolean
|
A value indicating whether the country of the shipping address matches the country of the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isBillingStateMatch
required |
boolean
|
A value indicating whether the state/region of the shipping address matches the state/region of the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isBillingCityMatch
required |
boolean
|
A value indicating whether the city of the shipping address matches the city of the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isBillingPostcodeMatch
required |
boolean
|
A value indicating whether the postcode/ZIP code of the shipping address matches the postcode/ZIP code of the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isExportControlledCountry
required |
boolean
|
A value indicating whether the shipping address is in a country subject to export controls.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
A value indicating whether the shipping address is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
billingAddressEvaluation
required |
BillingAddressEvaluation
BillingAddressEvaluation |
The evaluation results for the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of BillingAddressEvaluation:
| Field |
Type |
Description |
|---|
ipDistanceInKm
required |
number (double)
|
The distance between the IP address location and the billing address in kilometers.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| ipDistanceInMiles
required |
number (double)
|
The distance between the IP address location and the billing address in miles.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isCountryMatch
required |
boolean
|
A value indicating whether the country of the IP address matches the country of the billing address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
emailAddressEvaluation
required |
EmailAddressEvaluation
EmailAddressEvaluation |
The evaluation results for the email address.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of EmailAddressEvaluation:
| Field |
Type |
Description |
|---|
isFreeEmail
required |
boolean
|
A value indicating whether the email address is from a free email provider.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isDisposableEmail
required |
boolean
|
A value indicating whether the email address is from a disposable email service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isDomainExist
required |
boolean
|
A value indicating whether the domain of the email address exists.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isNewDomain
required |
boolean
|
A value indicating whether the domain of the email address is newly registered.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
A value indicating whether the email address is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
phoneNumberEvaluation
required |
PhoneNumberEvaluation
PhoneNumberEvaluation |
The evaluation results for the customer phone number, if provided.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of PhoneNumberEvaluation:
| Field |
Type |
Description |
|---|
isDisposablePhone
required |
boolean
|
A value indicating whether the phone number is associated with a disposable or temporary phone service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
A value indicating whether the phone number is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
usernameEvaluation
required |
UsernameEvaluation
UsernameEvaluation |
The evaluation results for the customer username, if provided.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of UsernameEvaluation:
| Field |
Type |
Description |
|---|
isHighRisk
required |
boolean
|
Gets or sets a value indicating whether the username is considered high risk.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
Gets or sets a value indicating whether the username is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
cardEvaluation
required |
CardEvaluation
CardEvaluation |
The evaluation results for the card used in the transaction.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of CardEvaluation:
| Field |
Type |
Description |
|---|
cardBrand
required |
string
|
The brand of the card (e.g., Visa, MasterCard, American Express).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| cardType
required |
string
|
The type of the card (e.g., Credit, Debit, Gift).
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| issuingBank
required |
string
|
The name of the bank that issued the card.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| issuingCountry
required |
string
|
The country where the card was issued.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isPrepaid
required |
boolean
|
A value indicating whether the card is a prepaid card.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| binExists
required |
boolean
|
A value indicating whether the Bank Identification Number (BIN) of the card exists in the fraud screening service's database.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| binCountryMatch
required |
boolean
|
A value indicating whether the country associated with the card's BIN matches the billing country.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
A value indicating whether the card is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
deviceEvaluation
required |
DeviceEvaluation
DeviceEvaluation |
The evaluation results for the device used in the transaction, if applicable.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
Fields of DeviceEvaluation:
| Field |
Type |
Description |
|---|
isMalwareExploit
required |
boolean
|
A value indicating whether the device is associated with known malware or exploit attempts.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
| isInBlacklist
required |
boolean
|
A value indicating whether the device is in the blacklist database of the fraud screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
This body has no documented fields. |
serviceId
required |
string
|
The unique identifier for the fraud screening service.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
transactionId
required |
string
|
The unique identifier for the transaction being evaluated.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
result
required |
string
|
The overall result/recommendation from the fraud screening service. This does not represent the approval status of the transaction at the processor, nor does it definitively indicate fraud; it is a recommendation based on the service's evaluation.
nullable
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|
score
required |
integer (int32)
|
The fraud risk score for the transaction as returned by the screening service.
Values:
Values combine: send one or more member names separated by a comma and a space, or the integer sum of their values. Responses carry the names.
|