Creates a link token to be used when linking a new end user. The link token expires after single use.
This endpoint expects an object.
end_user_email_addressstringRequired1-100 characters
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_namestringRequired1-100 characters
Your end user's organization.
end_user_origin_idstringRequired1-100 characters
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.
categorieslist of enumsRequired
The integration categories to show in Merge Link.
integrationstring or nullOptional>=1 character
link_expiry_minsintegerOptional30-10080Defaults to 30
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 or nullOptionalDefaults to false
hide_admin_magic_linkboolean or nullOptionalDefaults to false
common_modelslist of objects or nullOptional
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_scopesmap from strings to lists of objects or nullOptional
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.
languageenum or nullOptional
The following subset of IETF language tags can be used to configure localization.
are_syncs_disabledboolean or nullOptionalDefaults to false
The boolean that indicates whether initial, periodic, and force syncs will be disabled.
integration_specific_configmap from strings to any or nullOptional
A JSON object containing integration-specific configuration options.
completed_account_initial_screenenum or nullOptional
When creating a Link token, you can specifiy the initial screen of Linking Flow for a completed Linked Account.
linked_destination_idstring or nullOptionalformat: "uuid"
The UUID of the linked destination that you want this Linked Account to be tied to.
credential_idstring or nullOptionalformat: "uuid"
The id of the credential that you want this Linked Account to be tied to.
ekm_enabledbooleanOptionalDefaults to false
Whether to enable EKM (External Key Management) for this Linked Account.
Response
integration_namestringOptional
magic_link_urlstringOptional
