@vonage/number-insight-v2
v1.8.3
Published
Number Insight v2 is designed to give fraud scores for Application Integrations.
Downloads
397
Maintainers
Keywords
Readme
Vonage Number Insight V2 SDK for Node.js
This is the Vonage Number Insight V2 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.nexmo.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 Number insights V2 API.
With NPM
npm install @vonage/number-insight-v2
With Yarn
yarn add @vonage/number-insight-v2
Usage
Unlike the other SDK's this package is not include in the Vonage Server SDK for Node.js
const { Auth } = require('@vonage/auth');
const { NumberInsightV2 } = require('@vonage/number-insight-v2');
const credentials = new Auth({
apiKey: API_KEY,
apiSecret: API_SECRET
});
const options = {};
const niClient = new NumberInsightV2(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 vonage.numberInsightV2.basicLookup(PHONE_NUMBER)
vonage.numberInsightV2.checkForFraud({
type: 'phone',
phone: PHONE_NUMBER,
insights: [Insight.SIM_SWAP, Insight.FRAUD_SCORE],
})
.then(resp => console.log(resp))
.catch(err => console.error(err));
Testing
Run:
npm run test