@vonage/verify2
v1.15.0
Published
Verify API provides a choice of routes for sending a code to a user. You can use this to confirm a user's contact information, as a second factor when authenticating users, or for step-up authentication.
Downloads
181,845
Maintainers
Keywords
Readme
Vonage Verify V2 SDK for Node.js
This is the Vonage Verify (for version 2) SDK for Node.js for use with Vonage APIs. To use it you will need a Vonage account. Sign up for free at vonage.com.
For full API documentation refer to developer.vonage.com.
Installation
We recommend using this SDK as part of the overall @vonage/server-sdk
package. Please see the main package for installation.
You can also use this SDK standalone if you only need access to just the Verify API.
With NPM
npm install @vonage/verify2
With Yarn
yarn add @vonage/verify2
Usage
If you are using this SDK as part of the Vonage Server SDK, you can access it as the verify2
property off of the client that you instantiate.
const { Vonage } = require('@vonage/server-sdk')
const credentials = {
apiKey: API_KEY,
apiSecret: API_SECRET,
}
const options = {}
const vonage = new Vonage(credentials, options)
vonage.verify2
.newRequest()
.then((resp) => console.log(resp))
.catch((err) => console.error(err))
Standalone
The SDK can be used standalone from the main Vonage Server SDK for Node.js if you only need to use the Verify V2 API. All you need to do is require('@vonage/verify2')
, and use the returned object to create your own client.
const { Auth } = require('@vonage/auth')
const { Verify2 } = require('@vonage/verify2')
const credentials = new Auth({
applicationId: APP_ID,
privateKey: PRIAVTE_KEY,
})
const options = {}
const verifyClient = new Verify2(credentials, options)
Where credentials
is any option from @vonage/auth
, and options
is any option from @vonage/server-client
Promises
Most methods that interact with the Vonage API uses Promises. You can either resolve these yourself, or use await
to wait for a response.
const resp = await verifyClient.checkCode(VERIFY_REQUEST_ID, CODE)
vonage.verify2
.checkCode(VERIFY_REQUEST_ID, CODE)
.then((resp) => console.log(resp))
.catch((err) => console.error(err))
Testing
Run:
npm run test