Input schema (JSON)
{
"type": "object",
"$schema": "https://json-schema.org/draft/2020-12/schema",
"properties": {
"email": {
"type": "object",
"properties": {
"domain": {
"type": "string"
},
"address": {
"type": "string",
"description": "Plaintext email OR its MD5 hash."
}
}
},
"event": {
"type": "object",
"properties": {
"time": {
"type": "string",
"description": "ISO 8601 timestamp of the event."
},
"type": {
"enum": [
"account_creation",
"account_login",
"email_change",
"password_reset",
"payout_change",
"purchase",
"recurring_purchase",
"referral",
"survey"
],
"type": "string"
},
"shop_id": {
"type": "string"
},
"transaction_id": {
"type": "string"
}
}
},
"order": {
"type": "object",
"properties": {
"amount": {
"type": "number"
},
"is_gift": {
"type": "boolean"
},
"currency": {
"type": "string",
"description": "3-letter ISO 4217 currency code."
},
"affiliate_id": {
"type": "string"
},
"referrer_uri": {
"type": "string"
},
"discount_code": {
"type": "string"
},
"subaffiliate_id": {
"type": "string"
},
"has_gift_message": {
"type": "boolean"
}
}
},
"device": {
"type": "object",
"properties": {
"ip_address": {
"type": "string",
"description": "IPv4 or IPv6 address — the single most important field for scoring."
},
"session_id": {
"type": "string"
},
"user_agent": {
"type": "string"
},
"session_age": {
"type": "number",
"description": "Seconds since the visitor's session started."
},
"accept_language": {
"type": "string"
}
},
"description": "Info about the device/connection. device.ip_address is the most important input."
},
"account": {
"type": "object",
"properties": {
"user_id": {
"type": "string"
},
"username_md5": {
"type": "string"
}
}
},
"billing": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"postal": {
"type": "string"
},
"region": {
"type": "string"
},
"address": {
"type": "string"
},
"company": {
"type": "string"
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code."
},
"address_2": {
"type": "string"
},
"last_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"phone_country_code": {
"type": "string"
}
}
},
"payment": {
"type": "object",
"properties": {
"processor": {
"type": "string"
},
"decline_code": {
"type": "string"
},
"was_authorized": {
"type": "boolean"
}
}
},
"shipping": {
"type": "object",
"properties": {
"city": {
"type": "string"
},
"postal": {
"type": "string"
},
"region": {
"type": "string"
},
"address": {
"type": "string"
},
"company": {
"type": "string"
},
"country": {
"type": "string",
"description": "ISO 3166-1 alpha-2 country code."
},
"address_2": {
"type": "string"
},
"last_name": {
"type": "string"
},
"first_name": {
"type": "string"
},
"phone_number": {
"type": "string"
},
"delivery_speed": {
"enum": [
"same_day",
"overnight",
"expedited",
"standard"
],
"type": "string"
},
"phone_country_code": {
"type": "string"
}
}
},
"credit_card": {
"type": "object",
"properties": {
"token": {
"type": "string"
},
"bank_name": {
"type": "string"
},
"last_digits": {
"type": "string",
"description": "Last 2 or 4 digits."
},
"issuer_id_number": {
"type": "string",
"description": "6- or 8-digit IIN."
},
"bank_phone_number": {
"type": "string"
},
"bank_phone_country_code": {
"type": "string"
},
"was_3d_secure_successful": {
"type": "boolean"
}
}
},
"custom_inputs": {
"type": "object",
"description": "Custom inputs configured in your minFraud account.",
"propertyNames": {
"type": "string"
},
"additionalProperties": {
"type": [
"string",
"number",
"boolean"
]
}
},
"shopping_cart": {
"type": "array",
"items": {
"type": "object",
"properties": {
"price": {
"type": "number"
},
"item_id": {
"type": "string"
},
"category": {
"type": "string"
},
"quantity": {
"type": "integer",
"maximum": 9007199254740991,
"minimum": -9007199254740991
}
}
}
}
}
}