Retrieve Exchange

Retrieve data for a single exchange with a GET request to the endpoint with an ID.

🚧

Exchange API Deprecation Notice

The Exchange API is a realtime authentication method that requires the cloud and connectivity to be fully intact during the key exchange. This module predates and by its nature cannot support our offline key exchange capability. With Offline Mode, the MS5 and MS4 SmartBoxes can continue operating even when connectivity is lost or the cloud is disrupted by reverting to their last synced state, enhancing reliability and ensuring a seamless key exchange experience. Thus, we strongly encourage using Accesses and Permissions for development which sync with the SmartBox in advance of the key exchange. A seamless user experience can be implemented by presenting a QR code for the user to present at the SmartBox.

For more details on Offline Mode, visit our help center.

Returns an exchange object if a valid identifier was provided.

Language
Credentials
Basic
base64
: