For the complete documentation index, see llms.txt. This page is also available as Markdown.

Verify OTP

This is a service used to verify or authenticate customers using One Time Password (OTP) to their mobile number via SMS. Customers need to input the unique random number generated by Finnet for the authentication process.

Technical Specification

Service Code: 04

Body Request

No
Name
Type
Mandatory
Min Length
Max Length
Description

1

originalPartnerReferenceNo

String

M

1

64

Transaction identifier number from partner

2

action

String

M

1

10

Purpose of the OTP verification, filled with otpLinkage

3

otp

String

M

1

8

OTP from SMS sent to customer phone number.

Sample Request

{
  "originalPartnerReferenceNo": "123456789876543431",
  "action": "otpCreation",
  "otp": "696969"
}

Body Response

No
Name
Type
Mandatory
Min Length
Max Length
Description

1

responseCode

M

1

7

BI SNAP Response Code.

2

responseMessage

String

M

1

150

BI SNAP Response Message.

3

originalPartnerReferenceNo

String

O

1

64

Transaction identifier number from partner

4

linkageToken

String

O

1

204

Access Token expiry time in ISO8601 format

5

phoneNo

String

O

1

16

Customer's phone number to be created

6

qParamsURL

String

O

1

100

Redirect URL for binding actions

7

qParams

O

1

1

Query parameters for the qParamsURL

8

additionalInfo

O

1

2

Additional Info

Sample Response

Response Code & Message

The table below lists response codes and messages for the Verify OTP API.

No
HTTP Code
Code
Message

1

200

2000400

Successful

2

400

4000400

Bad request

3

400

4000401

Invalid field format {field}

4

400

4000402

Invalid mandatory field {field}

5

401

4010401

Invalid token (B2B)

6

401

4010400

Unauthorised. [Reason]

7

403

4030401

Feature not allowed

8

403

4030404

Activity count limit exceeded

9

404

4040408

Invalid merchant

10

500

5000400

General error

11

504

5040400

Timeout

Last updated