LinkTokenCreateRequest defines the request schema for /link/token/create
| Name | Type | Description | Notes |
|---|---|---|---|
| client_name | str | The name of your application, as it should be displayed in Link. Maximum length of 30 characters. If a value longer than 30 characters is provided, Link will display "This Application" instead. | |
| language | str | The language that Link should be displayed in. When initializing with Identity Verification, this field is not used; for more details, see Identity Verification supported languages. Supported languages are: - Danish (`'da'`) - Dutch (`'nl'`) - English (`'en'`) - Estonian (`'et'`) - French (`'fr'`) - German (`'de'`) - Italian (`'it'`) - Latvian (`'lv'`) - Lithuanian (`'lt'`) - Norwegian (`'no'`) - Polish (`'pl'`) - Portuguese (`'pt'`) - Romanian (`'ro'`) - Spanish (`'es'`) - Swedish (`'sv'`) When using a Link customization, the language configured here must match the setting in the customization, or the customization will not be applied. | |
| country_codes | [CountryCode] | Specify an array of Plaid-supported country codes using the ISO-3166-1 alpha-2 country code standard. Institutions from all listed countries will be shown. For a complete mapping of supported products by country, see https://plaid.com/global/. If Link is launched with multiple country codes, only products that you are enabled for in all countries will be used by Link. Note that while all countries are enabled by default in Sandbox and Development, in Production only US and Canada are enabled by default. Access to European institutions requires additional compliance steps. To request access to European institutions in the Production environment, file a product access Support ticket via the Plaid dashboard. If you initialize with a European country code, your users will see the European consent panel during the Link flow. If using a Link customization, make sure the country codes in the customization match those specified in `country_codes`, or the customization may not be applied. If using the Auth features Instant Match, Same-day Micro-deposits, or Automated Micro-deposits, `country_codes` must be set to `['US']`. | |
| user | LinkTokenCreateRequestUser | ||
| client_id | str | Your Plaid API `client_id`. The `client_id` is required and may be provided either in the `PLAID-CLIENT-ID` header or as part of a request body. | [optional] |
| secret | str | Your Plaid API `secret`. The `secret` is required and may be provided either in the `PLAID-SECRET` header or as part of a request body. | [optional] |
| products | [Products] | List of Plaid product(s) you wish to use. If launching Link in update mode, should be omitted (unless you are using update mode to add Income or Assets to an Item); required otherwise. `balance` is not a valid value, the Balance product does not require explicit initialization and will automatically be initialized when any other product is initialized. The products specified here will determine which institutions will be available to your users in Link. Only institutions that support all requested products can be selected; a if a user attempts to select an institution that does not support a listed product, a "Connectivity not supported" error message will appear in Link. To maximize the number of institutions available, initialize Link with the minimal product set required for your use case. Additional products can be included via the `required_if_supported_products` field, or can be initialized by calling the endpoint after obtaining an access token. For details and exceptions, see Choosing when to initialize products. Note that, unless you have opted to disable Instant Match support, institutions that support Instant Match will also be shown in Link if `auth` is specified as a product, even though these institutions do not contain `auth` in their product array. In Production, you will be billed for each product that you specify when initializing Link. Note that a product cannot be removed from an Item once the Item has been initialized with that product. To stop billing on an Item for subscription-based products, such as Liabilities, Investments, and Transactions, remove the Item via `/item/remove`. | [optional] |
| additional_consented_products | [Products] | (Beta) This field has no effect unless you are participating in the Data Transparency beta program. List of additional Plaid product(s) you wish to collect consent for. These products will not be billed until you start using them by calling the relevant endpoints. `balance` is not a valid value, the Balance product does not require explicit initialization and will automatically have consent collected. Institutions that do not support these products will still be shown in Link | [optional] |
| required_if_supported_products | [Products] | List of Plaid product(s) you wish to use only if the institution and account(s) selected by the user support the product. Institutions that do not support these products will still be shown in Link. The products will only be extracted and billed if the user selects an institution and account type that supports them. There should be no overlap between `products` and `required_if_supported_products`. The `products` array must have at least one product. For more details on using this feature, see Required if Supported Products. | [optional] |
| webhook | str | The destination URL to which any webhooks should be sent. Note that webhooks for Payment Initiation (e-wallet transactions only), Transfer, Bank Transfer (including Auth micro-deposit notification webhooks) and Identity Verification are configured via the Dashboard instead. | [optional] |
| access_token | str | The `access_token` associated with the Item to update or reference, used when updating, modifying, or accessing an existing `access_token`. Used when launching Link in update mode, when completing the Same-day (manual) Micro-deposit flow, or (optionally) when initializing Link for a returning user as part of the Transfer UI flow. | [optional] |
| link_customization_name | str | The name of the Link customization from the Plaid Dashboard to be applied to Link. If not specified, the `default` customization will be used. When using a Link customization, the language in the customization must match the language selected via the `language` parameter, and the countries in the customization should match the country codes selected via `country_codes`. | [optional] |
| redirect_uri | str | A URI indicating the destination where a user should be forwarded after completing the Link flow; used to support OAuth authentication flows when launching Link in the browser or via a webview. The `redirect_uri` should not contain any query parameters. When used in Production or Development, must be an https URI. To specify any subdomain, use `` as a wildcard character, e.g. `https://.example.com/oauth.html`. Note that any redirect URI must also be added to the Allowed redirect URIs list in the developer dashboard. If initializing on Android, `android_package_name` must be specified instead and `redirect_uri` should be left blank. | [optional] |
| android_package_name | str | The name of your app's Android package. Required if using the `link_token` to initialize Link on Android. Any package name specified here must also be added to the Allowed Android package names setting on the developer dashboard. When creating a `link_token` for initializing Link on other platforms, `android_package_name` must be left blank and `redirect_uri` should be used instead. | [optional] |
| institution_data | LinkTokenCreateInstitutionData | [optional] | |
| account_filters | LinkTokenAccountFilters | [optional] | |
| eu_config | LinkTokenEUConfig | [optional] | |
| institution_id | str | Used for certain Europe-only configurations, as well as certain legacy use cases in other regions. | [optional] |
| payment_initiation | LinkTokenCreateRequestPaymentInitiation | [optional] | |
| deposit_switch | LinkTokenCreateRequestDepositSwitch | [optional] | |
| employment | LinkTokenCreateRequestEmployment | [optional] | |
| income_verification | LinkTokenCreateRequestIncomeVerification | [optional] | |
| auth | LinkTokenCreateRequestAuth | [optional] | |
| transfer | LinkTokenCreateRequestTransfer | [optional] | |
| update | LinkTokenCreateRequestUpdate | [optional] | |
| identity_verification | LinkTokenCreateRequestIdentityVerification | [optional] | |
| user_token | str | A user token generated using `/user/create`. Any Item created during the Link session will be associated with the user. | [optional] |
| investments | LinkTokenInvestments | [optional] | |
| investments_auth | LinkTokenInvestmentsAuth | [optional] | |
| any string name | bool, date, datetime, dict, float, int, list, str, none_type | any string name can be used but the value must be the correct type | [optional] |