# authenticator-sdk

> Use Finnotech authentication .

Latest version **0.1.4** (published 2023-10-16) · MIT license · 0 weekly downloads

## Install

```sh
npm install authenticator-sdk
pnpm add authenticator-sdk
yarn add authenticator-sdk
bun add authenticator-sdk
```

## Health

**Score 30/100 (F)** — status: abandoned.

Positive: has types; esm support; no vulnerabilities; high quality score.

Warnings: low downloads; pre 1.0.

Negative: abandoned; low maintenance score.

## Facts

| | |
|---|---|
| Version | 0.1.4 |
| Published | 2023-10-16 |
| First published | 2023-10-12 |
| Weekly downloads | 0 |
| License | MIT |
| TypeScript types | bundled |
| Module format | ESM + CommonJS |
| Dependencies | 0 |
| Unpacked size | 2 MB |
| Known vulnerabilities | 0 |
| Install scripts | no |
| GitHub stars | 0 |
| Author | fazelegh@gmail.com |
| Maintainers | fazele |

## Links

- npm: https://www.npmjs.com/package/authenticator-sdk
- Repository: https://github.com/fazeleGhayoori/authenticator-sdk
- Homepage: https://github.com/fazeleGhayoori/authenticator-sdk#readme
- Issues: https://github.com/fazeleGhayoori/authenticator-sdk/issues
- npm.io page: https://npm.io/package/authenticator-sdk

## Recent versions

- 0.1.4 (latest) — 2023-10-16
- 0.1.3 — 2023-10-12
- 0.1.2 — 2023-10-12
- 0.1.1 — 2023-10-12
- 0.1.0 — 2023-10-12

## README

# Iranian Authenticator

Use Finnotech authentication .

## Getting started

### Installing and using

Install from npm:

```
npm install --save authenticator-sdk
```

```
yarn add authenticator-sdk
```

authenticator-sdk lets you authenticate your user with Finnotech services

We are developing user authentication, which we have started with Finnotech SDK,
which is a comprehensive Iranian authentication system.

## How to use

```javascript
import Finnotech from 'authenticator-sdk'

// You will have these values after creating an account in Finnotech service
const finnotech = new Finnotech({
    clientId: 'FINNOTECH_CLIENT_ID',
    clientPass: 'FINNOTECH_CLIENT_PASSWORD',
    clientNationalCode: 'FINNOTECH_CLIENT_NATIONALCODE',
})

//Returns a Boolean value indicating whether the phone number matches the national code or not
console.log(finnotech.matchPhoneNumberWithNationalCode(phoneNumber, nationalCode));

// Example response 
// {
//     "responseCode": "FN-FYKZ-20001000000",
//     "trackId": "******",
//     "result": {
//         "isValid": true
//     },
//     "status": "DONE"
// }
```

---
_Source: https://npm.io/package/authenticator-sdk · Machine-readable twin of the npm.io package page. Health data is recomputed on every publish._