Participant APIs | REST

Refresh Cache
Selected Version:
Download Open API Specification

Submit out-of-band(SMS) token for verification

https://qa.api.wealthcare.com/participant/securelogon/oobsmsauthenticate/{user}

This endpoint allows you to submit an out-of-band (SMS) token for user verification during the secure logon process. It is typically used to confirm the identity of a user attempting to access their account.

Request

  • user string Required

    User Name

  • token string Required

    The out-of-band (SMS) token sent to the user's registered phone number. This token is required for verification and must match the token sent to the user.

Response

  • Status string

    The method returns 0 to indicate success and 1 to indicate failure.

  • ErrCode string

    The error code returned by RSA indicating the result of the request. A blank value indicates success, and "FAIL" indicates failure.

  • ErrDesc string

    Provides a description of the issue that occurred during processing.

  • AccessToken string

    An MFA confirmed access token is returned when the MFA check is passed. Use this token when accessing MFA protected APIs. If the MFA check fails, this field is null.

  • RefreshToken string

    A long-lived credential used to obtain a new access token after the original access token expires. If the MFA check fails, this field is null.

  • ExpiresIn int

    An integer value representing the lifetime of the access token in seconds.

  • TokenType string

    Indicates the type of token issued.

AI Assistant Preview

Generating response...