Generate OAuth window URI

This endpoint will generate an oauth_window_uri for the specified member. Generating a new oauth_window_uri is necessary in order to send the end user through the OAuth process again. There are several situations where you might want to do this, like if a previous attempt at OAuth failed because the end user closed the OAuth window before completing the process, or the financial institution has revoked a previous OAuth token, or the token has expired.

The member in question must be connected to an institution which supports OAuth. If the institution does not support OAuth, a 400 Bad Request error will be returned with the message Member cannot use OAuth.

GET

/members/{member_guid}/oauth_window_uri

Path Parameters

Field	Required	Type
member_guid The unique identifier for the member. Defined by MX.	Required	String

Query Parameters

Field	Required	Type
client_redirect_url A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with oauth_referral_source as APP or is_mobile_webview as true.	Optional	String
referral_source Must be either BROWSER or APP depending on the implementation. Defaults to BROWSER.	Optional	String
ui_message_webview_url_scheme A scheme for routing the user back to the application state they were previously in.	Optional	String
skip_aggregation Setting this parameter to true will prevent the member from automatically aggregating after being redirected from the authorization page.	Optional	String

Loading...