Request a risk assessment
License Worldpay
Request a risk assessment
A unique reference for authentication. For example, e-commerce order code.
An object that contains information about the merchant and API level configuration.
The object that contains all the payment information related to the authentication request.
Request an exemption but don't apply it in the payment. Used for the initial go-live to build up the data model and have more reliable exemption predictions.
An object that holds risk related information that might help in improving the accuracy of fraud assessment.
Object containing device data information.
Use the sessionId specified in the ThreatMetrix Device Data Collection to link this data to the assessment.
Assessment using the card instrument
{ "transactionReference": "Memory265-13/08/1876", "merchant": { "entity": "default" }, "instruction": { "paymentInstrument": { "type": "card/front", "cardHolderName": "Sherlock Holmes", "cardNumber": "4444333322221111", "cardExpiryDate": { "month": 5, "year": 2035 }, "billingAddress": { "address1": "221B Baker Street", "address2": "Marylebone", "address3": "Westminster", "postalCode": "NW1 6XE", "city": "London", "state": "Greater London", "countryCode": "GB" } }, "value": { "currency": "GBP", "amount": 250 } }, "deviceData": { "collectionReference": "0_4XXXXXXX-XXXX-XXXX-XXXX-XXXXXXXXX8G6", "ipAddress": "192.0.0.0" }, "riskData": { "account": { "email": "sherlock.holmes@example.com", "dateOfBirth": "1854-01-06", "shopperId": "id123" }, "transaction": { "firstName": "Sherlock", "lastName": "Holmes", "phoneNumber": "02031234321" }, "shipping": { "firstName": "James", "lastName": "Moriarty", "address": { "address1": "The Palatine Centre", "address2": "Durham University", "address3": "Stockton Road", "postalCode": "DH1 3LE", "city": "Durham", "state": "County Durham", "countryCode": "GB", "phoneNumber": "01911234321" } }, "custom": { "number1": 1, "number2": 2, "number3": 3, "number4": 4, "number5": 5, "number6": 6, "number7": 7, "number8": 8, "number9": 9, "string1": "text1", "string2": "text2", "string3": "text3", "string4": "text4", "string5": "text5", "string6": "text6", "string7": "text7", "string8": "text8", "string9": "text9" } } }
The authentication has been created
The outcome of the fraudsight assessment request. To understand more about the outcomes and how to reproduce them, see FraudSight testing.
A unique reference for assessment that was passed in the request.
An object that holds the risk profile link.
A resource to apply in either a card payment request OR additional fraudsight requests. This represents the outcome of the fraud assessment and exemption. Used to:
Warning: Not providing this will significantly harm the accuracy of future assessments.
Percentage assessment score for the transaction. Higher the value the greater the assessed risk. The outcome value is based on the thresholds configured using this score.
Short description of the reason for the outcome. A reason can be returned for any 'outcome', even lowRisk
An object that holds information about the exemption if it is granted.
Indicates whether the exemption is provided to be placed in a payment authorization request or 3DS authentication request.
Note: Only placement 'authorization' will be configured to be returned for now until Access 3DS supports exemption placement
| Value | Description |
|---|---|
| authorization | Apply the exemption in the payment authorization |
Low risk outcome, proceed with the payment
{ "outcome": "lowRisk", "transactionReference": "123456", "score": 44.2, "riskProfile": { "href": "https://access.worldpay.com/riskprofile/eyJrIjoxLCJkIjoialRBL0FFelBzcnZ" } }