Sign in
mx_platform

Request widget url

This endpoint allows partners to get a URL by passing the widget_type in the request body, as well as configuring it in several different ways. In the case of Connect, that means setting the widget_type to connect_widget. Partners may also pass an optional Accept-Language header as well as a number of configuration options. Note that this is a POST request.

post/users/{user_guid}/widget_urls

Path parameters

user_guidstring required

The unique id for a user.

Headers

Accept-Languagestring

The desired language of the widget.

Request body

Example request

{
  "widget_url": {
    "client_redirect_url": "https://mx.com",
    "color_scheme": "light",
    "current_institution_code": "chase",
    "current_institution_guid": "INS-f1a3285d-e855-b61f-6aa7-8ae575c0e0e9",
    "current_member_guid": "MBR-7c6f361b-e582-15b6-60c0-358f12466b4b",
    "include_transactions": true,
    "insight_guid": "BET-123",
    "microwidget_instance_id": "accounts_page",
    "mode": "aggregation",
    "oauth_referral_source": "BROWSER",
    "ui_message_version": 4,
    "ui_message_webview_url_scheme": "mx",
    "widget_type": "connect_widget"
  }
}

Response

OK

Changes