/link-token
Creates a link token to be used when linking a new end user.
Authentication
AuthorizationBearer
Token-based authentication with required prefix “Bearer”
Request
This endpoint expects an object.
end_user_email_address
Your end user’s email address. This is purely for identification purposes - setting this value will not cause any emails to be sent.
end_user_organization_name
Your end user's organization.
end_user_origin_id
This unique identifier typically represents the ID for your end user in your product's database. This value must be distinct from other Linked Accounts' unique identifiers.
categories
The integration categories to show in Merge Link.
integration
The slug of a specific pre-selected integration for this linking flow token. For examples of slugs, see https://docs.merge.dev/guides/merge-link/single-integration/.
link_expiry_mins
An integer number of minutes between [30, 720 or 10080 if for a Magic Link URL] for how long this token is valid. Defaults to 30.
should_create_magic_link_url
Whether to generate a Magic Link URL. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
hide_admin_magic_link
Whether to generate a Magic Link URL on the Admin Needed screen during the linking flow. Defaults to false. For more information on Magic Link, see https://merge.dev/blog/integrations-fast-say-hello-to-magic-link.
common_models
An array of objects to specify the models and fields that will be disabled for a given Linked Account. Each object uses model_id, enabled_actions, and disabled_fields to specify the model, method, and fields that are scoped for a given Linked Account.
category_common_model_scopes
When creating a Link Token, you can set permissions for Common Models that will apply to the account that is going to be linked. Any model or field not specified in link token payload will default to existing settings.
language
The following subset of IETF language tags can be used to configure localization.
* `en` - en
* `de` - de
Allowed values:
are_syncs_disabled
The boolean that indicates whether initial, periodic, and force syncs will be disabled.
integration_specific_config
A JSON object containing integration-specific configuration options.
completed_account_initial_screen
When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
* `SELECTIVE_SYNC` - SELECTIVE_SYNC
Allowed values:
linked_destination_id
The UUID of the linked destination that you want this Linked Account to be tied to.
credential_id
The id of the credential that you want this Linked Account to be tied to.
Response
link_token
integration_name
magic_link_url