Retrieve Linking Details

Retrieve the linking instructions for embedding in a UI to launch account linking from providers such as MX or Plaid.

SecurityOAuth2: OAuth2Flow

Request

required

string

Counterparty ID

Authorization	string OAuth bearer token (see authentication flows)
x-l2f-request-id	string Optional Unique ID per request, useful for fault resolution/diagnosis and audit.
x-l2f-idempotency-id	string Unique ID used to safely retry an operation. See idempotency section for more details.

linking_provider required	string The provider for which linking instructions are required. At present only MX is supported MX
is_mobile_webview required	boolean Renders the widget in a mobile WebView. Executes URL updates in place of the JavaScript event postMessages.
ui_message_webview_url_scheme required	string Used as a redirect destination at the end of OAuth,

Responses

200

Success

400

Bad Request

401

Unauthorized

404

Not Found

500

Internal Error

post/v1/counterparties/{id}/link/details

Request samples

application/json

{"linking_provider": "MX",
"is_mobile_webview": true,
"ui_message_webview_url_scheme": "string"
}

Response samples

application/json

{"linking_provider": "MX",
"is_mobile_webview": true,
"ui_message_webview_url_scheme": "string",
"mx_widget_url": "string"
}