After you registered devices for Strong Customer Authentication (SCA), you can use our API to:
Requirements
Ensure that your API credential has the following role:
- Bank SCA Webservice Role
Get the device registered for a card
You can get the information about the SCA device registered for a specific card. You can do this to, for example, show this information to your user.
To get the SCA device registered for a specific card:
-
Make a GET /registeredDevices request. Include the following query parameter:
Query parameter Required Description paymentInstrumentId Limits the returned list to SCA devices registered for this card. The following example shows a GET /registeredDevices request for the
paymentInstrumentId
PI00000000000000000000001. -
In the response, note the following parameters:
Response parameter Description data Contains data about the device registered for SCA. data.id The unique identifier of the registered SCA device. data.name The name of the SCA device. You can show this name to your user to help them identify the device. data.paymentInstrumentId The unique identifier of the card for which the SCA device is registered. data.type ios or android
Deregister a device from a card
You can deregister an SCA device from a card by making a DELETE /registeredDevices/{id} request. You can do this when, for example:
- Your user will no longer use a registered device.
- A registered device has been compromised.
If the SCA device is registered for multiple cards, you must make a request for each card.
To deregister an SCA device from a card:
-
Get the ID of the device that you want to deregister.
-
Make a DELETE /registeredDevices/{id} request and include the following parameters:
Parameter Type Required Description id Path The unique identifier of the SCA device that you want to deregister. paymentInstrumentId Query The unique identifier of the card from which you want to deregister the device. The following example shows a request to deregister an SCA device with
id
BSDR00000000000000000000000001 from thepaymentInstrumentId
PI00000000000000000000001. -
Verify that you receive a 204 HTTP response with no content. This indicates that the request succeeded.