Introduction

Merge allows you to track issues with all linked accounts right from the Dashboard! This allows you to proactively address any errors that your customers might be facing.

What issues can I track?

Right now, we track the following issues:

• Bad API Key: Flagged when implementing API-Key-based authentication, and a user has entered an invalid API key

• Invalid Login Credentials: Flagged when implementing login-based authentication. We flag this error if a user has entered an invalid username and password for the system.

• Expired multi-factor authentication: The multi-factor authentication session has expired. Your end user will need to complete the MFA flow again by relinking.

• Missing permissions: Flagged if we’re able to obtain a valid API key, but insufficient permissions have been granted for the API key.

• API error: A general API error occurred during the sync. Check the error_details field for more specific information about what went wrong.

• Third-party offline: The third-party service is temporarily unavailable. These issues typically auto-resolve once the service is restored and a successful sync completes.

• Issue type pending: The system has detected an error but is still analyzing it to determine the specific issue type. This is a temporary state that will update to one of the above categories.

With our error details templates, you can send surface these as message to your customers in case they have the wrong credentials or permissions.

We typically resolve issues automatically on our end, but you can also click the Resolve Issue button manually if it's been resolved!

Recommendations

For authentication-related errors such as Bad API key, Invalid login credentials, or Expired multi-factor authentication, prompt your users to relink their account.

Each Linked Account has a status field. When you hit our /linked-accounts endpoint, you can look at this field to know when a Linked Account needs to be relinked and you can trigger relinking prompts to your users. There's a also status query param so you can filter for Linked Accounts in RELINK_NEEDED !

Additional Support

If there are issues that require additional assistance (i.e. null fields after resyncing, failed link errors), please reach out to Merge support ([email protected])!