The following tables show Payments Fraud data points split into different views in Data on Demand. Use this information as reference when migrating from Command to Payments Fraud in Kount 360. To see Command data points, refer to Command Data in Kount Data on Demand - Data Dictionary.
The amount of data available is dependent on each customer integration. Customers who do not provide the optional data in their Kount implementation will not see that data standardized or augmented in Data on Demand.
sidebar. Orders table
The Orders table view for the Orders payload.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
EVENT_TS |
The timestamp of the transaction event. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
2025-07-28 19:25:13 |
|
CLIENT_ID |
Kount assigned Customer ID number. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
900111 123456789012345 |
|
ORDER_ID |
Unique identifier of the order so the order can be queried and referenced in other contexts. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
d121ea2210434ffc8a90daff9cc97e76 JB8NBH9VN965HW6Z |
|
ORDER |
An object containing the details of the order that was performed. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
sidebar. Order Agent Activity table
This table provides the Agent Activity view in the Orders payload.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
EVENT_TS |
The timestamp of the transaction event. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ASSIGNAGENT_RAW |
2025-07-28 19:25:13 |
|
CLIENT_ID |
Kount assigned Customer ID number. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ASSIGNAGENT_RAW |
900111 123456789012345 |
|
ORDER_ID |
Unique identifier of the order so the order can be queried and referenced in other contexts. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ASSIGNAGENT_RAW |
d121ea2210434ffc8a90daff9cc97e76 JB8NBH9VN965HW6Z |
|
ASSIGNED_TO_ID |
The unique identifier of the assigned agent. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ASSIGNAGENT_RAW |
123456789 |
|
ASSIGNED_TO_NAME |
The name of the assigned agent. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ASSIGNAGENT_RAW |
Jane Doe |
sidebar. Order Notes table
This table contains the notes activity view for orders that are evaluated for review.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
EVENT_TS |
The timestamp of the transaction event. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ADDNOTES_RAW |
2025-07-28 19:25:13 |
|
CLIENT_ID |
Kount assigned Customer ID number. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ADDNOTES_RAW |
900111 123456789012345 |
|
ORDER_ID |
Unique identifier of the order so the order can be queried and referenced in other contexts. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ADDNOTES_RAW |
d121ea2210434ffc8a90daff9cc97e76 JB8NBH9VN965HW6Z |
|
NOTE |
The change value in the payload. |
PROD06.DATALAKE.TRANSACTION_SERVICE_ADDNOTES_RAW |
Order approved. |
|
STATUS |
The status (approve or decline) for the change value in the payload. |
PROD06.DATALAKE.TRANSACTION_SERVICE_UPDATESTATUS_RAW |
Approve |
sidebar. Order States table
This table contains the order data view.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
CLIENT_ID |
Kount assigned Customer ID number. |
PROD06.DATALAKE.TRANSACTION_SERVICE_UPDATESTATUS_RAW |
900111 123456789012345 |
|
ORDER_ID |
Unique identifier of the order so the order can be queried and referenced in other contexts. |
PROD06.DATALAKE.TRANSACTION_SERVICE_UPDATESTATUS_RAW |
d121ea2210434ffc8a90daff9cc97e76 JB8NBH9VN965HW6Z |
|
CLIENT_ORDER_ID |
The merchant-provided unique identifier for this order. Uniqueness for this property is not enforced. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
"6519623811154" "etNKJKVN814an5Ri9UtQD9eBvLQ5yKwy"" |
|
AUTHORIZATION_STATUS |
Details the order's authorization result (authResult). |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
APPROVED |
|
SCORE |
The Omniscore provided in the response payload. |
PROD06.DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW |
68 |
|
STATUS_UPDATE_DATE |
The order's update timestamp. |
PROD06.DATALAKE.TRANSACTION_SERVICE_UPDATESTATUS_RAW |
2025-07-28 19:25:13 |
|
STATUS |
The change value (approve or decline) of the order update. |
PROD06.DATALAKE.TRANSACTION_SERVICE_UPDATESTATUS_RAW |
Approve |
|
CHARGEBACK_REFUND_DATE |
The timestamp of the chargeback refund. |
PROD06.DATALAKE.TRANSACTION_SERVICE_CHARGEBACK_REFUND_RAW |
2025-07-28 19:25:13 |
|
REFUND |
Details if the order is a refund or not. |
PROD06.DATALAKE.TRANSACTION_SERVICE_CHARGEBACK_REFUND_RAW |
True |
|
CHARGEBACK |
Details if the order is a chargeback or not. |
PROD06.DATALAKE.TRANSACTION_SERVICE_CHARGEBACK_REFUND_RAW |
True |
|
CHARGEBACK_REASON_CODE |
The reason code assigned to the order chargeback. |
PROD06.DATALAKE.TRANSACTION_SERVICE_CHARGEBACK_REFUND_RAW |
AB123 |
|
FRAUD_STATUS |
Details if the order has a fraud status or not. |
PROD06.DATALAKE.TRANSACTION_SERVICE_CHARGEBACK_REFUND_RAW |
NONE, TC40, SAFE or OTHER |
sidebar. Ekata table
This table contains the Ekata data view related to Payments Fraud in Kount 360 in Data on Demand.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
EVENT_TS |
The timestamp of the transaction event. |
"DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW (original evaluation) DATALAKE.TRANSACTION_SERVICE_UPDATEFROMEVENT_RAW (update from the user interface)" |
2025-07-28 19:25:13 |
|
CLIENT_ID |
Kount assigned Customer ID number. |
"DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW (original evaluation) DATALAKE.TRANSACTION_SERVICE_UPDATEFROMEVENT_RAW (update from the user interface)" |
900111 123456789012345 |
|
ORDER_ID |
Unique identifier of the order so the order can be queried and referenced in other contexts. |
"DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW (original evaluation) DATALAKE.TRANSACTION_SERVICE_UPDATEFROMEVENT_RAW (update from the user interface)" |
d121ea2210434ffc8a90daff9cc97e76 JB8NBH9VN965HW6Z |
|
EKATA_DATA |
The Ekata data response payload. |
"DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW (original evaluation) DATALAKE.TRANSACTION_SERVICE_UPDATEFROMEVENT_RAW (update from the user interface)" |
|
|
EKATA_STATUS |
The Kount evaluation results using the Ekata response (pass, neutral, warning). |
"DATALAKE.COMMERCE_ORCHESTRATOR_ORDERS_RAW (original evaluation) DATALAKE.TRANSACTION_SERVICE_UPDATEFROMEVENT_RAW (update from the user interface)" |
PASS |
sidebar. Lists table
This table contains the List data view related to Payments Fraud in Kount 360 in Data on Demand.
|
Column Name/Data Point |
Definition |
Source Name |
Sample Data |
|
ORG_ID |
The unique identifier for the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
123ABC7890123ABC7890 |
|
ORG_NAME |
The name of the customer's organization. |
PROD06.DATALAKE.ORGANIZATION |
Company Org |
|
CLIENT_ID |
Kount assigned Customer ID number. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
900111 123456789012345 |
|
USERS_EMAIL |
The user's email. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
user@example.com |
|
EVENT_TS |
The timestamp of the transaction event. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
2025-07-28 19:25:13 |
|
LIST_ID |
Unique identifier for the list. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
123456789 |
|
LIST_TYPE |
The type of list (Device Country, Device ID, Payment Token, Physical Address, Text, User IP Address). |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
Device ID |
|
LIST_NAME |
The name of the list. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
Device Country Blocklist |
|
LIST_DESCRIPTION |
The description of the list. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
A list of blocked countries. |
|
ACTION |
The action performed with the list. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
|
|
ENTRY_VALUE |
The value entered with the list. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
|
|
ENTRY_NOTES |
The notes provided with the entry value. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
Blocklist applied. |
|
PAYLOAD |
Payload from DATALAKE.PBE_DECISION_MANAGER_RAW. |
PROD06.DATALAKE.PBE_DECISION_MANAGER_RAW |
This table provides data for the count and time window for velocity checks requested on fields like CUSTOMER_ID and EMAIL_ADDRESS.
sidebar. Response Aggregate Velocities data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
aggregateVelocities |
|
An array containing the velocity response objects for each requested field. |
(Array) |
|
field |
|
The specific field for which the velocity was calculated. |
|
|
responseCode |
|
The status code for the velocity calculation request on the specific field. |
|
|
response |
|
The container object for the actual velocity count results. |
(Object) |
|
velocityCount |
|
An array containing the individual velocity count results for different time buckets. |
(Array) |
|
timeBucketMinutes |
|
The duration of the time window used for the velocity count calculation. |
|
|
count |
|
The number of times the field was observed within the specified time bucket. This is typically omitted if the count is zero. |
|
The following table lists specific string messages detailing client-side validation errors encountered during the request submission.
sidebar. Client Errors data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
clientErrors |
|
An array containing specific error messages encountered during client-side processing or validation. |
"invalid string custom field: SHOPIFY_IS_RECURRING is not a string" "invalid boolean custom field: SHOPIFY_ORDERS_COUNT is not a boolean" "invalid boolean custom field: SHOPIFY_TOTAL_PYMT_TRANS is not a boolean" "invalid boolean custom field: SHOPIFY_FAILED_PYMT_TRANS is not a boolean" |
The following table contains details of the currency for the order, including conversion timestamps, and the resulting converted/source monetary amounts in standardized units.
sidebar. Currency data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
currency |
|
The container object for currency-related information, typically including conversion details. |
(Object) |
|
responseCode |
|
The status code for the currency request or calculation. |
|
|
currencyData |
|
The container object holding the details of the currency conversion. |
(Object) |
|
conversionTimestamp |
|
The timestamp when the conversion was performed. |
|
|
rateTimestamp |
|
The timestamp corresponding to when the conversion rates were valid. |
|
|
ratesUsed |
|
An object containing the currency conversion rates used, keyed by currency code. |
(Object) |
|
USD |
|
The conversion rate for US Dollars (USD). |
|
|
convertedMoney |
|
An array of money objects representing the amounts after conversion. |
(Array) |
|
sourceMoney |
|
An array of money objects representing the original amounts before conversion. |
(Array) |
|
currencyCode |
|
The currency code for the converted amount. |
|
|
units |
|
The major units of the monetary amount (for example, the dollar amount). |
|
|
nanos |
|
The sub-units of the monetary amount (for example, the cents/nanos part). |
|
|
units |
|
The major units of the monetary amount (for examlpe, the dollar amount). |
|
|
nanos |
|
The sub-units of the monetary amount (for example, the cents/nanos part). |
|
The following table details an array of key-value pairs used to pass merchant-specific metadata (for example, PROVINCE, SHOPIFY_APP_ID) not covered by standard fields.
sidebar. Custom Fields data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
customFields |
|
An array of custom key-value pairs used to store additional transaction or order metadata. |
(Array) |
|
[Item] |
|
An individual custom field object within the array. |
(Object) |
|
name |
|
The name or key of the custom field. |
|
|
value |
|
The value associated with the custom field name. |
|
The following table provides an object example containing various application-specific metadata fields passed by a merchant. User Defined Fields (UDFs) are the same as
sidebar. User Defined Fields data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
userDefinedFields |
|
The container object for a collection of custom, user-defined key-value pairs of metadata. |
(Object) |
|
CREDIT_CARD_WALLET |
|
A custom field example indicating the type of payment method used. |
|
|
CUSTOMERTYPE |
|
A custom field example detailing the customer's type/status. |
|
|
ORDER_TAGS |
|
A custom field example containing tags associated with the order. |
|
|
PROVINCE |
|
A custom field example providing the state or province of a relevant address. |
|
|
SHOPIFY_IS_TEST |
|
A custom boolean field example indicating if the transaction was a test. |
|
|
SHOPIFY_APP_ID |
|
A custom field examlpe containing a numeric application identifier. |
|
|
SHOPIFY_GATEWAY |
|
A custom field example indicating the payment gateway used. |
|
Provides the status of device data collection, indicating that detailed device attributes were not found for the given session.
The following table provides top-level request container grouping inputs like client ID, device info, geographical distances, and extensive historical billing email insights.
sidebar. Evaluate Payment Event Request data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
evaluatePaymentEventRequest |
|
The primary object containing all data and signals used for evaluating a payment event. |
(Object) |
|
clientId |
|
The unique identifier for the client associated with the request. |
|
|
accountProtectionTags |
|
Placeholder for Account Protection tags. |
(Object) |
|
advancedVelocities |
|
Placeholder for advanced velocity calculations. |
(Object) |
|
device |
|
The container object for all device and network-related information. |
(Object) |
|
deviceIdPresent |
|
A boolean indicating whether a unique device identifier was successfully collected. |
|
|
ipAddress |
|
The IP address of the device making the request. |
|
|
noHtmlCookieCollection |
|
A boolean indicating if HTML cookie collection was disabled or unsuccessful. |
|
|
neustar |
|
A container object for IP intelligence data provided by a third-party service (Neustar). |
(Object) |
|
ipAddress |
|
The IP address sent to or returned by the Neustar service. |
|
|
proxyLastDetected |
|
A timestamp indicating the last time a proxy/VPN was detected for this IP address. |
|
|
distances |
|
An array containing details for calculating geographical distances between specified points. |
(Array) |
|
[Item] |
|
An individual object specifying the origin and destination for a distance calculation. |
(Object) |
|
from |
|
The starting geographical point for the distance calculation. |
|
|
to |
|
The ending geographical point for the distance calculation. |
|
|
billingEmailInsights |
|
An object containing various risk and behavioral insights related to the billing email address. |
(Object) |
|
AverageCartSize |
|
The average monetary size of transactions/carts associated with this email. |
|
|
DateFirstSeen |
|
The date and time when this email address was first observed. |
|
|
DistinctBins |
|
The number of distinct credit card BINs (first 4-6 digits) used with this email. |
|
|
DistinctPToks |
|
The number of distinct payment tokens (or credit cards) associated with this email. |
|
|
MaxDollarAmount |
|
The maximum dollar amount seen in a single transaction for this email. |
|
|
age |
|
The number of days since the email address was first seen. |
|
|
chargebacks |
|
The total count of chargebacks associated with this email address. |
|
|
emailTrustWorthinessScore |
|
A risk score assessing the estimated trustworthiness of the email domain and history. |
|
|
occurrenceMostCommonBillAddress |
|
The count of transactions using the most frequent billing address seen for this email. |
|
|
usernameLength |
|
The character length of the email address's local part (before the '@' symbol). |
|
The following table provides the Omniscore and order details, including full billing/shipping addresses, payment authorization status, card BIN data, and shopping cart items.
sidebar. Omniscore data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
omniscore |
|
A numerical score representing the overall risk or evaluation result for the transaction. |
|
|
orderId |
|
The unique identifier for the order/transaction. |
|
|
order |
|
The container object for all details related to the customer's order. |
(Object) |
|
orderNumber |
|
The order number field. |
|
|
billingShippingMatch |
|
A boolean indicating if the billing and shipping addresses match. |
|
|
postalCodeMatch |
|
A boolean indicating if the billing and shipping postal codes match. |
|
|
siteId |
|
The identifier for the merchant's e-commerce site or platform. |
|
|
userId |
|
The customer's unique user ID on the merchant's system. |
|
|
billing |
|
The container object for billing contact information. |
(Object) |
|
firstName |
|
The billing contact's first name. |
|
|
lastName |
|
The billing contact's last name. |
|
|
emailAddress |
|
The billing email address. |
|
|
phoneNumber |
|
The billing phone number. |
|
|
phoneCountry |
|
The country associated with the phone number. |
|
|
emailValidationCodes |
|
Array of validation codes for the email address. |
|
|
address |
|
The container object for the billing physical address. |
(Object) |
|
line1 |
|
The first line of the billing address. |
|
|
city |
|
The billing city. |
|
|
countryCode |
|
The two-letter ISO country code for the billing address. |
|
|
postalCode |
|
The billing postal or ZIP code. |
|
|
shipping |
|
The container object for shipping contact information. |
(Object) |
|
firstName |
|
The shipping contact's first name. |
|
|
address |
|
The container object for the shipping physical address. |
(Object) |
|
line1 |
|
The first line of the shipping address. |
|
|
payment |
|
The container object for payment instrument and authorization details. |
(Object) |
|
total |
|
The total monetary value of the payment. |
|
|
curr |
|
The three-letter currency code for the payment. |
|
|
authorizationStatus |
|
A boolean indicating if the payment authorization was successful. |
|
|
authorizationResult |
|
The string result of the payment authorization. |
|
|
cvvr |
|
The Card Verification Value (CVV) response code. |
|
|
bin |
|
The container object for card BIN (Bank Identification Number) details. |
(Object) |
|
bankName |
|
The name of the bank or institution issuing the card. |
|
|
bin |
|
The first 4-6 digits of the payment card number. |
|
|
shoppingCart |
|
The container object for items in the customer's cart. |
(Object) |
|
items |
|
An array of individual items in the shopping cart. |
(Array) |
|
name |
|
The item's SKU or product name. |
|
|
price |
|
The price of the individual item (cents). |
|
|
quantity |
|
The quantity of this item purchased. |
|
|
customerInfo |
|
Container for various customer and unique identifiers. |
(Object) |
|
uniqueID |
|
A unique customer ID associated with the order. |
|
|
persona |
|
Container for Persona intelligence and velocity metrics. |
(Object) |
|
distinctBillEmails |
|
The number of distinct billing email addresses used by this persona. |
|
|
maxVelocity |
|
The maximum frequency/velocity metric observed for this persona. |
|
|
riskiestCountry |
|
The country associated with the highest risk for this persona. |
|
|
shippingEmailInsights |
|
Container for insights specifically related to the shipping email address. |
(Object) |
|
emailAddressAssociation |
|
Boolean flag on email address association data. |
|
|
emailNameAssociation |
|
Boolean flag on email name association data. |
|
The following table provides an object containing the single key user IP address, identifying the network address of the user initiating the transaction.
The following table provides an array structure similar to Aggregate Velocities that explicitly details the count results found for requested fields like CUSTOMER_ID over specified time buckets.
sidebar. Velocity Counts data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
velocityCounts |
|
An array containing the velocity results for various requested fields. |
(Array) |
|
[Item] |
|
An object holding the velocity results for a single specified field. |
(Object) |
|
field |
|
The specific field (e.g., customer ID, email) that was analyzed for velocity. |
|
|
velocitycount |
|
An array of objects, each detailing the count for a specific time window. Note the lowercase 'c' in the JSON key. |
(Array) |
|
[Item] |
|
An individual object detailing the count for one time bucket. |
(Object) |
|
timeBucketMinutes |
|
The duration of the time window used for the velocity count calculation. |
|
|
count |
|
The number of times the field was observed within the specified time bucket. This is typically omitted if the count is zero. |
|
The following table provides IP address results, including the ipv4Address , basic location, and network attributes (isAppleRelay, isTorNode).
sidebar. Geolocation data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
geolocation |
|
The container object for all IP-based geographical and network data. |
(Object) |
|
responseCode |
|
The status code indicating the result of the geolocation data lookup. |
|
|
geolocationData |
|
The container object holding the IP address and its associated attributes. |
(Object) |
|
ipv4Address |
|
The IP address that was geolocated. |
|
|
isAppleRelay |
|
A boolean indicating if the IP address is identified as an Apple Private Relay exit node. |
|
|
isTorNode |
|
A boolean indicating if the IP address is identified as a Tor exit node. |
|
|
location |
|
The container object for derived geographical coordinates. |
(Object) |
|
countryCode |
|
The two-letter country code of the geolocated address (A1 often means anonymous proxy or unknown). |
|
|
neustarAttributes |
|
The container object for IP intelligence data provided by Neustar. |
(Object) |
|
anonymizerStatus |
|
Status indicating if the IP is linked to an anonymizer service. |
|
|
connectionType |
|
The type of internet connection (for example, Cable, DSL, Cellular). |
|
|
hostingFacility |
|
A boolean indicating if the IP belongs to a hosting provider or data center. |
|
|
kountNetworkType |
|
A proprietary network type classification. |
|
|
proxyLastDetected |
|
Timestamp of the last time a proxy/VPN was detected for this IP address. |
|
The following table details the conversion of order amounts into the merchant's base currency, including rates in a nested money format.
sidebar. Merchant Base Currency data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
merchantBaseCurrency |
|
The container object for currency conversion details related to the merchant's base currency. |
(Object) |
|
responseCode |
|
The status code for the currency data retrieval. |
|
|
currencyData |
|
The container object holding the details of the currency conversion. |
(Object) |
|
conversionTimestamp |
|
The timestamp when the conversion was performed. |
|
|
rateTimestamp |
|
The timestamp corresponding to when the conversion rates were valid. |
|
|
ratesUsed |
|
An object containing the currency conversion rates used, keyed by currency code. |
(Object) |
|
AUD |
|
The conversion rate for Australian Dollars (AUD). |
|
|
convertedMoney |
|
An array of money objects representing the amounts after conversion to the base currency. |
|
|
sourceMoney |
|
An array of money objects representing the original amounts before conversion. |
|
|
value |
|
The converted monetary amount represented as a string. |
|
|
minorUnit |
|
The number of decimal places or minor unit precision (for example, '2' for cents). |
|
|
money |
|
The nested money object providing standardized detail. |
(Object) |
|
currencyCode |
|
The three-letter currency code (usually the merchant's base currency). |
|
|
units |
|
The major units of the monetary amount (for example, the dollar amount). |
|
|
nanos |
|
The sub-units of the monetary amount. |
|
|
units |
|
The major units of the original monetary amount. |
|
|
nanos |
|
The sub-units of the original monetary amount. |
|
The following table contains the output of the risk inquiry, including the final decision (approve or decline), Omniscore, order tracking IDs, and other information.
sidebar. Merchant Response data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
merchantResponse |
|
The top-level container for the response sent back to the merchant/client. |
(Object) |
|
version |
|
The version number of the API or schema used for this response. |
|
|
order |
|
The container object for order-specific response details. |
(Object) |
|
channel |
|
The merchant's sales channel or site identifier. |
|
|
deviceSessionId |
|
A unique identifier for the customer's device/session. |
|
|
merchantOrderId |
|
The order ID as provided by the merchant. |
|
|
orderId |
|
The unique identifier assigned to the order by the risk service. |
|
|
fulfillment |
|
An array containing details about order fulfillment statuses or IDs. |
(Array) |
|
fulfillmentId |
|
The unique ID for a specific fulfillment record. |
|
|
transactions |
|
An array containing transaction details for the order. |
(Array) |
|
transactionId |
|
The unique ID for a specific transaction within the order. |
|
|
payment |
|
An array of payment details for the transaction. |
(Array) |
|
cardBrand |
|
The general type or brand of the payment card. |
|
|
riskInquiry |
|
The container object for the risk evaluation outcome. |
(Object) |
|
decision |
|
The final risk decision made for the order. |
|
|
omniscore |
|
The numerical score representing the overall risk of the transaction. |
|
|
persona |
|
The container for aggregated velocity counts related to the customer Persona. |
(Object) |
|
reasonCode |
|
The name of the reason code assigned from a triggered policy. |
"ATO" |
|
maxVelocity |
|
The maximum observed velocity count for the customer Persona. |
|
|
uniqueEmails |
|
The number of unique email addresses associated with the Persona. |
|
|
segmentExecuted |
|
The container for the risk segment that was evaluated. |
(Object) |
|
segment |
|
Details about the specific risk segment applied. |
(Object) |
|
name |
|
The name of the executed segment. |
|
The following table provides detailed, third-party validation results (using Melissa Data) for the transaction's billing name, address, email, and phone number.
sidebar. Transaction Data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
transactionData |
|
The container object for a collection of data related to individual transactions within an order. |
(Object) |
|
0 |
|
The container object for the first transaction (indexed by "0") in the order. |
(Object) |
|
billDataQuality |
|
The container for quality and verification checks performed on billing data. |
(Object) |
|
responseCode |
|
The status code for the bill data quality check. |
|
|
melissaData |
|
The container for validation results provided by the Melissa Data service. |
(Object) |
|
lookupAddress |
|
Results from the address validation service. |
(Object) |
|
address1 |
|
The verified or looked-up address line 1. |
|
|
city |
|
The verified or looked-up city. |
|
|
countryCode |
|
The two-letter ISO country code. |
|
|
latitude |
|
The geographical latitude of the address. |
|
|
longitude |
|
The geographical longitude of the address. |
|
|
lookupEmail |
|
Results from the email validation service. |
(Object) |
|
emailAddress |
|
The validated email address. |
|
|
resultCodes |
|
Array of result codes from the email validation check. |
|
|
lookupName |
|
Results from the name validation service. |
(Object) |
|
fullName |
|
The verified full name. |
|
|
gender |
|
The predicted gender ( |
|
|
lookupPhone |
|
Results from the phone validation service. |
(Object) |
|
phone |
|
The validated phone number. |
|
|
isValidated |
|
A boolean indicating if the phone number validation was successful. |
|
|
countryCallingCode |
|
The country calling code. |
|
The following table provides historical behavior associated with the billing email, including average cart size, distinct IP counts, and various risk/consistency scores.
sidebar. Bill Email Data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
billEmailData |
|
The top-level container for all historical and calculated risk metrics associated with the billing email address. |
(Object) |
|
responseCode |
|
The status code for the email data retrieval. |
|
|
data |
|
The container object holding the raw and calculated velocity/insight metrics. |
(Object) |
|
BILLEMAIL |
|
The billing email address the data pertains to. |
|
|
BILLEMAILDOMAIN |
|
The domain of the billing email address. |
|
|
DATEFIRSTSEEN |
|
The date the email address was first observed. |
|
|
DATELASTSEEN |
|
The date the email address was last observed. |
|
|
daysSinceFirstSeen |
|
The age of the email record in days. |
|
|
OCCURRENCE |
|
The total number of transactions/orders observed for this email. |
|
|
CHARGEBACKS |
|
The total number of chargebacks associated with this email. |
|
|
CHARGEBACKRATIO |
|
The ratio of chargebacks to total orders. |
|
|
DECLINESAUTH |
|
Total number of authorization declines. |
|
|
DECLINEAUTHRATIO |
|
The ratio of auth declines to total orders. |
0.083333 |
|
TOTALDOLLARAMOUNT |
|
The cumulative dollar amount of all transactions. |
|
|
MAXDOLLARAMOUNT |
|
The largest single dollar amount seen. |
|
|
AVERAGECARTSIZE |
|
The historical average cart size (number of items). |
|
|
MINOMNISCORE |
|
The lowest Omniscore seen historically. |
|
|
MEANOMNISCORE |
|
The mean Omniscore across all transactions. |
80.483333333 |
|
RECURRENCESCORE |
|
A score indicating the pattern/likelihood of repeat use. |
0.7541477526837184 |
|
EMAILTRUSTWORTHINESS SCORE |
|
A score assessing the estimated trustworthiness of the email. |
0.7949533011079388 |
|
DISTINCTIPADS |
|
Number of unique IP addresses/devices used. |
|
|
DISTINCTBINS |
|
Number of distinct credit card BINs used. |
|
|
MOSTCOMMONBILLADDRESS |
|
The billing address used most frequently. |
|
|
OCCURRENCEMOSTCOMMONBILLADDRESS |
|
Count of transactions using the most common billing address. |
|
|
MOSTCOMMONSHIPPOSTALCODE |
|
The shipping postal code used most frequently. |
|
|
PROPORTIONNULLSHIPEMAIL |
|
Proportion of transactions where the shipping email was null. |
1 |
|
PROPORTIONNULLLATLON |
|
Proportion of transactions missing latitude/longitude data. |
0.833333 |
|
PROPORTIONWEEKDAY |
|
Proportion of transactions occurring on a weekday. |
0.6666666667 |
The following table provides the simple status of a specific risk service.
sidebar. Billing Email Insight v2 table
|
Data Point |
PATH |
Definition |
Sample Data |
|
billingEmailInsightV2 |
|
The container object for the second version of email risk insights and data. |
(Object) |
|
responseCode |
|
The status code indicating the result of the service call to fetch email insights. |
|
The following table provides extensive card intelligence based on the BIN, such as BankName, CardIndicatorDescription (debit/credit), AccountLength, and fund transfer indicators.
sidebar. BIN data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
bin |
|
The top-level container for all Bank Identification Number (BIN) lookup results and metadata. |
(Object) |
|
responseCode |
|
The status code indicating the result of the BIN lookup request. |
|
|
binData |
|
The container object holding the detailed card intelligence attributes. |
(Object) |
|
Bin |
|
The specific Bank Identification Number (first 4-6 digits of a card). |
|
|
BankName |
|
The name of the issuing bank or financial institution. |
|
|
BankCountryCode2Alpha |
|
The two-letter ISO country code of the issuing bank. |
|
|
CardProductDescription |
|
The card network/product type (e.g., Visa, Mastercard). |
|
|
CardIndicatorDescription |
|
Description of the card type or indicator (for example, Credit, Debit). |
|
|
PrepaidIndicator |
|
Indicator if the card is a prepaid card. |
|
|
AccountLength |
|
The standard length of the full card number associated with this BIN. |
|
|
LowerBin |
|
The lower bound of the card number range for this BIN. |
|
|
UpperBin |
|
The upper bound of the card number range for this BIN. |
|
|
ConsumerDigitalPaymentTokenIndicator |
|
Indicator if the card supports consumer digital payment tokens (for example, Apple Pay). |
|
|
P2PMoneyTransferIndicatorDescription |
|
Description of whether Person-to-Person money transfers are allowed. |
|
The following table contains calculated feature data showing the count and risk associated with various data points (postal code, BIN, email domain).
sidebar. Boost data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
boost |
|
The top-level container for risk feature data. |
(Object) |
|
responseCode |
|
The status code for the boost data lookup. |
|
|
boostData |
|
The container object holding the calculated count and risk metrics. |
(Object) |
|
lookupKeys |
|
An array of formatted key strings used internally to retrieve the risk data. |
(Array) |
|
[Item] |
|
An individual lookup key string. |
|
|
bill_address_postal_count |
|
The total count of the billing address postal code globally/across the merchant network. |
4539.8574 |
|
bill_address_postal_positive |
|
The count of "positive" (e.g., fraudulent) transactions associated with the billing postal code. |
174.11128 |
|
bill_address_postal_risk |
|
The calculated risk rate for the billing address postal code. |
0.038351707 |
|
bill_email_domain_count |
|
The total count of the billing email's domain. |
7056817 |
|
bill_email_risk |
|
The calculated risk rate associated with the full billing email address. |
0.011435086 |
|
bin_count |
|
The total count of the payment card's BIN. |
585887.2 |
|
bin_risk |
|
The calculated risk rate associated with the payment card's BIN. |
0.067122936 |
|
device_id_count |
|
The total count of the observed device ID. |
156868670 |
|
ptok_risk |
|
The calculated risk rate associated with the payment token ( |
0.033239834 |
|
ship_address_postal_risk |
|
The calculated risk rate associated with the shipping address postal code. |
0.07904551 |
|
usd_cents_amount_risk |
|
The calculated risk rate associated with the specific dollar amount of the transaction. |
0.02393374 |
|
user_agent_count |
|
The total count of the observed user agent string. |
149847780 |
|
distances |
|
The container object for geographical distance calculation results. |
(Object) |
|
value |
|
The container object holding the distance key-value pairs. |
(Object) |
|
BillAddressToShipAddress |
|
The calculated distance between the billing and shipping addresses. |
0 |
The following table provides results from the outcome of Policy Management execution.
sidebar. Engine Evaluate Response data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
engineEvaluateResponse |
|
Container for the risk engine's direct decision and policy metadata. |
(Object) |
|
responseCode |
|
Status code for the engine evaluation service. |
|
|
evaluateData |
|
The core results from the rule execution. |
(Object) |
|
decision |
|
The final decision reached by the rule engine. |
|
|
guidance |
|
Supplementary guidance on the decision. |
|
|
userProfile |
|
The risk profile applied to the user/transaction. |
|
|
policySetInfo |
|
Metadata describing the set of policies used for evaluation. |
(Object) |
|
policySetName |
|
The name of the policy set executed. |
|
|
versionName |
|
The version identifier for the policy set. |
|
|
versionPublishedBy |
|
The name of the person who published this policy version. |
|
|
versionPublishedTime |
|
The timestamp when this specific policy version was published. |
|
|
segmentExecuted |
|
Details about the specific segment executed. |
(Object) |
|
ID |
|
Unique identifier for the executed segment. |
|
|
name |
|
The name of the executed segment. |
|
This table provides data for exact list matches and the result of the list lookup.
sidebar. Exact List Matches data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
exactListMatches |
|
The container object for results of checking input data against client-managed exact match lists. |
(Object) |
|
listData |
|
The container where any specific matching data points would be returned. |
(Object) |
|
responseCode |
|
The status code indicating the result of the list lookup. |
|
The following table details the results of a machine learning risk scoring model.
sidebar. Inference Engine data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
inferenceEngine |
|
The primary container for machine learning model scoring results and features. |
(Object) |
|
responseCode |
|
Status code for the inference engine service call. |
|
|
omniscoreData |
|
The container for the transaction's calculated Omniscore details. |
(Object) |
|
score |
|
The final risk score assigned to the transaction (scaled 0-100). |
83 |
|
rawScore |
|
The raw, unscaled probability output from the model. |
0.022933267 |
|
mleapFailed |
|
Boolean indicating if the model execution failed. |
|
|
modelId |
|
The unique identifier for the specific machine learning model version used for scoring. |
|
|
transformVersion |
|
The version of the data transformation logic applied to the input features. |
|
|
useCase |
|
The specific business use case this model was trained for. |
|
|
imputedFeatures |
|
An array listing the features that were calculated or inferred during the process, often due to missing inputs. |
(Array) |
|
[Item] |
|
A string indicating a specific imputed feature. |
|
|
mungedFeatures |
|
A map of all engineered and transformed features that were fed into the final machine learning model for scoring. |
(Object) |
|
boost:bin_risk |
|
A sample engineered risk feature (risk rate associated with the card's BIN). |
0.067122936 |
|
cart:usd_cents_amount |
|
A sample engineered feature detailing the total amount in US cents. |
2735 |
|
distance:bill_address_to_ship_address |
|
The calculated distance between billing and shipping addresses. |
0 |
|
email_insights:days_since_first_seen |
|
A sample email insight feature (age of the email record in days). |
914 |
|
pinned:bin_country_code_risk |
|
A sample "pinned" feature representing the risk of the country code associated with the BIN. |
0.01902245851952251 |
This table contains two sections: Persona Data and Rule Metadata. Persona data provides clustered counts of distinct values and Rule Metadata lists all the rule parameters and velocity checks required in Policy Management.
sidebar. Persona data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
persona |
|
The container for Persona and aggregated velocity/distinct count data. |
(Object) |
|
responseCode |
|
The status code for the Persona data retrieval. |
|
|
personaData |
|
The container holding the distinct data cluster counts and associated records. |
(Object) |
|
clusterCount |
|
The total number of unique orders/records contributing to this Persona cluster. |
|
|
orderNumbers |
|
An array of order IDs belonging to this Persona cluster. |
|
|
billing |
|
Aggregated counts for billing-related fields within the Persona cluster. |
(Object) |
|
address |
|
Map of distinct billing addresses and their occurrence count (for example, |
(Object) |
|
emailAddress |
|
Map of distinct billing email addresses and their count. |
|
|
namePostal |
|
Map of combined name and postal code records and their count. |
|
|
device |
|
Aggregated counts for device-related fields within the persona cluster. |
(Object) |
|
ipad |
|
Map of distinct IP addresses (ipad) and their occurrence count. |
|
|
payment |
|
Aggregated counts for payment-related fields. |
(Object) |
|
brand |
|
Map of distinct payment brands and their count. |
|
|
total |
|
The sum of all transaction totals for this persona cluster. |
|
|
velocities |
|
Container for various velocity scores and buckets (for example, all orders, authorized only). |
(Object) |
|
authA |
|
A map where keys are time buckets and values are velocity counts for authorized transactions. |
|
|
--- |
--- |
--- |
--- |
|
ruleMetadata |
|
The container for information about the rules and data requirements used for the transaction. |
(Object) |
|
responseCode |
|
Status code for the rule metadata retrieval. |
|
|
RequiredConditionalSubTypes |
|
Array of required conditional subtypes for processing. |
|
|
clientManagedLists |
|
Container for the lists managed by the client that are needed for rules. |
(Object) |
|
exactMatchLists |
|
Array of lists where exact matches are checked. |
(Array) |
|
listType |
|
The type of data in the managed list. |
|
|
requiredVelocities |
|
Array of velocity metrics the rule engine needs to calculate for the request. |
(Array) |
|
field |
|
The data field for which velocity is required. |
|
|
timeBucketMinutes |
|
Array of time intervals for the required velocity. |
|
This table provides data for verification checks on shipping addresses.
sidebar. Ship Data Quality data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
shipDataQuality |
|
Container for quality and verification checks performed on shipping contact and address data. |
(Object) |
|
responseCode |
|
The status code for the data quality check. |
|
|
melissaData |
|
The container for validation results provided by the Melissa Data service. |
(Object) |
|
lookupAddress |
|
Results from the address validation service. |
(Object) |
|
address1 |
|
The verified or looked-up address line 1. |
|
|
city |
|
The verified or looked-up city. |
|
|
countryCode |
|
The two-letter ISO country code. |
|
|
latitude |
|
The geographical latitude of the address. |
−33.7696 |
|
longitude |
|
The geographical longitude of the address. |
151.0025 |
|
postalCode |
|
The verified postal or ZIP code. |
|
|
state |
|
The verified state or province. |
|
|
lookupName |
|
Results from the name validation service. |
(Object) |
|
fullName |
|
The verified full name. |
|
|
gender |
|
The predicted gender ( |
|
|
lookupPhone |
|
Results from the phone validation service. |
(Object) |
|
phone |
|
The validated phone number. |
|
|
isValidated |
|
A boolean indicating if the phone number validation was successful. |
|
|
shipEmailData |
|
Historical email insight metrics for the shipping email address. |
(Object) |
|
responseCode |
|
Status code for the shipping email insight service. |
|
|
shippingEmailInsightV2 |
|
Status of the V2 shipping email insight service request. |
(Object) |
|
responseCode |
|
Status code for the V2 shipping email insight service. |
|
The following table provides identity verification and risk assessment metrics pulled from the Ekata service for the initial evaluation.
sidebar. Ekata Data for initial evaluation table
|
Data Point |
PATH |
Definition |
Sample Data |
|
ekataData |
|
The top-level container for identity and verification data provided by Ekata. |
(Object) |
|
timestamp |
|
The timestamp of when the Ekata data lookup was performed. |
|
|
identityCheckScore |
|
A proprietary score indicating the confidence level of the verified identity. |
|
|
identityNetworkScore |
|
A score based on the network risk associated with the identity data points. |
0.934 |
|
ipAddressCheck |
|
Verification and geolocation data for the user's IP address. |
(Object) |
|
cityName |
|
The city associated with the geolocated IP address. |
|
|
countryCode |
|
The two-letter country code of the geolocated IP. |
|
|
postalCode |
|
The postal code associated with the geolocated IP address. |
|
|
proxyRisk |
|
Boolean indicating if the IP address is identified as a proxy or VPN. |
|
|
primaryAddressCheck |
|
Verification results for the primary address provided in the request (e.g., billing address). |
true |
|
inputCompleteness |
|
Status of the completeness of the address input data. |
|
|
isValid |
|
Boolean indicating if the address was successfully verified as valid. |
|
|
secondaryEmailCheck |
|
Verification results for the secondary email address provided. |
false |
|
emailFirstSeenDays |
|
Age of the email record in days. |
|
|
isDisposable |
|
Boolean indicating if the email domain is disposable. |
|
|
matchToName |
|
Status of matching the email address to a person's name. |
|
|
registeredOwnerName |
|
The registered owner's name associated with the email/identity record. |
|
|
primaryPhoneCheck |
|
Verification result for the primary phone number. |
false |
|
secondaryPhoneCheck |
|
Verification result for the secondary phone number. |
false |
The following table shows the statuses (Pass, Neutral, or Warning) for Ekata data provided during the initial evaluation.
sidebar. Ekata Status for initial evaluation table
|
Data Point |
PATH |
Definition |
Sample Data |
|
ekataStatus |
|
The top-level container for categorical risk status codes from the Ekata service. |
(Object) |
|
identityCheckScore |
|
Status of the overall identity check score. |
|
|
identityNetworkScore |
|
Status of the calculated score based on identity network data. |
|
|
distancePrimaryToSecondaryAddress |
|
Status of the geographic distance check between the two provided addresses. |
|
|
primaryAddressStatus |
|
Verification status of the primary address (e.g., billing address). |
(Object) |
|
inputCompleteness |
|
Status of whether the required address fields were complete. |
|
|
isValid |
|
Status of the address validity check. |
|
|
primaryPhoneStatus |
|
Verification status of the primary phone number. |
(Object) |
|
isPrepaid |
|
Status indicating if the phone number is a pre-paid mobile (a potential risk factor). |
|
|
isValid |
|
Status of the phone number validity check. |
|
|
ipAddressStatus |
|
Verification status of the IP address and its geographical location. |
(Object) |
|
proxyRisk |
|
Status of the IP address being flagged as a proxy/VPN. |
|
|
isValid |
|
Status of the IP address verification. |
|
|
distanceFromPrimaryAddress |
|
Status of the IP address's geographic distance from the primary address. |
|
|
secondaryEmailStatus |
|
Verification status of the secondary email address. |
(Object) |
|
isDisposable |
|
Status indicating if the secondary email domain is a disposable service. |
|
|
matchToName |
|
Status of matching the email to a registered name. |
|
|
secondaryAddressStatus |
|
Verification status of the secondary address. |
(Object) |
|
secondaryPhoneStatus |
|
Verification status of the secondary phone number. |
(Object) |
The following table provides Ekata Data for when an order is updated in the user interface (UI).
sidebar. Ekata Data for UI update table
|
Data Point |
PATH |
Definition |
Sample Data |
|
ekataData |
|
The top-level container for identity and verification data provided by the Ekata service. |
(Object) |
|
timestamp |
|
The timestamp of when the Ekata data lookup was performed. |
|
|
identityCheckScore |
|
A proprietary score quantifying the confidence level of the verified identity. |
452 |
|
identityNetworkScore |
|
A score based on the network risk associated with the identity data points. |
0.971 |
|
ipAddressCheck |
|
Verification and geolocation data for the user's IP address. |
(Object) |
|
cityName |
|
The city associated with the geolocated IP address. |
|
|
countryCode |
|
The two-letter country code of the geolocated IP. |
|
|
distanceFromSecondaryAddress |
|
The geographic distance (in miles or kilometers) from the IP location to the secondary address. |
321 |
|
isValid |
|
Boolean indicating if the IP address geolocation was successfully determined. |
|
|
proxyRisk |
|
Boolean indicating if the IP address is flagged as a proxy or VPN. |
|
|
primaryAddressCheck |
|
Verification results for the primary address (e.g., billing address). |
(Object) |
|
inputCompleteness |
|
Numerical representation of the completeness of the address input data. |
4 |
|
isValid |
|
Boolean indicating if the primary address was successfully verified as valid. |
|
|
secondaryAddressCheck |
|
Verification results for the secondary address (e.g., shipping address). |
(Object) |
|
isValid |
|
Boolean indicating if the secondary address was successfully verified as valid. |
|
|
primaryEmailCheck |
|
Verification results for the primary email address. |
(Object) |
|
primaryPhoneCheck |
|
Verification results for the primary phone number. |
(Object) |
|
secondaryEmailCheck |
|
Verification results for the secondary email address. |
(Object) |
|
secondaryPhoneCheck |
|
Verification results for the secondary phone number. |
(Object) |
The following table provides the Ekata Status data for user interface (UI) updates. The available status options are numerical:
-
0 = "STATUS_UNSPECIFIED"
-
1 = "PASS"
-
2 = "WARNING"
-
3 = "NEUTRAL"
sidebar. Ekata Status for UI update table
|
Data Point |
PATH |
Definition |
Sample Data |
|
ekataStatus |
|
The top-level container for categorical risk status codes from the Ekata service. |
(Object) |
|
identityCheckScore |
|
Status of the overall identity check score. |
2 |
|
identityNetworkScore |
|
Status of the calculated score based on identity network data. |
2 |
|
distancePrimaryToSecondaryAddress |
|
Status of the geographic distance check between the two provided addresses. |
3 |
|
ipAddressStatus |
|
Verification status of the IP address and its geographical location. |
(Object) |
|
isValid |
|
Status of the IP address validity check. |
1 |
|
proxyRisk |
|
Status of the IP address being flagged as a proxy/VPN. |
1 |
|
distanceFromSecondaryAddress |
|
Status of the IP's geographic distance from the secondary address. |
2 |
|
primaryAddressStatus |
|
Verification status of the primary address (for example, billing address). |
(Object) |
|
inputCompleteness |
|
Status of whether the required address fields were complete. |
1 |
|
isValid |
|
Status of the primary address validity check. |
1 |
|
primaryEmailStatus |
|
Verification status of the primary email address. |
(Object) |
|
emailDomainCreationDays |
|
Status related to the domain's age. |
2 |
|
isValid |
|
Status of the email validity check. |
2 |
|
primaryPhoneStatus |
|
Verification status of the primary phone number. |
(Object) |
|
isPrepaid |
|
Status indicating if the phone number is a pre-paid mobile. |
3 |
|
isValid |
|
Status of the phone number validity check. |
1 |
|
secondaryAddressStatus |
|
Verification status of the secondary address (for example, shipping address). |
(Object) |
|
isValid |
|
Status of the secondary address validity check. |
2 |
|
secondaryEmailStatus |
|
Verification status of the secondary email address. |
(Object) |
|
secondaryPhoneStatus |
|
Verification status of the secondary phone number. |
(Object) |
The following table provides data for when the Create Tag action is performed.
sidebar. Create Tag action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
request |
|
Data fields provided in the initial request to perform the action. |
(Object) |
|
name |
|
The requested name for the new tag. |
|
|
details |
|
Container for detailed parameters of the tag being created. |
(Object) |
|
Tag |
|
Nested container for tag object definition. |
(Object) |
|
tag |
|
The tag definition object. |
(Object) |
|
name |
|
The name of the tag being defined. |
|
|
description |
|
The description associated with the new tag. |
|
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
|
response |
|
The data returned by the system after successfully executing the action. |
(Object) |
|
tagId |
|
The unique identifier assigned to the newly created tag. |
|
The following table provides data for the Delete Draft action.
sidebar. Delete Draft action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
request |
|
Data fields provided in the initial request to perform the deletion. |
(Object) |
|
versionID |
|
The unique identifier of the draft version being deleted. |
|
|
response |
|
The data returned by the system after successfully executing the action. |
(Object) |
|
newDraftID |
|
The unique identifier of the resulting new draft that replaces the deleted one. |
|
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
|
listName |
|
Placeholder for the name of a managed list. |
|
|
listType |
|
Placeholder for the type of a managed list. |
|
The following table provides data for the List Custom Defined Fields (CDFs) action.
sidebar. List CDFs action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
request |
|
The parameters provided for the request (empty in this case). |
(Object) |
|
response |
|
The data returned by the system containing the list of CDFs. |
(Object) |
|
cdfs |
|
An array containing details for each Custom Defined Field (CDF). |
(Array) |
|
cdfId |
|
The unique identifier (GUID) for the specific CDF. |
|
|
cdfKey |
|
The key name for the CDF. |
|
|
cdfValueType |
|
An integer code representing the data type of the CDF's value. CDF value types:
|
1 |
|
lastSeen |
|
The timestamp of the last time this CDF was seen/used in an order. |
1757993786 |
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
The following table provides data for the Delete Policy action.
sidebar. Delete Policy action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed: deleting a risk policy. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
request |
|
The parameters identifying the policy to be deleted and the user. |
(Object) |
|
author |
|
The name of the user requesting the deletion. |
|
|
eventType |
|
The numerical identifier for the type of event this policy applied to. |
1 |
|
policyId |
|
The unique ID of the policy being deleted. |
|
|
response |
|
The data returned by the system after executing the action (empty upon successful deletion). |
(Object) |
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
The following table provides data for the Save Segment action.
sidebar. Save Segment action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
response |
|
The data returned by the system upon successfully saving the segment. |
(Object) |
|
ID |
|
The unique identifier assigned to the newly saved segment. |
|
|
request |
|
The configuration object defining the new segment. |
(Object) |
|
active |
|
Boolean indicating if the segment should be active immediately upon saving. |
|
|
name |
|
The name of the segment being saved. |
|
|
lastModifiedBy |
|
The name of the user who last modified the segment. |
|
|
versionID |
|
The ID of the current version being saved. |
|
|
mfaEnabled |
|
Boolean flag indicating if Multi-Factor Authentication is enabled for the segment. |
|
|
baseExpression |
|
The root container for the segment's logical condition structure. |
(Object) |
|
operator |
|
The primary logical operator ( |
1 |
|
groupExpressions |
|
An array of groups, each containing one or more conditions. |
(Array) |
|
englishTransFactName |
|
The title of the condition. |
|
|
fieldName |
|
The type of comparison being performed. |
|
|
rawValue |
|
The selected comparison type. |
|
|
fieldName |
|
The field name for the value being checked. |
|
|
rawValue |
|
The literal value required by the condition. |
|
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
The following table provides data for the Publish Version action.
sidebar. Publish Version action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
request |
|
The parameters identifying the version to be published and the author. |
(Object) |
|
author |
|
The name of the user publishing the version. |
|
|
policySetID |
|
The unique ID of the policy set to which the version belongs. |
|
|
versionID |
|
The ID of the specific draft version being promoted to production. |
|
|
response |
|
The data returned by the system after successfully executing the action. |
(Object) |
|
newDraftVersionID |
|
The unique ID of the resulting new draft version created automatically after publication. |
|
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
The following table provides data for the Set Running Policy Set action.
sidebar. Set Running Policy Set action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed: setting a policy version as active/running. |
|
|
userId |
|
The generic internal unique identifier for the user who initiated the request. |
|
|
username |
|
The generic username or email of the user who initiated the request. |
|
|
request |
|
The parameters identifying the policy set and user performing the action. |
(Object) |
|
author |
|
The name of the user setting the policy. |
|
|
eventType |
|
The numerical identifier for the type of event this policy set applies to (e.g., |
1 |
|
policySetID |
|
The unique ID of the specific policy set being activated. |
|
|
response |
|
The data returned by the system after executing the action (empty in this case). |
(Object) |
|
metadata |
|
Placeholder or generic metadata associated with the action. |
(Object) |
The following table provides data for the Save Policy v2 action.
sidebar. Save Policy v2 action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The internal unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
response |
|
The data returned by the system upon successfully saving the policy. |
(Object) |
|
ID |
|
The unique identifier assigned to the saved policy draft. |
|
|
request |
|
The configuration object defining the new policy. |
(Object) |
|
name |
|
The name of the policy being saved. |
|
|
outcome |
|
The default action to be taken if the rule conditions are met. |
|
|
lastModifiedBy |
|
The name of the user who last modified the policy. |
|
|
versionID |
|
The unique ID of the version being saved. |
|
|
baseExpression |
|
The root container for the policy's logical condition structure. |
(Object) |
|
operator |
|
The logical operator ( |
1 |
|
groupExpressions |
|
An array of groups, each containing one or more conditions. |
(Array) |
|
name |
|
The internal technical name of the condition/fact being checked. |
|
|
englishTransFactName |
|
The title of the condition. |
|
|
rawValue |
|
The configured value for a condition parameter (e.g., the threshold count). |
|
|
fieldName |
|
The specific parameter name (e.g., threshold count or time bucket). |
|
|
rawValue |
|
The configured time window for the velocity check (in minutes). |
|
|
selectedTags |
|
The name of a pre-existing tag associated with the policy. |
|
|
tags |
|
An array of tag IDs associated with the policy. |
|
The following table provides data for the Update Policy v2 action.
sidebar. Update Policy v2 action data table
|
Data Point |
PATH |
Definition |
Sample Data |
|
action |
|
The operation being performed by the user or system. |
|
|
userId |
|
The unique identifier for the user who initiated the request. |
|
|
username |
|
The username or email of the user who initiated the request. |
|
|
response |
|
The data returned by the system upon successfully updating the policy. |
(Object) |
|
ID |
|
The unique identifier of the updated policy record. |
|
|
request |
|
The configuration object defining the policy update. |
(Object) |
|
ID |
|
The ID of the policy being updated. |
|
|
name |
|
The updated name of the policy. |
|
|
outcome |
|
The outcome action to be taken if the rule conditions are met. |
|
|
lastModifiedBy |
|
The name of the user who last modified the policy. |
|
|
baseExpression |
|
The root container for the policy's logical condition structure. |
(Object) |
|
operator |
|
The primary logical operator ( |
1 |
|
groupExpressions |
|
An array of condition groups. |
(Array) |
|
operator |
|
The logical operator linking conditions within the group. |
1 |
|
name |
|
The internal name of the condition being checked. |
|
|
englishTransFactName |
|
The title of the condition. |
|
|
rawValue |
|
The configured threshold value (for example, the count of failed attempts). |
|
|
rawValue |
|
The configured time window for the velocity check (in minutes). |
|
|
selectedTags |
|
The name of a pre-existing tag associated with the policy. |
|
|
tags |
|
An array of tag IDs associated with the policy. |
|