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-Typestring

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

Acceptstring

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

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

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

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

merchantobjectrequired

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

paymentInstrumentany

{
  "transactionReference": "uniqueId",
  "merchant": {
    "entity": "default"
  },
  "paymentInstrument": {
    "type": "card/tokenized",
    "href": "https://tokens/tokens/MTIzNDU2Nzg5MDEyMzQ1Ng"
  }
}

Responses

The data for the device data collection has been generated

Bodyapplication/vnd.worldpay.verifications.customers-v1.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

Response

Initialize the device data collection for a token payment instrument

{
  "outcome": "initialized",
  "transactionReference": "uniqueId",
  "deviceDataCollection": {
    "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJvcmcgdW5pdCBpZCIsImlzcyI6ImFwaSBpZCIsImV4cCI6MTI5NDUsImlhdCI6MTIzNDUsImp0aSI6ImU1ODY2MDYzLWVmYmMtNGY5My1iYmI3LTg1MDkzZjAxZGZjZCJ9.SUafrXef_d3915NeHygKGP5LmnQXz2Jdxjhtj5OJRsw",
    "url": "https://secure.worldpay-bsh.securedataplatform.co.uk/url/to/ddc.html",
    "bin": "444433"
  },
  "_links": {
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/verifications/customers/3ds/{rel}",
        "templated": true,
        "name": "3ds"
      }
    ],
    "3ds:authenticate": {
      "href": "authenticate"
    }
  }
}