Verify the 3DS challenge response

Request

Verify the results of a challenged authentication.

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.

challengeobjectrequired

Object containing challenge related information in case of a "challenged" flow

An example of a 3DS Verification request

{
  "transactionReference": "sRMPWCQoQrEiVxehTnu0",
  "merchant": {
    "entity": "default"
  },
  "challenge": {
    "reference": "uniqueChallengeRef12"
  }
}

Responses

The challenge was successful - obtain the authentication data for onward use

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

outcomestring

Outcome of the previously posted authentication request.

Enum:"authenticated""authenticationFailed""unavailable""signatureFailed""bypassed"

authenticationobject

Object that contains authentication related information.

transactionReferencestring, [ 1 .. 64 ] characters

A unique reference for authentication that was passed in the request.

Response

An example of a 3DS Verification request

{
  "outcome": "authenticated",
  "transactionReference": "sRMPWCQoQrEiVxehTnu0",
  "authentication": {
    "version": "1.0.2",
    "authenticationValue": "MAAAAAAAAAAAAAAAAAAAAAAAAAA=",
    "eci": "05",
    "transactionId": "k4Vf36ijnJX54kwHQNqUr8"
  },
  "_links": {
    "curies": [
      {
        "href": "https://try.access.worldpay-bsh.securedataplatform.co.uk/rels/verifications/customers/3ds/{rel}",
        "templated": true,
        "name": "3ds"
      }
    ],
    "3ds:authenticate": {
      "href": "authenticate"
    },
    "3ds:verify": {
      "href": "authenticate/verify"
    }
  }
}