OAuth2

Start OAuth2 web flow

Initiates the OAuth2 authorization flow. Redirects the user to Mercury's consent page.

get/oauth2/auth

Request

  • Base URL
    https://oauth2.mercury.com
  • URL
    https://oauth2.mercury.com/oauth2/auth
  • Auth
    none declared

Query parameters

client_idstring required

The client ID you received from Mercury when you registered the client.

redirect_uristring required

The URL in your application where users will be sent after authorization. Must match one of the URLs registered with the client.

scopestring required

A space-separated list of scopes that your client requests.

statestring

An unguessable random string, at least 8 characters long, used to protect against cross-site request forgery attacks.

response_typestring required

Tells the authorization server which type of grant to execute. Must have value "code".

code_challengestring

Required for clients with PKCE flow. Base64-URL-encoded string of the SHA256 hash of the code verifier.

code_challenge_methodstring

Required for clients with PKCE flow. Must have value S256, the SHA256 function used to hash the code challenge.

Changes

No recorded changes to this operation across all 1 revision of this API.