OTP Verification
Business applications can use this service API to verify an OTP, generated using OTP Login Authentication.
|
https://api.signinghub.com/authentication/otp/verify |
||
|
HTTP Verb |
GET |
|
|
Content-Type |
application/json |
|
|
Accept |
application/json |
|
| x-otp | '456789' | |
|
Authorization |
Bearer {access_token} |
|
|
Request Body |
|
|
|
Status Code |
Message |
Response Body |
|
200 |
OK |
|
|
401 |
Unauthorized |
{ "Message": "Request authorization denied"} |
{ "Message": "User authentication required"} |
||
|
403 |
Forbidden |
{ "Error": "invalid_credentials" "Message": "You have entered incorrect authentication credentials - try again"} |
{ "Error": "otp_required" "Message": "One time password is required"} |
||
{ "Message": "Account is disabled"} |
||
|
404 |
Not Found |
{ "Message": "Document not found"} |
|
500 |
Internal Server Error |
{ "Message": "An internal server error occurred while processing the request"} |
| Item Details | |
| Names |
Description |
| Request Parameters |
|
| access_token | The access token obtained as a result of successful authentication. If "scope" parameter was used in authentication request, then this service requires the access token to be obtained using the credentials of an Enterprise admin whose enterprise role has the application integration privileges. |
| document_id | The ID of the document. |
| package_id | ID of the package to which the document is added. |
| field_name |
Unique identifier of the field in the document. |
| Response Parameters | |
| OTP | OTP that is generated and sent to the user's mobile. |
| Message | The service specific error message returned by the API. This message provides useful information about why the service has returned an error response. |