On this page

deviceChangePin

Change device pin

Open the device PIN-change flow after the user requests it. The user completes protected steps on the device. Never collect or log an actual device PIN as a substitute for this flow.


const result = await HardwareSDK.deviceChangePin(connectId, params);

Params

Optional common params

remove - optional boolean. false changes the PIN. true requests PIN removal on supported Protocol V1 devices; Protocol V2 rejects remove: true.

Example


const result = await HardwareSDK.deviceChangePin(connectId, {
    remove: false
});
if (!result.success) throw new Error(result.payload.error);

Result


{
    success: true,
    payload: {
        message: string
    }
}

Error


{
    success: false,
    payload: {
        error: string, // error message
        code?: string | number // error code
    }
}