Change the Event Timings

You can change the default timings by supplying custom values for pin_expiry and/or next_event_wait in the initial request:

  • pin_expiry:
    • The time after which the code expires
    • Must be an integer value between 60 and 3600 seconds
    • The default expiry differs between workflows but will be 300 seconds in most cases
  • next_event_wait:
    • The time after which Vonage triggers the next verification attempt
    • The default timing differs for each workflow

If you specify values for both pin_expiry and next_event_wait, the value of pin_expiry must be an exact multiple of next_event_wait.

Examples

The table below shows some example values and the effects when used with the default workflow (SMS -> TTS -> TTS):

pin_expirynext_event_waitEffect
360 seconds120 secondsAll three attempts use the same verification code
240 seconds120 secondsThe first and second attempts use the same code and the Verify API generates a new code for the third attempt
120 seconds (or 90 or 200 seconds)120 secondsThe Verify API generates a new code for each attempt