All Collections
Linked Account Management
Linked Account Statuses and the /account-details Endpoint
Linked Account Statuses and the /account-details Endpoint

Reference the "status" field in the GET /account-details endpoint to know whether an account is successfully linked

Pritak Patel avatar
Written by Pritak Patel
Updated over a week ago

What does the "status" field correspond to in the GET /account-details endpoint?

You can send a GET request to the /account-details endpoint to receive general details for a linked account. To find out if an account successfully linked (as opposed to knowing if it successfully synced), you can reference the "status" field in this request. There are three possible statuses you can get back in this field:

  1. COMPLETE is returned when the account is successfully linked!

  2. INCOMPLETE is returned when the account cannot be successfully linked, which usually happens when permissions are invalid or some aspect of the authentication details were entered incorrectly.

  3. RELINK_NEEDED is returned when the authentication expires, which means you need to re-enter your account credentials in the linking flow. This status will not resolve on its own unless you re-enter the credentials.

You can view a sample response for the full endpoint in our Developer Docs.

Related Articles:

Did this answer your question?