Skip to main content
GET
Request oauth window uri

Authorizations

Authorization
string
header
required

Basic authentication header of the form Basic <encoded-value>, where <encoded-value> is the base64-encoded string username:password.

Path Parameters

member_guid
string
required

The unique id for a member.

user_guid
string
required

The unique identifier for a user, beginning with the prefix USR-.

Query Parameters

client_redirect_url
string

A URL that MX will redirect to at the end of OAuth with additional query parameters. Only available with referral_source=APP.

enable_app2app
string

This indicates whether OAuth app2app behavior is enabled for institutions that support it. Defaults to true. When set to false, any oauth_window_uri generated will not direct the end user to the institution's mobile application. This setting is not persistent. This setting currently only affects Chase institutions.

referral_source
string

Must be either BROWSER or APP depending on the implementation. Defaults to BROWSER.

skip_aggregation
boolean

Setting this parameter to true will prevent the member from automatically aggregating after being redirected from the authorization page.

ui_message_webview_url_scheme
string

A scheme for routing the user back to the application state they were previously in. Only available with referral_source=APP.

Response

200 - application/vnd.mx.api.v1+json

OK

member
object