Status and Status Detail Descriptions
Definitions for possible statuses and status details in the Plug API.
Credentials
status | statusDetail | isCustomer ActionRequired | Description |
---|---|---|---|
CONNECTION_SUCCESS | LOGIN_AND_DATA_ DISCOVERY_SUCCESSFUL | false | Arcadia was able to log into and discover data for the utility account. |
CONNECTION_IN_PROGRESS | PROVIDER_WEBSITE _INACCESSIBLE | false | Arcadia was not able to access the provider website due to issues with the provider website. |
- | ISSUE_UNDER_REVIEW | false | Arcadia 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_FAILURE | false | Arcadia’s utility website navigation procedure has failed. The Arcadia team has started to investigate the issue and will update the status accordingly. |
- | UNSUPPORTED_CAPTCHA | false | Arcadia’s CAPTCHA procedure has failed. The Arcadia team has started to investigate the issue and will update the status accordingly. |
CONNECTION_FAILURE | INVALID_CREDENTIALS | true | Arcadia 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_AUTHENTICATION | true | Arcadia 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_ LIMITATION | true | Arcadia 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
status | statusDetail | `isCustomer ActionRequired | Description |
---|---|---|---|
CONNECTION_SUCCESS | DATA_ACCESSIBLE | false | Arcadia is able to successfully connect to the utility account and extract the latest statement data from the account. |
CONNECTION_IN_PROGRESS | ISSUE_UNDER_REVIEW | false | Arcadia 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 he exact issue is unknown, our team has started looking into it and will update the status accordingly. |
DATA_ACCESS_FAILURE | CREDENTIAL_ISSUE | true | Arcadia 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_AVAILABLE | true | Arcadia 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. |
INACTIVE | NO_BILLS_DISCOVERED _AFTER_MOST_RECENT _NEXT_EXPECTED_POST_DATE | false | Arcadia has not discovered a new bill for at least 15 days after the nextExpectedPostDate . |
- | NO_BILLS_DISCOVERED _AFTER_FINAL_BILL_NOTICE | false | Arcadia 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. |
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
Descriptions
status | statusDetail | Description |
---|---|---|
QUEUED | READY_FOR_PROCESSING | Arcadia has started processing the bill. |
FAILURE | PROVIDER_UNIDENTIFIABLE | Arcadia is not able to obtain the provider name from the bill. |
SERVICE_TYPE_NOT_SUPPORTED | Arcadia does not currently support the service type of the bill. | |
LANGUAGE_NOT_SUPPORTED | Arcadia does not currently support the language of the bill. | |
REQUIRED_DATA_FIELDS_MISSING | Arcadia is not able to obtain one or more required fields from the bill. | |
BILL_INSUFFICIENTLY_LEGIBLE | Arcadia 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_OUT | Arcadia was not able to process the bill within 2 weeks, therefore the bill is timed out. | |
IN_PROGRESS | IDENTIFYING_PROVIDER | Arcadia was not able to automatically detect the provider. Our staff will try to identify the provider name from the bill. |
BILL_ANOMALY_FLAGGED | Arcadia has identified some anomalies on the bill and has started reviewing the bill to ensure accurate data extraction. | |
DATA_EXTRACTION_FAILURE_INVESTIGATION_STARTED | The bill has failed automated data extraction. The bill will be reviewed for further processing. | |
DATA_AUDIT_FAILURE_INVESTIGATION_STARTED | The bill has failed automated data quality audits. The bill will be reviewed for further processing. | |
COVERAGE_REQUEST | REQUEST_CREATED | Arcadia will develop an automated way to extract data from the bill. |
IN_PROGRESS | Arcadia has started the development process for automating data extraction for the bill. | |
SUCCESS | DATA_EXTRACTION_SUCCESSFUL | Arcadia was able to extract data from the bill submitted |
Download
status | Description |
---|---|
SUCCESS | The requested download is ready. |
PREPARING | The requested download is being prepared. Arcadia will send a webhook and email to notify you when the download is ready. |
FAILURE | The requested download has failed. Please try again. |
NO_CONTENT | The requested download is ready. However, there is no content in the download. |
Deletion
status | Description |
---|---|
REQUESTED | The deletion has been requested. |
IN_PROGRESS | The 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. |
SUCCESS | The deletion request has been successfully executed. |
FAILURE | The deletion request has been successfully executed. |
Webhook
status | Description |
---|---|
WAITING_RESEND | Arcadia will send the webhook again. |
FAILURE | Arcadia has failed to send the webhook. |
SUCCESS | Arcadia has successfully sent the webhook. |
Updated 9 months ago
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.