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.Documentation Index
Fetch the complete documentation index at: https://docs.argyle.com/llms.txt
Use this file to discover all available pages before exploring further.
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.| Backend workflow | Frontend value | Use with |
|---|---|---|
| Direct embedded Link | userToken and sandbox | Web SDK or Mobile SDKs |
| Verifications API session | Session link used as connectUrl | Web SDK or Mobile SDKs |
| Verifications API session | Session link launched directly | Hosted Link |
user_token.
For verification implementations, create a session via POST /v2/sessions. The response includes a link URL. Use that same URL either as connectUrl in an embedded SDK initialization, or launch it directly as Hosted Link.
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 or launching Hosted Link.Required initialization parameters
Use either theconnectUrl path or the userToken path. Do not pass both in the same Link initialization.
| Parameter | Type | Required when | Description |
|---|---|---|---|
connectUrl | string | Initializing embedded Link from a verification session | The session link URL returned when creating a session. Link’s environment is encoded in the URL and does not need to be set with sandbox. |
userToken | string | Initializing embedded Link through the user token flow | Token used to identify and authenticate users. See User Tokens. |
sandbox | boolean | Initializing embedded Link through the user token flow | Determines Link’s environment: true for Sandbox, false for Production. |
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.
| Parameter | Type | Description |
|---|---|---|
flowId | string | ID used to customize the Link flow. Saved Flow IDs can be found in the Flows section of Console. |
items | array of strings | Limits 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. |
accountId | string | Used for direct logins to an account that the user has previously connected or attempted to connect. |
<Callback Name> | string | Callbacks are activated by specific events in embedded Link, such as account connection, errors, closure, and token expiration. Hosted Link does not support callbacks. |
language | string | Sets the display language in Link.
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.