Skip to main content
Argyle Link can be embedded in your application or launched as a hosted session URL. Choose the frontend integration based on where Link will run, then choose the authentication path based on the backend workflow your implementation uses.

​
Choose how to integrate

Web SDK

Embed Link in a browser with the Web SDK.

Mobile SDKs

Embed Link with the iOS, Android, React Native, or Flutter SDKs.

Hosted Link

Launch a session URL directly in a browser or secure mobile browser context.

​
Choose an authentication path

The backend workflow determines which value your frontend uses to start Link. For direct embedded Link implementations, create a new user or refresh an existing user’s token on your server, then initialize embedded Link with the returned user_token. For verification implementations, create a session via POST /v2/sessions. The response includes a link URL. For payroll sessions, pass that URL as connectUrl in an embedded Link SDK initialization, or launch it directly as Hosted Link. For banking sessions, pass the URL via the banking SDK as connectURL.
User tokens and session links both expire after one hour. Create a fresh user token before initializing Link with userToken, or create a new session link for an active verification before initializing Link with connectUrl, launching Hosted Link, or launching the banking SDK.

​
Required initialization parameters

Use either the connectUrl path or the userToken path. Do not pass both in the same Link initialization.

​
Optional initialization parameters

flowId, items, and language can also be provided in the verification session request.
Flow IDs are not environment-specific: the same Flow ID applies consistent behavior across both Sandbox and Production.
ParameterTypeDescription
flowIdstringID used to customize the Link flow. Saved Flow IDs can be found in the Flows section of Console.
itemsarray of stringsLimits Link to the provided Items. Providing one Item skips Link search and opens that Item’s login screen. Providing multiple Items shows only those Items.
accountIdstringUsed for direct logins to an account that the user has previously connected or attempted to connect.
<Callback Name>stringCallbacks are activated by specific events in embedded Link, such as account connection, errors, closure, and token expiration. Hosted Link does not support callbacks.
languagestringSets the display language in Link.
  • EN and ES are available across all platforms and employers
  • RU and ZH currently limited to gig platforms
  • Can be used in combination with other optional initialization parameters including flowId
  • Certain platform-generated messages, such as multi-factor authentication prompts, will be shown as-received and depend on the user’s language preferences selected within their platform’s settings.
  • In Console, you can test Spanish in Sandbox mode by changing the Language dropdown when previewing an Embedded Experiences Link Flow.
Possible values: EN (English), ES (Spanish), RU (Russian), ZH (Chinese).
*Flutter uses lowercase en, es, ru, zh.

​
Next steps

  • Use Web SDK for browser-based embedded Link.
  • Use Mobile SDKs for native or cross-platform mobile SDK setup.
  • Use Hosted Link when you want to launch a session URL directly.