otplessAuthSdk

Merchant Integration Documentation(Backend GoLang Auth SDK)

A. OTPLessAuth Dependency

install Below dependency in your project's

go get github.com/otpless-tech/otpless-auth-sdk@latest

you can also get latest version of dependency at https://pkg.go.dev/github.com/otpless-tech/otpless-auth-sdk/pkg

B. OTPLessAuth

The OTPLessAuth pkg provides methods to integrate OTPLess authentication into your GoLang backend application. This documentation explains the usage of the class and its methods.

Methods:

1. decodeIdToken

This method help to resolve idToken(JWT token) which is issued by OTPLess which return user detail from that token also this method verify that token is valid, token should not expired and issued by only otpless.com

DecodeIDToken(idToken, clientID, clientSecret, audience string)

Method Params:

Return

Return: Object Name: UserDetailResult

2. VerifyCode

This method help to resolve token which is issued by OTPLess which return user detail from that token also this method verify that token is valid, token should not expired and issued by only otpless.com

VerifyCode(code, clientID, clientSecret)

Method Params:

Return

Return: Object Name: UserDetailResult

3. VerifyAuthToken

This method help to resolve token which is issued by OTPLess which return user detail from that token also this method verify that token is valid, token should not expired and issued by only otpless.com

VerifyAuthToken(token, clientID, clientSecret string)

Method Params:

Return

Return: Object Name: UserDetailResult

userDetail := UserDetailResult{
    Success:     true,
    AuthTime:  1697473071,
    Email:       "dev****@gmail.com",
    Name:        "Dhaval From OTP-less",
    PhoneNumber: "+9193*****",
    country_code: "+91",
    national_phone_number: "95******",
}

UserDetail Object Fields:

success (boolean): This will be true in case of method successfully performed operation.
> authTime (Long, required): The time when authentication was completed.
> phoneNumber (String, required): The user's phone number.
> countryCode (String, required): The country code of user's phone number.
> nationalPhoneNumber (String, required): The user's phone number without country code.
> email (String, required): The user's email address.
> name (String, required): The user's full name.

4. Generate Magic link

The Authorization Endpoint initiates the authentication process by sending a magic link to the user's WhatsApp or email, based on the provided contact information. This link is used to verify the identity of the user. Upon the user's action on this link, they are redirected to the specified URI with an authorization code included in the redirection.

GenerateMagicLink(mobileNumber, email, clientID, clientSecret, redirectUri, channel string) (*MagicLinkResponse, error)

Method Params:

Return

Return: Object Name: RquestIds

&{RequestIds:[{Type:MOBILE Value:c36b678aef104691b15f93910acfee48 DestinationUri:https://wa.me/91971***XX**} {Type:EMAIL Value:39250d56e8da4f4cb86224929bf76a2d}]}

Error case:

success (boolean): This will be false. The method is failed to perform.
errorMessage (String): The message contains error information.

C. OTP class

These methods enable you to send, resend and verify OTP.

Methods:

1. Send OTP

SendOTP(req SendOTPRequest, clientID, clientSecret string) (*SendOTPResponse, error)

Method Params:

Return

Return: Object Name: SendOTPResponse

{
  "orderId": "Otp_ED5F709E1C6B41EB8C0595C7968354EB"
}

2. Resend OTP

    ResendOTP(orderID, clientID, clientSecret string) (*ResendOTPResponse, error)

Method Params:

Return

Return: Object Name: ResendOTPResponse

{
  "orderId": "DP0000111"
}

3. Verify OTP

    VerifyOTP(orderID, otp, email, phoneNumber, clientID, clientSecret string) (*VerifyOTPResponse, error)

Method Params:

Return

Return: Object Name: VerifyOTPResponse

• reason (String): The will be errorMessage in case of OTP doesn't verified

{
  "isOTPVerified": true
}

Example of usage

package main

import (
	"fmt"

	otplessAuthSdk "github.com/otpless-tech/otpless-auth-sdk"
)

func main() {
	clientID := "your_client_id"
	clientSecret := "your_client_secret"
	code := "some_code"

	result, err := otplessAuthSdk.VerifyCode(clientID, clientSecret, code)

	if err != nil {
		fmt.Println("Error:", err)
		return
	}

	fmt.Println("Result:", result)
}

This method allows you to decode and verify OTPLess ID tokens and retrieve user information for integration into your backend GoLang application.