Rebilly API Docs

Retrieve risk score rules

Retrieves risk score rules.

SecuritySecretApiKey or JWT

Responses

200

Risk score rules retrieved.

Response Schema: application/json

required

object or null

Specifies whether the customer's IP address is related to a proxy.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's IP address is related to a VPN.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's IP address is related to TOR.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's IP address is related to hosting.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's billing address country and geo-IP address are not the same.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's bank country and geo-IP address are not the same.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's browser time zone and the IP address associated time zone are not the same.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the customer's billing address name and primary address name are not the same.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the holder name seems fake.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Specifies whether the geo-IP country, or the customer's billing country, is considered a high risk country.

value

required

integer

Value added to the risk score of the transaction.

required

object or null

Number of transactions for this payment instrument, based on fingerprint, in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

required

object or null

Number of declined transactions for this payment instrument fingerprint in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

required

object or null

Number of transactions for this device, based on fingerprint, in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

required

object or null

Number of transactions for this IP address in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

required

object or null

Number of transactions for this email address in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

required

object or null

Number of transactions for this billing address in the last 24 hours.

required

Array of objects non-empty

Risk factor values range with corresponding risk score increment value. First matched bracket is applied.

Array (non-empty)

start required	integer >= 0 Minimal risk factor value when condition is applied.
end required	integer >= 1 Maximal risk factor value when condition is applied.
value required	integer >= 1 Value added to the risk score of the transaction.

401

Unauthorized access. Invalid credentials used.

403

Access forbidden.

get/risk-score-rules

Request samples

Response samples

application/json

{"isProxy": {"value": 0
},
"isVpn": {"value": 0
},
"isTor": {"value": 0
},
"isHosting": {"value": 0
},
"hasMismatchedBillingAddressCountry": {"value": 0
},
"hasMismatchedBankCountry": {"value": 0
},
"hasMismatchedTimeZone": {"value": 0
},
"hasMismatchedHolderName": {"value": 0
},
"hasFakeName": {"value": 0
},
"isHighRiskCountry": {"value": 0
},
"paymentInstrumentVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
},
"declinedPaymentInstrumentVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
},
"deviceVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
},
"ipVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
},
"emailVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
},
"billingAddressVelocity": {"brackets": [{"start": 0,
"end": 1,
"value": 1
}
]
}
}

➔ Next to Modify risk score rules