Menu

3DS

API v2

Verify your customer's identity simply and seamlessly to minimize fraud. Use our strong customer authentication to benefit from liability shift.

Note: Make yourself familiar with ourAPI Principlesto ensure a resilient integration.

Set your headers

Setting your headers is an important part of an API request. The headers represent the meta-data associated with your API request.

Please use the latest version: v2

Copied!
Authorization: {your_credentials}
Content-Type: application/vnd.worldpay.verifications.customers-v2.hal+json
Accept: application/vnd.worldpay.verifications.customers-v2.hal+json
HeaderDescription
AuthorizationThe Authorization header is used for authentication and identification of our merchants within Access Worldpay. You must use the Authorization header for any request you send to our 3DS API, unless you are using client certificate authentication over TLS. If you must use this, read our reference guide onAuthenticating with SSL/TLS.
Content-TypeThe Content-Type header is required if the request you're sending includes a request body, and if the HTTP method is a POST or a PUT.
AcceptThe Accept header is used to identify which version of our 3DS API you are using. You must use the Accept header for any request you send to our 3DS API.

If you're using both the Content-Type and Accept headers, they must match.

Note: Replace {your_credentials} with your base64-encoded Basic Auth username and password. To get your Access Worldpay credentials contact your Implementation Manager.

Query the root resource

Our APIs guide you by providing you with links to the next available actions.

To discover and start using our APIs you must first query the root resource. This returns the available resources within Access Worldpay.

Request

GET https://try.access.worldpay.com/

Note: No request body is needed for this request.

Response

You receive all our available API resources in the response.

Copied!
{
  "_links": {
    "payments:authorize": {
      "href": "https://try.access.worldpay.com/payments/authorizations"
    },
    "service:payments": {
      "href": "https://try.access.worldpay.com/payments"
    },
    "service:sessions": {
      "href": "https://try.access.worldpay.com/sessions"
    },
    "service:tokens": {
      "href": "https://try.access.worldpay.com/tokens"
    },
    "service:verifications/accounts": {
      "href": "https://try.access.worldpay.com/verifications/accounts"
    },
    "service:verifications/customers/3ds": {
      "href": "https://try.access.worldpay.com/verifications/customers/3ds"
    },
    "service:verifiedTokens": {
      "href": "https://try.access.worldpay.com/verifiedTokens"
    },
    "service:fraudsight": {
      "href": "https://try.access.worldpay.com/fraudsight"
    },
    "service:exemptions": {
      "href": "https://try.access.worldpay.com/exemptions"
    },
    "service:payouts": {
      "href": "https://try.access.worldpay.com/payouts"
    },
    "service:payments/alternative/direct": {
      "href": "https://try.access.worldpay.com/payments/alternative/direct"
    },
    "service:payments/alternative/action/paypal": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/paypal"
    },
    "service:payments/alternative/action/ideal": {
      "href": "https://try.access.worldpay.com/payments/alternative/action/ideal"
    },
    "service:payouts/accounts": {
      "href": "https://try.access.worldpay.com/payouts/accounts"
    },
    "service:payouts/events": {
      "href": "https://try.access.worldpay.com/payouts/events"
    },
    "service:moneyTransfers": {
      "href": "https://try.access.worldpay.com/moneyTransfers"
    },
    "service:foreignExchange": {
      "href": "https://try.access.worldpay.com/foreignExchange"
    },
    "service:accounts/statements": {
      "href": "https://try.access.worldpay.com/accounts/statements"
    },
    "service:accounts/balance": {
      "href": "https://try.access.worldpay.com/accounts/balance"
    },
    "service:accounts/transfer": {
      "href": "https://try.access.worldpay.com/accounts/transfer"
    },
    "curies": [
      {
        "href": "https://try.access.worldpay.com/rels/payments/{rel}",
        "name": "payments",
        "templated": true
      }
    ]
  }
}

Query the 3DS root resource

Query the service:verifications/customers/3ds action link for the 3DS root resource.

Request

GET https://try.access.worldpay.com/verifications/customers/3ds

Note: No request body is needed for this request.

The response

Copied!
{
    "_links": {
      "resourceTree": {
        "href": "https://try.access.worldpay.com/verifications/customers/3ds/resourceTree"
      },
      "3ds:deviceDataInitialize": {
        "href": "https://try.access.worldpay.com/verifications/customers/3ds/deviceDataInitialization"
      },
      "curies": [
        {
          "href": "https://try.access.worldpay.com/rels/verifications/customers/3ds/{rel}",
          "templated": true,
          "name": "3ds"
        }
      ]
    }
  }

Resources

The response contains a link to initialize the 3DS Device Data Collection (DDC):

Action Link (resources)Description
3ds:deviceDataInitializeDDC is used by the card issuer to fingerprint the device used by the customer when placing the order. Starting link for 3DS2 with a 3DS1 fallback.

Next steps

Device Data