Request oauth window uri - MX Documentation

curl -L -X GET 'https://int-api.mx.com/users/:user_guid/members/:member_guid/oauth_window_uri' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

{
  "member": {
    "guid": "MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f",
    "oauth_window_uri": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2"
  }
}

GET

users

{user_guid}

members

{member_guid}

oauth_window_uri

curl -L -X GET 'https://int-api.mx.com/users/:user_guid/members/:member_guid/oauth_window_uri' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

{
  "member": {
    "guid": "MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f",
    "oauth_window_uri": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2"
  }
}

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

boolean

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.

curl -L -X GET 'https://int-api.mx.com/users/:user_guid/members/:member_guid/oauth_window_uri' \
-H 'Accept: application/vnd.mx.api.v1+json' \
-H 'Authorization: Basic BASE_64_ENCODING_OF{client_id:api_key}'

{
  "member": {
    "guid": "MBR-df96fd60-7122-4464-b3c2-ff11d8c74f6f",
    "oauth_window_uri": "https://mxbank.mx.com/oauth/authorize?client_id=b8OikQ4Ep3NuSUrQ13DdvFuwpNx-qqoAsJDVAQCyLkQ&redirect_uri=https%3A%2F%2Fint-app.moneydesktop.com%2Foauth%2Fredirect_from&response_type=code&scope=openid&state=d745bd4ee6f0f9c184757f574bcc2df2"
  }
}

(Deprecated) Request connect widget URL

Request widget URL

​Path Parameters

​Query Parameters

Path Parameters

Query Parameters