Applies To:

GroupID 9 and above


GroupID requires an SMS gateway account to:

  • dispatch verification codes to the registered mobile phone users for enrollment and authentication.
  • send new passwords and password reset links to the users' mobile numbers.

For authentication, verification codes are sent on the following events:

  • Multi-factor Authentication
    When users choose SMS Verification to authenticate on the Password Center user portal and perform password-related operations.
  • Second Way Authentication (SWA)
    When unenrolled users rely on SMS Verification for one-time access to the Password Center user portal.
  • Second Factor Authentication
    When users choose SMS Verification to authenticate on any GroupID client and access the application.

SMS Verification requires an SMS gateway account to send verification codes to the users' mobile numbers. Users have to enter those codes in GroupID to authenticate.

Supported SMS Gateways:

GroupID supports the following SMS gateways:

  • Cdyne
  • Esendex
  • Message Media
  • Nexmo
  • RedOxygen

You can create accounts for these SMS gateways and link them to identity stores. You can also integrate with an SMS gateway that is not in the list by using the Custom Gateway API.

You can specify a default SMS gateway account, which will automatically be linked to each new identity store created thereafter. 

Add a New SMS Gateway Account

  1. In GroupID Management Console, click the Identity Stores node.
  2. In the Actions pane, click New SMS Gateway Account.
  3. On the New SMS Gateway Account dialog box, enter a name for the account in the Name box.
  4. From the Gateway Type list, select an SMS gateway provider.
    This list includes the gateways that GroupID supports and any custom SMS gateways that you have written yourself.
    Selecting a gateway updates the gateway URL, which is the address of the web service that the selected SMS gateway uses for sending text messages. The URL for the Message Media gateway, however, is blank, because it employs a different transmission mechanism.
  5. Enter information for the following fields:
    • Account ID - your account ID (if required) for the selected gateway type.
    • User Name - the user name that the gateway provider assigned to you.
    • Password - the password for the user name above.
    • Description - a brief description of the gateway account (optional).
  6. If you want to communicate with the SMS gateway through a proxy server, click the Advanced View link in the top right corner. Some additional fields for entering proxy settings are displayed:
    • Proxy User Name - the proxy user name, if required by the proxy server.
    • Proxy Password - the password for the proxy user name above.
    • Proxy Domain - the domain name or IP address of the proxy server.
    • Proxy Host Name - the host name of the proxy server.
    • Proxy Port - the port number the proxy uses.

  7. To test the new SMS gateway account:
    • Click Test Connection.
    • In the Test SMS Gateway Connection dialog box, enter a mobile phone number for receiving the test message.
      Use International format, with no spaces or special characters. For example, 18588123169, 447079692712, and 923225867987.
    • Click OK to dispatch the message to the provided phone number.
  8. Click OK to close the dialog box.

Set an SMS Gateway Account as the Default Account:

  1. In GroupID Management Console, click the Identity Stores node.
  2. On the SMS Gateway Accounts tab, right-click the required SMS gateway account and click Properties.
  3. On the Update SMS Gateway Account dialog box, select the Set as default account check box.
  4. Click OK
    Until changed, this account will be linked to each identity store created from this point forward.


GroupID Online Help topic: SMS Gateway – Overview