Access Worldpay
/
Android and iOS SDK
/
SDK and Device data initialization
Important

We have released a new version. Documentation for our latest version can be found here.

Last Updated: 08 October 2024 | Change Log

SDK and Device data initialization

Device data collection is used by the card issuer to fingerprint the customer's device. Along with the risk data in the authentication request it's used to decide if a challenge is required or if the authentication can be frictionless (no challenge displayed to your customer). This step is required for the authentication to use 3DS2.

Device data initialization

This request creates a JSON Web Token (JWT) that is used as part of the SDK initialization and device data collection. Whilst the web integration captures browser details the App SDK gathers information about the users mobile device.

POST your device data initialization request to the 3ds:deviceDataInitialize action link.

Note

Unlike the web integration you do not need to request and use the BIN for device data collection purposes. If your integration involves both Web and android/iOS you could use the same Device Data Initialize request as web for simplicity.

Warning

You should only request the device data initialization API from your backend system, not call it directly from the mobile application using the Access credentials.

Device data initialization example request

Note

You must use v2 of the API for the Android/iOS SDK

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

{
    "transactionReference": "unique-transactionReference",
    "merchant": {
        "entity": "default"
    }
}
ParameterMandatoryDescription
transactionReference✅A unique reference for device data JWT request. for example, e-commerce order code.
merchant.entity✅Used to route the request in Access Worldpay, created as part of on-boarding.

Device data initialization response

{
    "outcome": "initialized",
    "transactionReference": "unique-transactionReference",
    "deviceDataCollection": {
        "jwt": "eyJ0eXAiOiJKV1QiLCJhbGciOiJIUzI1NiJ9.eyJPcmdVbml0SWQiOiJPcmdVbml0IiwiaXNzIjoiYXBpSWQiLCJleHAiOjE1NjI5MjMzNDYsImlhdCI6MTU2MjkyMzQwNiwianRpIjoiYTAzMWVhOGEtN2E0Zi00YTQwLWI1NjMtOTUzMzYzMzVhZGNmIn0.0IK74OIXBxFsxqeOURJz1TFnz14ZTbFJTdTWo9cHUJQ",
        "url": "https://ddcUrl.example.com"
    },
    "_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"
        }]
    }
}
ParameterDescription
deviceDataCollection.jwtA digitally signed token that contains additional details required for device data collection. Expires in 10 minutes for both Try and Production.
deviceDataCollection.urlA POST action on the device data collection form. Used to redirect to the issuers device data collection page. Only used for the web integration
Note

In case of an error, you can get further information in our error reference.

SDK initialization

The Access 3DS API will be periodically tested against the latest version of the Cardinal SDK. Current tested Cardinal SDK version: v2.2.5

Setup the Cardinal SDK

Initial call to Cardinal and response

From this you will get returned the consumerSessionId for use in the authentication request

Next steps

Authentication