# eagle-id
> A React based component to perform identity verification
Latest version **1.1.2** (published 2020-08-13) · MIT license · 0 weekly downloads
## Install
```sh
npm install eagle-id
pnpm add eagle-id
yarn add eagle-id
bun add eagle-id
```
## Health
**Score 15/100 (F)** — status: abandoned.
Positive: no vulnerabilities.
Warnings: low downloads; no types; no esm support.
Negative: abandoned; low maintenance score.
## Facts
| | |
|---|---|
| Version | 1.1.2 |
| Published | 2020-08-13 |
| First published | 2020-05-13 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | none |
| Module format | CommonJS |
| Dependencies | 15 |
| Unpacked size | 1.1 MB |
| Known vulnerabilities | 0 (+26 in 2 direct dependencies) |
| Install scripts | no |
| Author | Robin Ankele |
| Maintainers | eyn-vision |
| Keywords | Eagle, Id, Idenity, Verification, ID, Passport, Identity |
## Links
- npm: https://www.npmjs.com/package/eagle-id
- Repository: github-eyn:Ayn-AI/eagle-id
- Homepage: https://www.eyn.vision/eagleid
- npm.io page: https://npm.io/package/eagle-id
## Dependencies (15)
- [http](https://npm.io/package/http.md) 0.0.1-security
- [jimp](https://npm.io/package/jimp.md) ^0.12.1
- [axios](https://npm.io/package/axios.md) ^0.19.2
- [https](https://npm.io/package/https.md) ^1.0.0
- [react](https://npm.io/package/react.md) ^16.13.1
- [notistack](https://npm.io/package/notistack.md) ^0.9.16
- [react-dom](https://npm.io/package/react-dom.md) ^16.13.1
- [react-lottie](https://npm.io/package/react-lottie.md) ^1.2.3
- [react-webcam](https://npm.io/package/react-webcam.md) ^5.0.1
- [detect-browser](https://npm.io/package/detect-browser.md) ^5.1.0
- [@material-ui/core](https://npm.io/package/@material-ui/core.md) ^4.9.14
- [@material-ui/icons](https://npm.io/package/@material-ui/icons.md) ^4.9.1
- [@material-ui/styles](https://npm.io/package/@material-ui/styles.md) ^4.10.0
- [react-device-detect](https://npm.io/package/react-device-detect.md) ^1.12.1
- [react-exif-orientation-img](https://npm.io/package/react-exif-orientation-img.md) ^0.1.5
## Alternatives
- [@sindresorhus/slugify](https://npm.io/package/@sindresorhus/slugify.md) — 3.7M weekly downloads
- [solid-js](https://npm.io/package/solid-js.md) — 2.7M weekly downloads
- [expo-glass-effect](https://npm.io/package/expo-glass-effect.md) — 2.5M weekly downloads
- [nanoassert](https://npm.io/package/nanoassert.md) — 780.8K weekly downloads
- [@ffmpeg/ffmpeg](https://npm.io/package/@ffmpeg/ffmpeg.md) — 529.5K weekly downloads
## Recent versions
- 1.1.2 (latest) — 2020-08-13
- 1.1.1 — 2020-08-13
- 1.1.0 — 2020-08-13
- 1.0.1 — 2020-05-13
- 1.0.0 — 2020-05-13
## README
EYN Eagle Id Component
====
The EYN Eagle Id component provides convenient access to the EYN's API from applications written in React-based JavaScript.
A demo of *eagle-id* to verify a person's identity via a (mobile) browser application click here.
Documentation
====
See the EYN's API docs for more information.
Installation
====
Install the package with:
```
npm install eagle-id --save
# or
yarn add eagle-id`
```
Usage
====
```
import EagleId from 'eagle-id'
```
## Resources + Demo
Important, for the use of `eagle-id` you need to copy some resources into your `public` folder of your `React` project. These resources comprise images and animations. The required resources can be downloaded [here](https://github.com/Ayn-AI/eagle-id-front-end/blob/master/resources.zip).
### Demo
A `React` demo project using `eagle-id` can be found [here](https://github.com/Ayn-AI/eagle-id-front-end).
Configuration
====
The package can be initialized with several options as outlined below.
### Props
| prop | type | default | notes |
| ------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------- |
| config | object | see default config | Configuration of the component to your needs |
The default config is set as follows:
```
{
"baseUrl": "https://api.eyn.ninja/api/v1/prod/identitycheck",
"apiSecret": "public-e692d869-c110-4a33-b003-2098a5e04f72",
"privacy": {
"show": true,
"notice": "https://www.eyn.vision/privacynotice",
},
"title": "Eagle ID powered by EYN",
"ui": {
"documentTitle": "Select Your Document Type",
"documentSubTitle": "",
},
"camera": {
"imageFormat": "image/jpeg",
"ui": {
"idFront": {
"scanLabel": "Scan the FRONT SIDE of your document",
"infoLabel": "Place it within the frame and press the camera button",
"scanNumber": "Scan 1/2"
},
"idBack": {
"scanLabel": "Scan the BACK SIDE of your document",
"infoLabel": "Place it within the frame and press the camera button",
"scanNumber": "Scan 2/2"
},
"visa": {
"scanLabel": "Scan your VISA document",
"infoLabel": "Place it within the frame and press the camera button",
"scanNumber": ""
},
"passport": {
"scanLabel": "Scan the FRONT PAGE of your PASSPORT document",
"infoLabel": "Please make sure to only include the main page containing the passport photo",
"scanNumber": ""
},
"other": {
"scanLabel": "Scan your document",
"infoLabel": "Place it within the frame and press the camera button",
"scanNumber": ""
},
"selfie": {
"scanLabel": "Send us a smile",
"infoLabel": "Place it within the frame and\n press the camera button",
"scanNumber": ""
},
}
},
"resources": {
"images": {
"logo": "./resources/images/logo.png",
"logoTitle": "./resources/images/logo-title.png",
"privacy": "./resources/images/privacy-notice.png",
"icon_passport": "./resources/images/type_passport.svg",
"icon_id": "./resources/images/type_identity_card.svg",
"icon_other": "./resources/images/identity_type_other.svg",
"icon_camera": "./resources/images/camera.svg",
"image_selfie": "./resources/images/selfie_instruc.svg",
"overlay_document_web": "./resources/images/overlay_document.svg",
"overlay_document_mobile": "./resources/images/overlay_document_mobile.svg",
"overlay_selfie_web": "./resources/images/overlay_selfie.svg",
"overlay_selfie_mobile": "./resources/images/overlay_selfie_mobile.svg",
},
"animations": {
"passport": "./resources/animations/scan_passport.json",
"idfront": "./resources/animations/scan_document_front.json",
"idback": "./resources/animations/scan_document_back.json",
"status_good": "./resources/animations/verify_status_good.json",
"loading": "./resources/animations/loading_coffee.json",
}
}
}
```
| prop | type | default | notes |
| ------------------------- | -------- | ------------ | --------------------------------------------------------------------------------------- |
| baseUrl | string | https://api.eyn.ninja/api/v1/prod/identitycheck | Endpoint URL of EYN's API |
| apiSecret | string | public-e692d869-c110-4a33-b003-2098a5e04f72 | Secret to identify the customer |
| privacy | object | - | Privacy settings for the npm component |
| show | Boolean | true | Setting to show the privacy notice |
| notice | string | https://www.eyn.vision/privacynotice | URL to privacy notice |
| ui | object | - | User interface configuration |
| title | string | Eagle ID powered by EYN | Title of component |
| camera | object | - | Camera configuration |
| imageFormat | string | image/jpeg | Data type of selfie image |
| resources | object | - | Resource configuration |
| images | object | - | Image resources |
| animations | object | - | Animation resources |
Support
====
For any developer feedback please contact us at dev@eyn.vision
For inquiries or any other feedback please contact us at contact@eyn.vision
Thanks,
EYN
---
_Source: https://npm.io/package/eagle-id · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._