Skip to main content
POST

Risk Assessment Guide

Evaluate transaction risk before processing payments
Performs a fraud risk assessment on a tokenized card by cross-referencing the billing address, card issuer country, and client IP address. Use this before processing a payment to detect mismatches that may indicate fraudulent activity, such as anonymous proxies or country discrepancies.

Error Responses

Parameter Constraints

  • Only CountryCode is required. It must be a 2-letter ISO country code.
  • clientIPAddress, City and StateProvince feed the RiskLevel and CountryByIP values. Without a real cardholder IP those two values are not meaningful.
  • IssuerCountry, IssuerName, CardBrand, CardType and CardCategory are looked up from the card itself and are returned whatever else you send, so the call can be used as a BIN lookup with CountryCode alone.
  • FirstName and LastName only affect the Description text. They never change RiskLevel.
  • Email, Phone, Address1 and PostCode are accepted but not used in the assessment.

Parameters

Headers

string
required
Your API key prefixed with APIKEY. Example: APIKEY your-api-key. See the Authentication guide.

Path Parameters

string
required
The token ID as returned by one of the tokenization methods.

Payer Information

string
Payer’s first name.
string
Payer’s last name.
string
Payer’s email address.
string
Payer’s phone number.

Billing Address

string
Primary billing address line.
string
Secondary billing address line.
string
Tertiary billing address line.
string
Billing postal/ZIP code.
string
Billing city.
string
Billing state or province.
string
required
2-letter country code.

Client Details

string
Client’s IP address. Both IPv6 and IPv4 formats are supported.

Response