Get embedded flow configuration

Request

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.

Security

UserToken

Path

embeddedLinkRequestIdstring, (uuid)required

The embedded link request ID.

Example:ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198

X-External-Correlation-Idstring, (uuid), <= 36 characters

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

Example:f47ac10b-58cc-4372-a567-0e02b2c3d479

curl -i -X GET \
  https://api.wise.com/2026Q3/embedded-flows/link-requests/ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198 \
  -H 'Authorization: Bearer <YOUR_JWT_HERE>' \
  -H 'X-External-Correlation-Id: f47ac10b-58cc-4372-a567-0e02b2c3d479'

Responses

Embedded link request found.

Headers

X-External-Correlation-Idstring, (uuid), <= 36 characters

Echoed back when X-External-Correlation-Id was included in the request. Learn more.

Example:"f47ac10b-58cc-4372-a567-0e02b2c3d479"

x-trace-idstring

Unique trace identifier assigned by Wise. Useful when contacting support about a specific request.

Example:"fba501b6d453b96789f52338f019341f"

Bodyapplication/json

idstring, (uuid)required

Embedded link request ID.

Example:"ea5eb6ca-3af7-4e88-a2e2-6a68dd92f198"

profileIdinteger, (int64)required

Profile that owns the embedded flow.

Example:12345

typestringrequired

Embedded Flow type.

Enum:"RECIPIENT""KYC"

Example:"RECIPIENT"

clientKeystringrequired

Client key that created the embedded link request.

Example:"partner-client-key"

metadataobjectrequired

Flow-specific metadata.

redirectUrlstring, (uri)required

URL where Wise redirects the user after the flow resolves.

Example:"https://example.com/return"

Response

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