parse-otp-message

Parses OTP messages for a verification code and service provider.


Keywords
verify, verification, confirmation, activation, authentication, auth, code, pin, otp, login, security, number, phone, phone number, sms, 2fac, 2factor, 2-fac, 2-factor, 2-step
License
MIT
Install
npm install parse-otp-message@1.0.1

Documentation

parse-otp-message

Parses OTP messages for a verification code and service provider.

NPM Build Status JavaScript Style Guide

  • handles hundreds of known services (wechat, google, facebook, whatsapp, uber, twitter, etc...)
  • thorough test suite
  • meant for parsing automated sms messages

Install

npm install --save parse-otp-message

Usage

const parse = require('parse-otp-message')

const result = parse('Use 5677 as Microsoft account security code')

// result.code = '5677
// result.service = 'microsoft'

See the test suite for more examples of the types of messages this module can parse.

API

parse(message)

Returns: Object

Parses the given message and returns an object containing two fields, code and service. The auth code will be all digits except in some special cases, and the returned service will always be lowercase.

If no code or service is found, undefined is returned.

message

Type: String Required

SMS or email message possibly containing an auth code and/or service provider details.

License

MIT © Travis Fischer