Verify OTP

introduction welcome to the api documentation for our verify otp service! this powerful api is designed to provide a seamless and secure verification process for one time passwords (otp) entered by users it plays a crucial role in ensuring that the otps generated and sent through our send otp docid\ pn8jmab5qffspzkwpclzq api are accurately validated, enabling a robust and reliable user authentication flow once the send otp docid\ pn8jmab5qffspzkwpclzq api is utilized to deliver the otp to the user's designated communication channel, the verify otp docid 3vrirj86eolys6hk2mxb8 api comes into action it acts as the final gatekeeper, confirming whether the otp entered by the user matches the one generated by our system by performing this crucial step, our api helps maintain a high level of security, protecting sensitive information and user accounts from unauthorized access the verify otp api is an indispensable tool for applications and services that require a secure authentication mechanism, particularly in scenarios where one time passwords are utilized to grant access or perform sensitive actions through this api, developers can confidently validate user provided otps and grant access only to authorized users, preventing fraudulent activities and safeguarding user data in this comprehensive documentation, we will guide you through the integration process, highlighting essential parameters, response codes, and best practices for leveraging the verify otp api effectively whether you are building a new application or enhancing the security of an existing one, our verify otp api is here to empower your authentication workflows with accuracy and reliability let's get started and ensure the utmost security for your users! sample curl curl location 'https //api signzy us/api/v3/otp verification/verify otp' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data '{ "clientid" "64c1276a17d013abfe470c70", "phonenumber" "+91 9907676881", "otp" "840804" }'curl location 'https //api preproduction signzy app/api/v3/otp verification/verify otp' \\ \ header 'content type application/json' \\ \ header 'authorization \<token>' \\ \ data '{ "clientid" "64c1276a17d013abfe470c70", "phonenumber" "+91 9907676881", "otp" "840804" }' request body parameters parameter name data type required description clientid string yes a unique identifier for the client please contact sales administrator to get a unique clientid assigned to you phonenumber string yes the phone number where the otp will be sent it should be in e 164 format with the country code (e g , +1 for the us) the phone number should be formatted with a "+" sign followed by the country code, a hyphen " ", and then the remaining digits of the phone number for example, "+1 9907676111" for the us otp string yes the otp (one time password) received by the user via sms for verification the otp should be a string of digits for example, "840804" sample success response otp is verified { "result" { "verified" "true", "status" "200", "statusdescription" "success otp is verified" } } otp is invalid { "result" { "verified" "false", "status" "200", "statusdescription" "failure otp is invalid" } } otp has expired { "result" { "verified" "false", "status" "200", "statusdescription" "failure otp has expired" } } success response parameters parameter name data type description result object an object containing the result of the otp verification result verified boolean a boolean value indicating whether the otp is verified or not possible values are "true" if the otp is verified successfully, and "false" if the otp verification fails result status string the http status code of the request processed by the server result statusdescription string a descriptive message indicating the status of the response for successful otp verification, the value is "success otp is verified" for expired otp, the value is "failure otp has expired" for an invalid otp, the value is "failure otp is invalid" important points to be noted otp has validity for 2 minutes we recommend you to only allow user to re send otp after 30 45 seconds in case it is required in case multiple otps are sent to the user, the latest one is valid for authentication & all previous otps will be invalid once the otp is successfully verified for a user, you can't verify the same otp again in verify otp api sample error invalid mobile number { "error" { "name" "error", "message" "mobile number is not valid/allowed", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } otp already verfied { "error" { "name" "error", "message" "otp already verified please resend an otp ", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } resource not found { "error" { "name" "error", "message" "resource not found please send otp first", "status" 400, "reason" "error", "type" "bad request", "statuscode" 400 } } upstream down { "error" { "name" "error", "message" "upstream down", "status" 409, "reason" "error", "type" "conflict", "statuscode" 409 } } unauthorized (401) { "message" "no api key found in request" } error response parameters parameter name data type description error object an object containing details about the error error name string the name of the error error message string a descriptive error message error status number the http status code of the client request error reason string the reason for the error error type string the type of error (e g , "bad request") error statuscode number the specific status code returned by the server in response to the request, indicating whether the server was able to process the request and provide a response getting help please feel free to contact us if you have any questions, require clarification, or have ideas for how to make the documents or any of our services better you can reach out to us at help\@signzy com we strive to provide prompt and reliable assistance, ensuring your queries are addressed effectively we value your feedback and are committed to making your experience smooth and enjoyable our team is dedicated to assisting you with any needs you may have thank you for choosing our services we look forward to helping you!