@titanium-sdk/ti.identity/README.md

A collection of API's to authenticate with your device: Keychain/Keystore, Touch ID and Face ID (iOS only)

# 🔐 Ti.Identity Module [![Build Status](https://jenkins.appcelerator.org/buildStatus/icon?job=modules%2Ftitanium-identity%2Fmaster)](https://jenkins.appcelerator.org/job/modules/job/titanium-identityy/job/master/) [![@titanium-sdk/facebook](https://img.shields.io/npm/v/@titanium-sdk/ti.identity.png)](https://www.npmjs.com/package/@titanium-sdk/ti.identity)

This native module allows you to use Fingerprint authentication, Keychain Access and Face authentication (iOS) with Axway Titanium.

## Requirements
- Titanium SDK 6.2.0 or later
- iOS 8.0 or later
- Xcode 8 or later

## Features
- [x] Use the Fingerprint sensor of your device to authenticate
- [x] Use the Face detection API's of your device to authenticate (iOS 11+)
- [x] Store, read, update and delete items with the native keychain

## Example
Please see the full-featured example in `ios/example/app.js` and `ios/example/app.js`.

## Build from Source
- iOS: `appc run -p ios --build-only` from the `ios` directory
- Android: `appc run -p android --build-only` from the `android` directory

> Note: Please do not use the (deprecated) `build.py` for iOS and `ant` for Android anymore.
> Those are unified in the above appc-cli these days.

## Author
Hans Knöchel, Axway

## License
Apache 2.0

## Contributing
Code contributions are greatly appreciated, please submit a new [pull request](https://github.com/appcelerator-modules/titanium-identity/pull/new/master)!