Pair Mobile Companion Device

Pairs a new physical mobile device running the companion app with a merchant brand profile.
Requires a valid numeric pairing code generated from the brand admin dashboard and a unique hardware device identifier.
On success, returns the encryption key (AES-256 key) used for local message storage, short-lived JWT access token, and long-lived refresh token.

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
string
required

The 6-digit numeric pairing code displayed on the merchant settings dashboard.

string
required

Hardware identifier unique to the companion device.

string
Defaults to Unknown
string
Defaults to 1.0.0
string
enum
Defaults to android
Allowed:
Responses

Language
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json