Sign in
latestSwagger 2.02026-08-20196638916.1 KB

23d8982b533d

General.Tink Link.Builder

Build a Tink Link

This endpoint lets you create a Tink Link for any product, including user and session generation within one call.

post/link/v1/service/builder

Headers

authorizationstring required

Request body

appUristring uri

The deep link for an Android or iOS hosting app. Use when Tink Link is embedded in an Android/iOS app to redirect the user back to the hosting app after authenticating in a third-party app (such as Mobile Bank ID).

autoRedirectMobileboolean

Use for Android or iOS integrations. When TRUE, this will directly open the bank app during the authentication step if installed on the user's device or otherwise fall back to a web-based authentication flow in the system's default browser.

externalReferencestring

External reference forwarded to Tink Link as external_reference. This is distinct from sessionConfig.externalReference, which is used when creating a Link session.

financialInstitutionIdstring

Identifier of the financial institution to preselect, otherwise the user will be presented with a list of financial institutions.

iframeboolean

Set to true to make the response message sent via postMessage to the parent window. Use when Tink Link is embedded in an iframe.

iframeBehaviour'PARENT_REDIRECT' | 'POPUP'

Iframe behaviour (PARENT_REDIRECT, POPUP). Defaults to POPUP if iframe is true.

inputProviderstring

The unique name of the provider (ex: sbab-bankid). If provided, user can skip provider selection. Otherwise, they will choose the provider from a list in the Tink UI.

locale'cs_CZ' | 'da_DK' | 'de_DE' | 'en_US' | 'et_EE' | 'es_ES' | 'fi_FI' | 'fr_FR' | 'it_IT' | 'lt_LT' | 'lv_LV' | 'nl_NL' | 'no_NO' | 'pt_PT' | 'pl_PL' | 'sv_SE' required

The Locale to use, will influence the language in Tink Link.

market'AT' | 'BE' | 'BG' | 'BR' | 'CA' | 'CH' | 'CY' | 'CZ' | 'DE' | 'DK' | 'EE' | 'ES' | 'FI' | 'FO' | 'FR' | 'GB' | 'GR' | 'IE' | 'IT' | 'LT' | 'LV' | 'MT' | 'MX' | 'NL' | 'NO' | 'PL' | 'PT' | 'RO' | 'SE' | 'SG' | 'SK' | 'US' required

The Market to use for the Tink Link.

productDimension'direct' | 'credentials' | 'bulk' | 'vrp-mandate' | 'vrp-mandate-pickup' | 'cancellation' | 'vrp' | 'connect' | 'create-report' | 'update-consent' | 'extend-consent' | 'add' | 'refresh' | 'authenticate' | 'connect-accounts' | 'add-accounts'

The product dimension part of the Tink Link, e.g. "create-report". Has to be compatible with the product type. Optional for productType 'account-check' (defaults to 'create-report'), 'authorize' (defaults to 'connect'), and 'pay' (defaults to 'direct').

Available when productType is authorize. Allowed values: connect.

Available when productType is pay. Allowed values: direct, credentials, bulk, vrp-mandate, vrp-mandate-pickup, cancellation.

Available when productType is credentials. Allowed values: add, refresh, authenticate, extend-consent.

Available when productType is account-check. Allowed values: create-report, update-consent, extend-consent, connect.

Available when productType is business-account-check. Allowed values: create-report, extend-consent.

Available when productType is income-check. Allowed values: connect, create-report.

Available when productType is transactions. Allowed values: update-consent, connect-accounts, extend-consent, add-accounts.

Available when productType is business-transactions. Allowed values: update-consent, connect-accounts, extend-consent, add-accounts.

Available when productType is reports. Allowed values: create-report.

Available when productType is risk-insights. Allowed values: create-report.

Available when productType is expense-check. Allowed values: create-report.

Available when productType is products. Allowed values: update-consent, connect-accounts, extend-consent.

productType'authorize' | 'pay' | 'payment-mandate' | 'credentials' | 'account-check' | 'business-account-check' | 'income-check' | 'transactions' | 'business-transactions' | 'reports' | 'risk-insights' | 'expense-check' | 'products' required

The product type part of the Tink link, e.g. "account-check". Has to be compatible with the product dimension.

redirectUristring uri required

The URL Tink Link should redirect to after.

statestring

State parameter to be attached to the Tink Link.

theme'LIGHT' | 'DARK'

Specifying LIGHT or DARK overrides the user's system preference and displays the specified theme. Requires both themes to be configured to have any effect.

Response

Successful response

tinkLinkstring uri