Verify a user using SMS PIN with the Java SDK
This guide shows how to verify a user in a Java application using the Verification API and Java 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:
- Set up your Java application
- How to initiate an SMS PIN verification request
- How to report an SMS PIN verification code
Note:
Before you can get started, you need the following already set up:
- Set all Verification API configuration settings.
- JDK 21 or later. While the Java SDK itself requires JDK 8 or later, this application uses the latest RTS version of Java.
- Apache Maven and a familiarity with how to use the Maven CLI.
Set up your Java application
To quickly get started setting up a simple client application using the Java SDK:
- If you haven't already, clone the sinch-sdk-java-quickstart repository.
- Navigate to the
getting-started/verification/user-verification-using-sms-pin/client/src/main/resourcesfolder. - Open the
config.propertiesfile. Using the Verification app credentials from your Sinch Customer Dashboard, populate the following fields with your values:
| Field | Description |
|---|---|
| APPLICATION_API_KEY | The unique ID of your application. |
| APPLICATION_API_SECRET | The secret for your application. |
- Save the file.
Package the application
Now that you've modified the application, you need to use the Maven CLI to create a package that you can then execute. Open a command prompt or terminal to thesinch-sdk-java-quickstart/getting-started/verification/user-verification-using-sms-pin/client folder and run the following command:mvn packagetarget folder and application.Initiate your verification request
- Now you can execute the code and initiate your verification request. Run the following command:
java -jar target/sinch-java-sdk-client-application-1.0-SNAPSHOT-jar-with-dependencies.jar - 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.
Troubleshooting tip
If after running your app you receive an application credentials error response, you may have forgotten to save your file after adding your authentication values. This is an easy mistake to make! Try saving the file and running the app again.
You should also see the JSON 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
Qin 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!
