@capgo/capacitor-app-attest

Device attestation with Apple App Attest, Google Play Integrity, and optional Android Widevine signals.

Overview

Prove that requests come from your genuine app install before trusting sensitive API calls. prepare() and createAttestation() cover Apple App Attest flows, while Play Integrity Standard and optional Widevine fingerprint methods cover Android. Store key IDs securely with the built-in helpers.

Typical fits: fraud prevention, high value transactions, and anti tamper checks on login or payout endpoints.

Platform support

Platform	Support	Notes
iOS	Yes	App Attest keys, assertions, DeviceCheck token helper
Android	Yes	Play Integrity Standard, optional Widevine fingerprint
Web	Fallback	Web attestation format when native APIs are unavailable

Core Capabilities

isSupported - Checks whether native attestation is available on this device.
prepare - Prepares attestation state and returns the key handle used for later calls.
createAttestation - Creates a registration attestation token bound to a backend-issued challenge.
createAssertion - Creates a request assertion token bound to a request payload.

Public API

Method	Description
`isSupported`	Checks whether native attestation is available on this device.
`prepare`	Prepares attestation state and returns the key handle used for later calls.
`createAttestation`	Creates a registration attestation token bound to a backend-issued challenge.
`createAssertion`	Creates a request assertion token bound to a request payload.
`storeKeyId`	Stores/prepares a key identifier for reuse.
`getStoredKeyId`	Returns the currently stored/prepared key identifier.
`clearStoredKeyId`	Clears stored/prepared key identifiers.
`generateKey`	Legacy alias for `prepare()`.
`attestKey`	Legacy alias for `createAttestation()`.
`generateAssertion`	Legacy alias for `createAssertion()`.

Source Of Truth

This reference is synced from src/definitions.ts in capacitor-app-attest.

Keep going from @capgo/capacitor-app-attest

If you are using @capgo/capacitor-app-attest to plan security and compliance, connect it with Using @capgo/capacitor-app-attest for the native capability in Using @capgo/capacitor-app-attest, Encryption for the implementation detail in Encryption, Compliance for the implementation detail in Compliance, Capgo Security Scanner for the product workflow in Capgo Security Scanner, and Capgo Security for the product workflow in Capgo Security.