WealthCare Access

Selected Version:
Download Open API File

Request an Access Token

https://beta.auth.wealthcare.com/connect/token

Exchanges client and grant credentials for an access token using the OAuth 2.0 token endpoint. Requests must be sent as application/x-www-form-urlencoded.

  • grant_type string

    OAuth 2.0 grant type being used. Common values include client_credentials, authorization_code, refresh_token, and password where supported.

  • scope string

    Space-delimited list of requested scopes.

  • client_id string

    OAuth client identifier.

  • client_secret string <password>

    OAuth client secret for confidential clients.

  • username string

    Resource owner username when using the password grant.

  • password string <password>

    Resource owner password when using the password grant.

  • refresh_token string

    Refresh token used to obtain a new access token.

  • code string

    Authorization code returned from the authorization endpoint.

  • redirect_uri string <uri>

    Redirect URI associated with the authorization code request.

  • code_verifier string

    PKCE code verifier for authorization code exchange.

Response

  • access_token string

    Issued access token.

  • token_type string

    Token type returned by the authorization server.

  • expires_in integer <int32>

    Lifetime of the access token in seconds.

  • scope string

    Space-delimited list of scopes granted to the token.

  • refresh_token string

    Refresh token issued with the access token, if applicable.

  • error string

    OAuth 2.0 error code.

  • error string

    OAuth 2.0 error code.

https://beta.auth.wealthcare.com/connect/token
OAuth 2.0 grant type being used. Common values include `client_credentials`, `authorization_code`, `refresh_token`, and `password` where supported.
Space-delimited list of requested scopes.
OAuth client identifier.
OAuth client secret for confidential clients.
Resource owner username when using the password grant.
Resource owner password when using the password grant.
Refresh token used to obtain a new access token.
Authorization code returned from the authorization endpoint.
Redirect URI associated with the authorization code request.
PKCE code verifier for authorization code exchange.

Response

Response Headers
No response yet.
Response Body
No response yet.
Request
Response
{
  "access_token": "eyJhbGciOi...",
  "token_type": "Bearer",
  "expires_in": 3600,
  "scope": "bensoft_api mbi_api offline_access",
  "refresh_token": "refresh-token-value"
}
{
  "error": "unsupported_grant_type"
}
{
  "error": "invalid_grant"
}
{
  "error": "invalid_client",
  "error_description": "Client authentication failed."
}

AI Assistant Preview

Generating response...