Generate required data for 3DS Device Data Collection

Request

Allow card issuers to perform Device Data Collection to fingerprint your customer's device.

Security

BasicAuth

Content-Typestringrequired

Example:application/vnd.worldpay.verifications.customers-v3.hal+json

Acceptstringrequired

Example:application/vnd.worldpay.verifications.customers-v3.hal+json

Bodyapplication/vnd.worldpay.verifications.customers-v3.hal+json

transactionReferencestring, [ 1 .. 64 ] characters^[-A-Za-z0-9_!@#$%()*=.:;?\[\]{}~`/+]*$required

A unique reference for authentication. For example, e-commerce order code. Use the same transactionReference across all 3 potential request types (deviceDataInitialization, authentication, verification).

merchantobjectrequired

An object that contains information about the merchant and API level configuration.

paymentInstrumentany

Initialize the device data collection using the card number

{
  "transactionReference": "Memory265-13/08/1876",
  "merchant": {
    "entity": "default"
  },
  "paymentInstrument": {
    "type": "card/front",
    "cardHolderName": "Sherlock Holmes",
    "cardNumber": "4444333322221111",
    "cardExpiryDate": {
      "month": 5,
      "year": 2035
    }
  }
}

Responses

The data for the device data collection has been generated

Bodyapplication/vnd.worldpay.verifications.customers-v3.hal+json

outcomestringrequired

Outcome of the device data initialization request

Enum:"initialized""alreadyAuthenticated"

transactionReferencestring, [ 1 .. 64 ] charactersrequired

A unique reference for authentication. For example, e-commerce order code.

deviceDataCollectionobject

Object containing device data collection related information

_linksobject

Response

Initialize the device data collection using the card number, worldpay token or network token

{
  "outcome": "initialized",
  "transactionReference": "Memory265-13/08/1876",
  "deviceDataCollection": {
    "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJPcmdVbml0IiwiaXNzIjoiYXBpSWQiLCJleHAiOjE1NjI5MjMzNDYsImlhdCI6MTU2MjkyMzQwNiwianRpIjoiYTAzMWVhOGEtN2E0Zi00YTQwLWI1NjMtOTUzMzYzMzVhZGNmIn0.0IK74OIXBxFsxqeOURJz1TFnz14ZTbFJTdTWo9cHUJQ",
    "url": "https://ddcUrl.example.com",
    "bin": "555555"
  },
  "_links": {
    "3ds:authenticate": {
      "href": "https://try.access.worldpay.com/verifications/customers/3ds/authentication"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}",
        "templated": true,
        "name": "3ds"
      }
    ]
  }
}