How to Change the Validity Period for Verify PIN Codes? How to Change the Validity Period for Verify PIN Codes?

How to Change the Validity Period for Verify PIN Codes?

Vonage API Support

Question

How to Change the Validity Period for Verify PIN Codes?

Applies To

  • Verify V1
  • Verify V2
  • PIN Code
  • API Requests

Answer

Previously, in Verify V1, PIN codes were set to expire after 5 minutes by default. However, if needed, you can set a custom expiration time for the PIN code using the &pin_expiry parameter. This parameter determines how long the PIN code stays valid, measured in seconds, starting from the moment the code is generated. For example, this includes the time when the request is received and the first attempt to send the code is made. If you don't set a custom time, the PIN will automatically expire after 300 seconds (or 5 minutes). The expiration time can range from 60 seconds (1 minute) to 3600 seconds (1 hour). 

In Verify V2, we’ve added a new feature called channel_timeout to give you more control over the PIN expiry and event timings. This field can be included in the request body when you send a POST request to the endpoint: https://api.nexmo.com/v2/verify/. By default, the channel_timeout is set to 180 seconds (3 minutes), but you can customize it to as low as 15 seconds for the PIN code to expire sooner if needed.

Additional Information

Refer to the following developer documents for more information 

Verify V1 - https://developer.vonage.com/en/api/verify

Verify V2 - https://developer.vonage.com/en/api/verify.v2