linkToken

Create

Creates a link token to be used when linking a new end user. The link token expires after single use.

post/filestorage/v1/link-token

Request

  • Base URL: https://api.merge.dev/api
  • URL: https://api.merge.dev/api/filestorage/v1/link-token
  • Auth: HTTP bearer

Request body

end_user_email_addressstring required

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_namestring required

Your end user's organization.

end_user_origin_idstring required

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.

categoriesCategoriesEnum[] required

The integration categories to show in Merge Link.

integrationstring nullable

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_minsinteger

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_urlboolean nullable

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_linkboolean nullable

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.

category_common_model_scopesobject nullable

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'en' | 'de'
are_syncs_disabledboolean nullable

The boolean that indicates whether initial, periodic, and force syncs will be disabled.

integration_specific_configobject nullable

A JSON object containing integration-specific configuration options.

completed_account_initial_screen'SELECTIVE_SYNC'
linked_destination_idstring uuid nullable

The UUID of the linked destination that you want this Linked Account to be tied to.

credential_idstring uuid nullable

The id of the credential that you want this Linked Account to be tied to.

ekm_enabledboolean

Whether to enable EKM (External Key Management) for this Linked Account.

Response

link_tokenstring required
integration_namestring
magic_link_urlstring

Changes

No recorded changes to this operation across all 1 revision of this API.