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
| Environment | Method | URL |
|---|---|---|
| Development | POST | https://snapstag.finnet.co.id/v1.0/otp-verification |
| Production | POST | https://snap.finnet.co.id/v1.0/otp-verification |
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 | Enum | 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 | Object | O | 1 | 1 | Query parameters for the qParamsURL |
| 8 | additionalInfo | Object | O | 1 | 2 | Additional Info |
Sample Response
{
"responseCode": "2000400",
"responseMessage": "Request has been processed successfully",
"partnerReferenceNo": "78912343452347001",
"linkageToken": {},
"phoneNo": "+6281977817919",
"qParamsUrl": "https://webview.finnet.co.id/partner/creation/pin-registration",
"qParams": {
"action": "otpLinkage"
},
"additionalInfo": {
"clientId": "9719394d-af91-4f9c-9d16-6b6233a45889",
"redirectToDeepLink": "https://snapstag.finnet.co.id/health"
}
}