Skip to main content

         This documentation site is for previous versions. Visit our new documentation site for current releases.      

Verifying a one-time password by calling an API

Updated on June 30, 2021

You can verify a one-time password by calling an API. Use this method to verify a one-time password from an external system or if your application is running on a Pega Platform version earlier than 7.3.

Before you begin: Complete the Generating a one-time password procedure.
  1. Create a REST Connector by using the REST integration wizard.

    For more information about how to configure the connector, see Creating a REST integration.

  2. In the Endpoint URL field, enter the authenticate/one-time password web service on your server instance.
    For example: https://localhost:9090/prweb/PRRestService/api/v1/authenticate/otp/verify
  3. Select the GET method to invoke the external REST service.
  4. Click Override to add query parameters.
  5. Enter the Reference ID and OTPValue parameters.

    The Reference ID is returned by the pxSendOTP activity.

    The OTPValue is the one-time password entered by the user.

  6. Add a REST service, and enter query string parameter values for the Reference ID and OTPValue parameters.
  7. Click Submit.

Have a question? Get answers now.

Visit the Support Center to ask questions, engage in discussions, share ideas, and help others.

Did you find this content helpful?

Want to help us improve this content?

We'd prefer it if you saw us at our best. is not optimized for Internet Explorer. For the optimal experience, please use:

Close Deprecation Notice
Contact us