v5

latestOpenAPI 3.1.02026-07-262421791.5 MB

link-requests

Get embedded flow configuration

Retrieves an Embedded Flow configuration by embedded link request ID. Typically this is not needed to be called as its used by the flow itself.

Embedded Flows uses this endpoint to load the configuration for a previously created link request. For an example flow, see the Embedded Flows guide.

get/2026Q2/embedded-flows/link-requests/{embeddedLinkRequestId}

Path parameters

embeddedLinkRequestIdstring uuid required

The embedded link request ID.

Headers

X-External-Correlation-Idstring uuid

Optional UUID for correlating requests across systems. If provided, Wise echoes it back in the response. Maximum 36 characters. Learn more.

Response

Embedded link request found.

idstring uuid required

Embedded link request ID.

profileIdinteger required

Profile that owns the embedded flow.

type'RECIPIENT' | 'KYC' required

Embedded Flow type.

clientKeystring required

Client key that created the embedded link request.

redirectUrlstring uri required

URL where Wise redirects the user after the flow resolves.

Example response

{
  "id": "ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198",
  "profileId": 12345,
  "type": "RECIPIENT",
  "clientKey": "partner-client-key",
  "metadata": {
    "targetCurrency": "USD"
  },
  "redirectUrl": "https://example.com/return"
}