Verify a user using SMS PIN with Node.js SDK
This guide shows how to verify a user in a Node.js application using the Verification API and Node.js SDK to make and then report an SMS PIN verification.
The following diagram demonstrates the flow that happens to verify a user:
- The end user visits your website or service and tries to log in.
- Your backend then makes a request to the Sinch platform and initiates an SMS PIN verification request.
- The Sinch platform sends an SMS message with a one time PIN code to the phone number of the user.
- The user enters the code they received.
- Your backend makes a report verification request using the code the user entered.
- If the code matches, your backend will receive a success result from Sinch.
- The user, now verified, can proceed to log in to your site or service.
In this guide you will learn:
What you need to know before you start
Before you can get started, you need the following already set up:
- Set all Verification API configuration settings.
- NPM and a familiarity with how to install packages.
- Node.js and a familiarity with how to create a new app.
- A mobile handset that can receive SMS messages.
Set up your Node.js application
To quickly get started setting up a simple client application using the Node SDK:
- If you haven't already, clone the sinch-sdk-node-quickstart repository.
- Navigate to the
/getting-started/verification/user-verification-using-sms-pin/client
folder. - Open a command prompt or terminal and run the following command to install the necessary dependencies:
npm install
- Open the
.env
file. Using the Verification app credentials from your Sinch Customer Dashboard, populate the following fields with your values:
Field | Description |
---|---|
SINCH_APPLICATION_KEY | The unique ID of your application. |
SINCH_APPLICATION_SECRET | The secret for your application. |
- Save the file.
Initiate your verification request
- Now you can execute the code and initiate your verification request. Run the following command:
node src/app.js
- Follow the prompts in the console and enter the phone number of the mobile handset to which you want to send the SMS PIN verification request.
You should receive a text message to your mobile handset with a verification code. In a production scenario, this is the code that a user would enter into your app to verify their account.
You should also see the response in the console.
Report your SMS PIN code
Now that you've received the SMS PIN code to your mobile handset, it's time to report that code to the Sinch servers to complete the verification process.
- In the console, follow the prompts by entering the code you received on your mobile handset.
- If you entered the code that you received, you should see a success report response in your console.
- Enter
Q
in the console to quit the application or try sending a code to your mobile handset again and reporting an incorrect code to see what happens!