Connection Status Guide

The “Get Company Utility Account Connections” and “Get Utility Account Connection Details” endpoints include status related fields for the Connection and Account objects.

Connection

…

• status: String / ConnectionStatusUpdateEnum
  • “The current status for the connection”
• statusLastUpdateTime: Datetime
  • “When we recorded this status”
• statusFirstSeenTime: Datetime
  • “When did we initially set this status”
• statusErrorDetail: String
  • “Relevant details if it’s an error status”
  
  

Account

…

• status: String / AccountStatusUpdateEnum
  • “The current status for the account”
• statusLastUpdateTime: Datetime
  • “When we recorded this status”
• statusFirstSeenTime: Datetime
  • “When did we initially set this status”
• statusErrorDetail: String
  • “Relevant details if it’s an error status”

ConnectionStatusUpdate options:

• Standard Statuses Pending: “The connection is new, but has not been onboarded yet” Under Investigation: “Something has gone wrong and we are investigating the issue” Connected: “We are able to log in and access the connection”
• Error Statuses
  • Website issue Website Down: “The connection’s website is inaccessible” No Accounts Found: “We are able to login into the website, but no accounts were available” Other Error: “Some other issue not covered by an existing status”
  • Needs customer intervention MFA Token Expired: “There was an issue related to MFA” Password Incorrect: “The connection password is incorrect” New Password Needed: “The website requires us to create a new password” Additional Credentials Needed: “The website requires additional information”

AccountStatusUpdate options:

• Standard Statuses Needs Pull: “It has been a week since data was last pulled for this account, and we will pull data soon” Onboarding: “We have initialized the account” Waiting Confirmation: “We have the initial details for an account, and are waiting for confirmation” Pull In Progress: “We are actively pulling data for this account” Pull Uploaded: “We have pulled data for this account, and it is now being processed by our system” Pull Completed:“The data has been successfully pulled and parsed”
• Error Statuses No Documents Found: “No documents found for this account” PDF Download Failed: “Documents were available for this account, but there was an issue downloading them” Account Not Found: “We were unable to locate this account in the connection’s website” Workflow Not Accessible: “There was a larger issue with the connection. E.g. Password Incorrect” Other Error: “Some other issue not covered by an existing status”
• Terminal Statuses Old Account: “This account has been closed and will not have any new data moving forward” Duplicate: “This account is a duplicate of a different account” Customer Not Tracked: “The client has elected not to track this account”
  

Next Expected Check:

We check every connection weekly except for accounts with a terminal status, or connections with a status that indicates we need additional information: Password Incorrect New Password Needed Additional Credentials Needed MFA Token Expired

In all other scenarios, you can expect an update within at most 7 days from the last status update.