Sinch Node.js SDK for Verification API

The Sinch Verification API Node.js SDK allows you to quickly interact with the Verification API from inside your Node.js applications. The fastest way to get started with the SDK is to check out our getting started guides. There you'll find all the instructions necessary to download, install, set up, and start using the SDK.

Syntax

When using the Node.js SDK, the code representing requests and queries sent to and responses received from the Verification API are structured similarly to those that are sent and received using the Verification API itself.

The code sample on the side of this page is an example of how to use the Node.js SDK to initiate an Verification SMS PIN request. The code is also displayed below, along with a Verification API call that accomplishes the same task, for reference:

const axios = require('axios');

const APPLICATION_KEY = "<REPLACE_WITH_APP_KEY>";
const APPLICATION_SECRET = "<REPLACE_WITH_APP_SECRET>";
const TO_NUMBER = "<REPLACE_WITH_YOUR_NUMBER>";

const SINCH_URL = "https://verification.api.sinch.com/verification/v1/verifications";

const basicAuthentication = APPLICATION_KEY + ":" + APPLICATION_SECRET;

const payload = {
    identity: {
        type: 'number',
        endpoint: TO_NUMBER
    },
    method: 'sms'
};

const headers = {
    'Authorization': 'Basic ' + Buffer.from(basicAuthentication).toString('base64'),
    'Content-Type': 'application/json; charset=utf-8'
};

axios.post(SINCH_URL, payload, { headers })
    .then(response =>
        console.log(response.data)
    ).catch(error =>
    console.error('There was an error!', error)
);

const {SinchClient} = require('@sinch/sdk-core');
const {verificationsHelper} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    applicationKey: 'YOUR_application_key',
    applicationSecret: 'YOUR_application_secret'
});
const startRequestData = verificationsHelper.buildStartSmsVerificationRequest(
                                                        number);
const smsVerification = await sinchClient.verification.verifications.startSms(
                                                        startRequestData);

console.log(JSON.stringify(smsVerification));

This example highlights the following required to successfully make a Verification API call using the Sinch Node.js SDK:

• Client initialization
• Verification domain access
• Endpoint usage
• Field population

Client

When using the Sinch Node.js SDK, you initialize communication with the Sinch backend by initializing the Node.js SDK's main client class. This client allows you to access the functionality of the Sinch Node.js SDK.

Initialization

To start using the SDK, you need to initialize the main client class with your credentials from your Sinch dashboard.

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    applicationKey: "YOUR_application_key",
    applicationSecret: "YOUR_application_secret"
});

APPKEY="YOUR_application_key"
APPSECRET="YOUR_application_secret" 

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    applicationKey: process.env.APPKEY,
    applicationSecret: process.env.APPSECRET
});

const {SinchClient} = require('@sinch/sdk-core');

const sinchClient = new SinchClient({
    projectId: "YOUR_project_id",
    keyId: "YOUR_access_key",
    keySecret: "YOUR_access_secret",
    applicationKey: "YOUR_application_key",
    applicationSecret: "YOUR_application_secret"
});

Verification domain

Endpoint categories

In the Sinch Node.js SDK, Verification API endpoints are accessible through the client. The naming convention of the endpoint's representation in the SDK matches the API:

• verification.verifications
• verification.verificationStatus

For example:

const startRequestData = verificationsHelper.buildStartSmsVerificationRequest(
                                                      "YOUR_phone_number");
const smsVerification = await sinchClient.verification.verifications.startSms(
                                                      startRequestData);

verification.verifications endpoint category

verification.verificationStatus endpoint category

Helper methods

The Node.js SDK has a number of helper methods designed to aid in quickly constructing the correct request bodies for the various methods. The helper methods available and their parameters are described in the example and table below.

const requestData = verificationHelper.buildStartSmsVerificationRequest(
                                          "YOUR_phone_number");

Request and query parameters

Requests and queries made using the Node.js SDK are similar to those made using the Verification API. Path parameters, request body parameters, and query parameters that are used in the API are all passed as arguments to the corresponding Node.js method.

const response = await sinchClient.verification.verificationStatus.getByIdentity({
    endpoint: 'PHONE_NUMBER',
    method: 'sms'
});

url = "https://verification.api.sinch.com/verification/v1/verifications/" + method + "/number/" + endpoint

Responses

Response fields match the API responses. They are delivered as Javascript objects.