HomeGuidesAPI ReferenceChangelog
Log In
Guides

Status and Status Detail Descriptions

Definitions for possible statuses and status details in the Plug API.

Credentials

statusstatusDetailisCustomer ActionRequiredDescription
CONNECTION_SUCCESSLOGIN_AND_DATA_DISCOVERY_SUCCESSFULfalseArcadia was able to log into and discover data for the utility account.
CONNECTION_IN_PROGRESSPROVIDER_WEBSITE_INACCESSIBLEfalseArcadia was not able to access the provider website due to issues with the provider website.
-ISSUE_UNDER_REVIEWfalseArcadia discovered an issue while trying to access the utility website. The Arcadia team has started to investigate the issue and will update the status accordingly
-PROVIDER_WEBSITE_NAVIGATION_FAILUREfalseArcadia’s utility website navigation procedure has failed. The Arcadia team has started to investigate the issue and will update the status accordingly.
-UNSUPPORTED_CAPTCHAfalseArcadia’s CAPTCHA procedure has failed. The Arcadia team has started to investigate the issue and will update the status accordingly.
-EMAIL_APPROVALtrueArcadia has sent a request for ConEd account enrollment and is awaiting the end user confirmation. Data will be blocked until approval is given.
-DATA_EXTRACTION_IN_PROGRESSfalseArcadia has received credentials for a non-RTCV supported provider and is actively running jobs to validate them and fetch data.
CONNECTION_FAILUREINVALID_CREDENTIALStrueArcadia failed to login to the utility account due to incorrect credentials.

Please review and update the username and password for the credential.
-UNSUPPORTED_MULTI_FACTOR_AUTHENTICATIONtrueArcadia failed to login because Arcadia does not support multi-factor authentication.

You may be able to disable the multi-factor authentication requirement at login by configuring your utility account or reaching out to your provider.
-OTHER_ACCESS_LIMITATIONtrueArcadia is unable to proceed with logging into the account and/or extracting data due to a variety of reasons.

These reasons could include but are not limited to:

- The utility account is locked
- There are no usage activity displayed on the utility account
- E-billing needs to be enabled by the account
- The utility account holder needs to change the password

Accounts

statusstatusDetailisCustomer ActionRequiredDescription
CONNECTION_SUCCESSDATA_ACCESSIBLEfalseArcadia is able to successfully connect to the utility account and extract the latest statement data from the account.
CONNECTION_IN_PROGRESSISSUE_UNDER_REVIEWfalseArcadia was able to access the data from the utility website, however, we are not able to store the data in our systems. This could be due to the data failing our data quality audits or validations.

While the exact issue is unknown, our team has started looking into it and will update the status accordingly.
NEW_ACCOUNTNO_ACTION_REQUIREDfalseArcadia discovered a new account when checking for data associated with a credential. Note that this state is transient and will be updated the next time Arcadia checks for more data. This state is primarily intended to make it easier to process the scenario when new accounts are discovered. It is not related to the number of statements associated with an account.
DATA_ACCESS_FAILURECREDENTIAL_ISSUEtrueArcadia is unable to connect to the utility account due to an issue with the credentials provided.

Please refer to the status and status detail of the related credential for more details.
-NO_DATA_AVAILABLEtrueArcadia is able to access the utility account and there is no data for this specific account, though there was data for this account in the past.

Please check if there is data available for this specific account by logging into the utility provider website.
INACTIVENO_BILLS_DISCOVERED_AFTER_MOST_RECENT_NEXT_EXPECTED_POST_DATEfalseArcadia has not discovered a new bill for at least 45 days after the nextExpectedPostDate.
-NO_BILLS_DISCOVERED_AFTER_FINAL_BILL_NOTICEfalseArcadia does not expect to discover new bills for this account as it has received a Final Bill notice or has been marked as inactive on the utility provider website.

⚠️ Arcadia will treat an account as "finaled" if we see "final bill" explicitly written on the bill. If an account is finaled and the provide chooses to not communicate that on a bill, Arcadia would not be able to treat those accounts as "finaled" accounts.

Meters

