To enable out-of-band (OOB) authentication for your users, you must register their device as an SCA device. The registration associates your user's device with their card.
You can register devices for SCA using Adyen's Authentication SDK. To do so:
- Check SCA eligibility.
- Initiate the device registration from your server.
- Register the device.
- Finalize the registration from your server.
The following sections explain how to perform all the steps to register a user's device for SCA.
Requirements
- Make sure that the operating system on your user's device supports SCA.
- Make sure that you have installed the Authentication SDK.
- Make sure that your API credential has the following role:
- Bank SCA Webservice Role
Check SCA eligibility
This functionality requires additional configuration from Adyen. To enable it, contact our Support Team.
You will use the sdkOutput when initiating the registration.
Initiate device registration
Registering the device is a one-off procedure. You can only register one device per payment instrument. If you register a new device for a card that already has a registered device, the previous device will be deregistered.
After a device is registered, you can associate multiple payment instruments to the registered device. To learn how to associate multiple payment instruments to a registered device, go to Manage registered devices.
To start the device registration, make a POST /registeredDevices request from your server.
In the request, specify the following:
| Request parameter | Required | Description |
|---|---|---|
| paymentInstrumentId | yes | The unique identifier of the card you want to register the device for. |
| name | no | The name of the SCA device that you are registering. You can use it to help your users identify the device. If you do not specify a name, Adyen automatically generates one. |
| strongCustomerAuthentication.sdkOutput | yes | Base64-encoded blob of data created in the previous step. |
The response returns:
- sdkInput: pass the value to the SDK when registering the device.
- id: the device ID needed when finalizing the registration. This ID begins either with
BSDRorRD.
We suggest that you create and store a mapping between the registered device id and the human-readable account holder name. For example, BSDR00000000000000000000001 is "Cardholder's iPhone". You can use this pair later to show the details, for example, when deregistering the device if the user doesn't specify a device name during registration.
Authenticate cardholder
In your client app, perform authentication. PSD2 requires you to perform two-factor authentication (2FA) as an extra security step during the login process.
Register the device
To register the device with the Authentication SDK:
-
Authenticate the user by performing two-factor authentication (2FA).
-
Trigger the SDK to start the device registration and pass
sdkInputfrom step 2. -
Pass
sdkOutputto your server.
Finalize registration
To finalize the device registration:
-
Make a PATCH /registeredDevices/{id} request from your server. Specify the following parameters:
Parameter Parameter type Description id Path The unique identifier of the SCA device. You obtain this idafter you initiate the device registration.paymentInstrumentId Body The unique identifier of the card you want to register the device for. strongCustomerAuthentication.sdkOutput Body Base64-encoded blob of data created in the previous step. -
Verify that the response contains
successtrue.
The registration is now complete and the device ID is connected to the payment instrument. An element for the device ID is added to the data array of GET /registeredDevices. The user can start authenticating themselves for future operations related to the payment instrument ID used during registration.
You cannot register a device more than once. However, now that the device is registered, you can connect more payment instruments to the device using the device association API.