Introduction
Data security is a top priority at Merge, and we know it is for you as well! Scopes provide precise control over data, ensuring that only relevant Common Models and fields are synced by Merge.
Below, you’ll find features and endpoints relevant to two levels of Scopes:
Default Scopes apply to all new Linked Accounts within a given category.
Linked Account Scopes apply only to a specific end user (Linked Account).
The Scopes applied to a Linked Account are determined first by the Linked Account Scopes, with Default Scopes serving as a fallback for any that haven’t been set.
How do Scopes work?
Checking Scopes
You can check the Scopes tab in your Merge Dashboard to see the various access levels for each Common Model and field.
Adjusting Scopes
If you want to adjust the Scopes for a model, first switch the toggle on the top right from "Viewing" to "Editing".
Pricing: All Merge users will have access to Common Model Scopes.
Only Professional & Enterprise plan users can edit field level Scopes.
Disabling Scopes
Fully disabling a Common Model Scope will also disable all its associated fields. Disabled Scopes mean that Merge will no longer store any data for those models and fields. However, depending on the integration's configuration, we may still need to make requests to fetch that data. For example, if an integration returns data for multiple Common Models through a single endpoint, we will need to call that endpoint if another corresponding Common Model remains enabled.
We have an additional feature, "Redact Unmapped Data," available for enhanced data minimization. You can learn more about it here.
Enabling Scopes
By default, Merge only syncs data that has changed since the last sync.
However, when you enable a new Scope, a full sync will occur. During this sync, Merge will fetch all items from your Linked Accounts, regardless of the date of the last change. This process ensures that previously disabled fields for all items are populated. Depending on the amount of data being synced and the rate limits set by our integration partners, this sync may take longer than a regular sync. You can continue to work with your account data while the sync is in progress, but the newly added data will not be available for all items until the sync is complete.
Auto-disabled Scopes
Common Models will be automatically disabled after 90 days of inactivity, meaning no API requests have been made to the respective Common Model or field.
Linked Account Scopes
Default scopes for an organization can be overridden per Linked Account in our Dashboard under each Linked Account or via API.
New Linked Accounts will follow the default Scopes set per category unless you explicitly override those preferences on a per Linked Account basis. Once you override a Linked Account Scopes it will be overridden unless you "reset to org default".
Enterprise plan features
The following Scopes features, Scopes via API and User Configurable Scopes, are only available to users on the Enterprise plan.
User Configurable Scopes
To give your users control over their Scopes during the linking flow, simply mark the model or field as optional in the Dashboard. Models and fields marked as optional will be enabled by default but can be disabled by your users before connecting.
Scopes via API
You can configure scopes programmatically using our API before or after your customer links. For more information, please refer to our API documentation.
Before linking: POST /link-token
After linking: POST /linked-account-scopes