GO-OTP Verification-Microservice with Twilio

-A Modular GO OTP Microservice ,ready to integrate with any app

Example of using Twilio to send OTP verification code to a user and verifying the code.

Setup

1. Clone the repo

2. Create a Twilio account and get your account SID and auth token

3. Create a Twilio verify service and get the service SID

4. Create a .env file in the root of the project and add the in the above credentials from Twilio

TWILIO_ACCOUNT_SID=<ACCOUNT SID>
TWILIO_AUTHTOKEN=<AUTH TOKEN>
TWILIO_SERVICES_ID=<SERVICE ID>

5. Install dependencies

go mod download

6. Run the server

go run cmd/main.go

---

API Documentation

---

Send OTP

POST /otp

Send a POST request to the /otp endpoint with the following body to send an OTP to a user's phone number

Request Sent Body

{
  "phoneNumber": "<phone-number-with-country-code>"
}

Response Recieved

{
  "status": 202,
  "message": "success",
  "data": "OTP sent successfully"
}

Bash Command

curl -H "Content-Type: application/json" -X POST -d '{"phoneNumber": "+911234567891"}' http://localhost:8000/otp

Be sure to include the country code in the phone number

---

---

Verify OTP

POST /verifyOTP

Verify a user's OTP by sending a POST request to the /verify endpoint with the following body that contains the phone number and the OTP code received by the user

Request sent Body

{
  "user": {
    "phoneNumber": "<phone-number-with-country-code>"
  },
  "code": "<code here>"
}

Response recieved body

{
  "status": 202,
  "message": "success",
  "data": "OTP verified successfully"
}

Bash Command

curl -H "Content-Type: application/json" -X POST -d '{"user": {"phoneNumber": "+911234567891"}, "code":"795279"}' http://localhost:8000/verifyOTP

---