This parameter is mandatory.

• The destination phone number to be verified.
• The destination can be provided in 2 formats:
  • National format: a phone number without the international dialing prefix. When using this format, the country parameter must be provided. Without it, 8x8 cannot determine the country of origin and the request cannot be routed.
  • International format: a phone number including the international dialing prefix, for example 65 for Singapore. The number may be provided with or without a leading +. Any leading 0 after the country code must be removed.
• All non-relevant formatting characters such as spaces, brackets, and dashes are automatically removed. You may safely provide unformatted user input.

Optional parameter.

• Required when the destination phone number is provided in national format.
• Must contain the ISO Alpha-2 country code of the destination number.
• When provided, 8x8 automatically formats the number for international routing by adding the country dialing prefix and removing any leading 0 if present.
• If omitted for a national format number, the request cannot be routed to the mobile network operator.

Possible values: <= 2 characters

This parameter is not mandatory.

• It designates which channel should be used to send the verify request.
• The default value is sms

Possible values: [sms, call, whatsapp, viber, sma]

This parameter is not mandatory.

• If used, the brand parameter can be inserted as a placeholder in the text of the message defined in the template object. The brand could be inserted in plain-text in the text but using placeholders allows you to maintain a single request method while enabling Verify request across a wide range of products or brands.

Possible values: <= 30 characters

This parameter is not mandatory.

• It designates the length the code that will be generated and inserted in your message.
• The value should be greater or equal to 3 and less or equal to 10.
• The default value is 4

Possible values: >= 3 and <= 10

This parameter is not mandatory.

• It designates the expiry period after which the generated code will not be valid for verification anymore.
• This value represents seconds.
• The value should be greater or equal to 30 and less or equal to 7200.
• The default value is 300

Possible values: >= 30 and <= 7200

This parameter is not mandatory

• It can be set to the following standard modes:
  • NUMERIC
    • regex: ^[0-9]{3,10}$)
    • example: 123456
  • NUMERIC_WITH_DASH
    • regex ==> ^[0-9-]{3,10}$)
    • example: 234-3294 or 231-461
    • remarks:
      • if codeLength == 3 then no dash sign will be used (=NUMERIC)
      • only one dash will be used in the code and located at the center of the code or moved one character to the left of the center of the code if the code cannot be split into 2 halves of digits of same length (see example)
  • ALPHANUMERIC
    • regex ==> ^[a-zA-Z0-9]{3,10}$)
    • example: fiQdAsr315
  • ALPHANUMERIC_CAPITALS
    • regex ==> ^[A-Z0-9]{3,10}$)
    • example: FIQDASR315
  • ALPHANUMERIC_EASY
    • (regex: ^((?![IOQSZ])[A-Z0-9]){3,10}$)
    • example: FDAR315
    • remark: same as ALPHANUMERIC_CAPITALS but excluding I, O, Q, S and Z

Possible values: [NUMERIC, NUMERIC_WITH_DASH, ALPHANUMERIC, ALPHANUMERIC_CAPITALS, ALPHANUMERIC_EASY]

This parameter is not mandatory.

• It is only used for sms and call channels.
• It defines the content of your message, it can be customized for each request using the placeholders {code} and {brand}.
• NB: if personalizing the text of the template, make sure to include the {code} placeholder or your Verify SMS/CALL will not contain any code. The same goes with the {brand} placeholder, if not provided but used in the template, it will be empty.
• Default text (if no value is provided):
  • If brand is specified:
    • {brand}: Your verification code is {code}
  • If brand is not specified:
    • Your verification code is {code}

This parameter is not mandatory.

• For call channel

  • It designates the language of voice to read the text to the end user.
  • The language should be provided if the template value specified for call channel.
  • The default value is en-US

• For whatsapp channel

  • It designates the language of template to be used.
  • If not provided, the default value is the first available language of the requested template.

• Possible case-sensitive values are:

  • ar-EG
  • ar-SA
  • bg-BG
  • ca-ES
  • cs-CZ
  • da-DK
  • de-AT
  • de-CH
  • de-DE
  • el-GR
  • en-AU
  • en-CA
  • en-GB
  • en-IE
  • en-IN
  • en-US
  • es-ES
  • es-MX
  • fi-FI
  • fr-CA
  • fr-CH
  • fr-FR
  • he-IL
  • hi-IN
  • hr-HR
  • hu-HU
  • id-ID
  • it-IT
  • ja-JP
  • ko-KR
  • ms-MY
  • nb-NO
  • nl-NL
  • pl-PL
  • pt-BR
  • pt-PT
  • ro-RO
  • ru-RU
  • sk-SK
  • sl-SI
  • sv-SE
  • ta-IN
  • th-TH
  • tr-TR
  • vi-VN
  • zh-CN
  • zh-HK
  • zh-TW

This parameter is not mandatory.

• This value defines the API behavior when it comes to code generation in the case of multiple requests sent to the same destination during the period of validity of a code sent previously.
• If the value is set to true: a new code will be generated and the verification request will be reinitialized. Be aware that it can lead to some confusion if the 2 SMS reach the destination device at the same time.
• If the value is set to false: as long as the verification is still in pending state, the same code will be re-sent and the validity will be extended.
• The default behavior (if the parameter is left empty) is to keep existing session with same OTP.

This parameter is not mandatory.

• It defines the API behavior when it comes to multiple requests to send a code to the same destination phone number during the validity time of a verification process.
• This value represents seconds.
• If the value is specified, the system will compare the timing of the current request with the last one for the same destination number. If the time difference between the two is less then resending interval, the OTP request will not be re-sent to the customer and the API will throw a 403 (forbidden) error.
• The value should be greater or equal to 10 and less or equal to 7200.
• The default value is 10

Possible values: >= 10 and <= 7200

This parameter is not mandatory.

• It defines the Webhook URL where status of verification attempts will be posted.

sms object

call object

whatsapp object

Optional parameter.

• For OTP-based channels, this value is used to apply rate limiting based on the client IP address.
• For the SMA channel, this value may be used to immediately validate the request when the IP address belongs to a supported mobile network gateway.
• If the request is forwarded by one or more proxies, you should extract the original client IP from the X-Forwarded-For header and provide it in this field.
• Refer to IP Spoofing for additional details.