touchId

Simulate a Touch ID or Face ID biometric match event on iOS Simulator.

note

This command requires the allowTouchIdEnroll capability to be set to true in the session. It is only supported on iOS Simulator.

Usage

await browser.touchId(match, type)

Parameters

Name	Type	Details
match	boolean	Whether the biometric match should succeed (true) or fail (false)
type optional	string	The biometric type to simulate. Use 'touchId' for Touch ID (default) or 'faceId' for Face ID. iOS-ONLY

Example

touchId.js

it('should simulate a Touch ID fingerprint match', async () => {
    // Simulate a successful Touch ID match
    await browser.touchId(true)
    // Simulate a failed Touch ID match
    await browser.touchId(false)
})
it('should simulate a Face ID match', async () => {
    // Simulate a successful Face ID match
    await browser.touchId(true, 'faceId')
    // Simulate a failed Face ID match
    await browser.touchId(false, 'faceId')
})

Support

Supported platforms: iOS

note

Refer to the official Appium driver documentation to see which driver versions support this command.