statusstatusDetailisCustomerActionRequiredDescription
INTERVALS_NOT_REQUESTEDINTERVALS_EXTRACTION_NOT_REQUESTEDfalseInitial state, When intervals have not been activated
INTERVALS_IN_PROGRESSINTERVALS_EXTRACTION_IN_PROGRESSfalseIntervals activated
INTERVALS_SUCCESSINTERVALS_AVAILABLEfalseIntervals available up to a recent date
INTERVALS_FAILUREINVALID_CREDENTIALStrueCredentials not valid
ACCOUNT_INACCESSIBLEtrueUnable to access account
INTERVALS_ACCESS_ERRORfalseError in data collection, processing or delivery
UTILITY_SITE_ERRORfalseTransient error in data collection due to a site issue. Generally resolves itself in re-try
INTERVALS_NOT_SUPPORTEDSERVICE_TYPE_NOT_SUPPORTEDfalseMeter of an unsupported service type
PROVIDER_NOT_SUPPORTEDfalseProvider not supported for plug intervals
INTERVALS_NOT_PUBLISHEDfalseUtility has not provided intervals for the met

All statusDetails within the INTERVALS_NOT_SUPPORTED status are considered fatal errors. Arcadia will no longer check for new interval data for that meter. All statusDetails under INTERVALS_FAILURE are considered temporary errors which require either customer or Arcadia intervention to resolve. Currently, only the INTERVALS_ACCESS_ERROR is a statusDetail that will be resolved by Arcadia's internal teams.

Files

We will give you as much information as possible throughout the file processing journey through statuses and status details. For example, in addition to telling you that a file is in FAILURE status we will tell you all failure reasons applicable via the statusDetails field.

Possible status transitions

Possible status transitions diagram

Possible status transitions diagram

Descriptions

statusstatusDetailDescription
QUEUEDREADY_FOR_PROCESSINGArcadia has started processing the bill.
FAILUREPROVIDER_UNIDENTIFIABLEArcadia is not able to obtain the provider name from the bill.
SERVICE_TYPE_NOT_SUPPORTEDArcadia does not currently support the service type of the bill.
LANGUAGE_NOT_SUPPORTEDArcadia does not currently support the language of the bill.
REQUIRED_DATA_FIELDS_MISSINGArcadia is not able to obtain one or more required fields from the bill.
BILL_INSUFFICIENTLY_LEGIBLEArcadia is not able to read the bill. This could be due to the structure of the bill, image quality, or the uploaded bill containing multiple statements (or invoices).
TIMED_OUTArcadia was not able to process the bill within 2 weeks, therefore the bill is timed out.
IN_PROGRESSIDENTIFYING_PROVIDERArcadia was not able to automatically detect the provider. Our staff will try to identify the provider name from the bill.
BILL_ANOMALY_FLAGGEDArcadia has identified some anomalies on the bill and has started reviewing the bill to ensure accurate data extraction.
DATA_EXTRACTION_FAILURE_INVESTIGATION_STARTEDThe bill has failed automated data extraction. The bill will be reviewed for further processing.
DATA_AUDIT_FAILURE_INVESTIGATION_STARTEDThe bill has failed automated data quality audits. The bill will be reviewed for further processing.
COVERAGE_REQUESTREQUEST_CREATEDArcadia will develop an automated way to extract data from the bill.
IN_PROGRESSArcadia has started the development process for automating data extraction for the bill.
SUCCESSDATA_EXTRACTION_SUCCESSFULArcadia was able to extract data from the bill submitted

Download

statusDescription
SUCCESSThe requested download is ready.
PREPARINGThe requested download is being prepared. Arcadia will send a webhook and email to notify you when the download is ready.
FAILUREThe requested download has failed. Please try again.
NO_CONTENTThe requested download is ready. However, there is no content in the download.

Deletion

statusDescription
REQUESTEDThe deletion has been requested.
IN_PROGRESSThe deletion request is in progress. It can not be canceled at this stage. Arcadia will send a webhook to notify you if the deletion has succeeded or failed.
SUCCESSThe deletion request has been successfully executed.
FAILUREThe deletion request has been successfully executed.

Webhook

statusDescription
WAITING_RESENDArcadia will send the webhook again.
FAILUREArcadia has failed to send the webhook.
SUCCESSArcadia has successfully sent the webhook.

What’s Next

If you are migrating or considering to migrate from the Legacy Utility Cloud API, please refer to the old and new status mapping.