Status Mapping
Credential
Statuses
Legacy Utility Cloud Status | Plug API Status |
---|---|
OK | CONNECTION_SUCCESS |
PENDING ACTION_REQUIRED | CONNECTION_IN_PROGRESS |
NON_FUNCTIONAL | CONNECTION_FAILURE |
Status details
Legacy Utility Cloud Status Detail | Plug API Status Detail |
---|---|
NO_ACTION_REQUIRED | LOGIN_AND_DATA_DISCOVERY_SUCCESS DATA_EXTRACTION_IN_PROGRESS |
WEBSITE_DOWN | PROVIDER_WEBSITE_INACCESSIBLE |
UNDER_REVIEW | ISSUE_UNDER_REVIEW |
NAVIGATION_FAILURE | PROVIDER_WEBSITE_NAVIGATION_FAILURE |
UNSUPPORTED_CAPTCHA | UNSUPPORTED_CAPTCHA |
LOGIN_FAILURE | INVALID_CREDENTIALS |
MULTI_FACTOR_AUTH_FAILURE | UNSUPPORTED_MULTI_FACTOR_AUTHENTICATION |
USER_ACTION_REQUIRED LIMITED_ACCESS ACCOUNT_LOCKED SECURITY_QUESTIONS E_BILL_REQUIRED PROVIDER_ISSUE STATEMENT_UNAVAILABLE NO_ACCOUNTS_FOUND | OTHER_ACCESS_LIMITATION |
Exception
In Utility Cloud, when a credential with real time credential validation (RTCV) = true is submitted, the status is set to OK
and the statusDetail is set to NO_ACTION_REQUIRED
.
In Plug, when the same credential with RTCV = true is submitted, the status is set to CONNECTION_IN_PROGRESS
and the statusDetail is set to DATA_EXTRACTION_IN_PROGRESS
.
Account
Statuses
Legacy Utility Cloud API | Plug API |
---|---|
OK | CONNECTION_SUCCESS |
PENDING | CONNECTION_IN_PROGRESS |
ACCESS_ISSUE | DATA_ACCESS_FAILURE |
OLD | INACTIVE |
Status details
Legacy Utility Cloud API | Plug API |
---|---|
NO_ACTION_REQUIRED | DATA_ACCESSIBLE |
UNDER_REVIEW EXTRACTION_FAILURE REQUIRES_ENROLLMENT PENDING_ENROLLMENT (When the status is PENDING ) | ISSUE_UNDER_REVIEW |
UNDER_REVIEW (When the status is ACCESS_ISSUE )E_BILL_REQUIRED | CREDENTIAL_ISSUE |
ACCOUNT_NOT_FOUND INVALID_SOURCE ACCOUNT_NUMBER_CHANGE ACCOUNT_SETUP_REQUIRED INVALID_SOURCE STATEMENT_UNAVAILABLE | NO_DATA_AVAILABLE |
DORMANT | NO_BILLS_DISCOVERED_AFTER_MOST_RECENT_NEXT_EXPECTED_POST_DATE |
ACCOUNT_CLOSED | NO_BILLS_DISCOVERED_AFTER_FINAL_BILL_NOTICE |
Meter
The Plug Statements product will no longer have meter statuses.
File
Notice
The following section is only relevant to Utility Cloud customers who have been using the files processing capabilities before December 13, 2023.
From December 13, 2023, onwards, all files will have the updated status and status details, regardless of when they were uploaded.
If you have been using the files processing capabilities before December 13, 2023, you can use these mappings to understand how legacy statuses and status details map to the current statuses and status details.
Status mapping
Legacy Utility Cloud API | New status name |
---|---|
PENDING | QUEUED |
PENDING | IN_PROGRESS |
PENDING | COVERAGE_REQUEST |
FAILURE | FAILURE |
SUCCESS | SUCCESS |
Status detail mapping
How status mapping works
This is a best-effort rough mapping of status details between the legacy and the new ones. As the new statuses are more specific than the legacy statuses, legacy statuses details could apply to more than one new status detail. The table below shows the default mapping we are using.
File.fileDetails is now an array
The legacy
fileDetails
were typestring
. The updatedfileDetails
are typearray
, an array of strings. This means more than one status detail can be returned for a given status. Please see our API reference for more details.
Legacy Utility Cloud API | Plug API |
---|---|
New In Progress | READY_FOR_PROCESSING |
Unsupported Bill Format Input File Corrupted | PROVIDER_UNIDENTIFIABLE |
Unsupported Provider | SERVICE_TYPE_NOT_SUPPORTED |
Unsupported Language | LANGUAGE_NOT_SUPPORTED |
null | REQUIRED_DATA_FIELDS_MISSING |
“” | BILL_INSUFFICIENTLY_LEGIBLE |
File Processing Timed Out | TIMED_OUT |
Provider Not Supported | IDENTIFYING_PROVIDER |
Under Review | BILL_ANOMALY_FLAGGED |
Under Review | DATA_EXTRACTION_FAILURE_INVESTIGATION_STARTED |
Under Review | DATA_AUDIT_FAILURE_INVESTIGATION_STARTED |
null | REQUEST_CREATED |
null | IN_PROGRESS |
"" | DATA_EXTRACTION_SUCCESSFUL |
Download
Legacy Utility Cloud API | Plug API |
---|---|
SUCCESS | SUCCESS |
PENDING | PREPARING |
FAILED EMAIL_FAILED | FAILURE |
NO_CONTENT | NO_CONTENT |
Webhook
Legacy Utility Cloud API | Plug API |
---|---|
WAITING_RESEND | WAITING_RESEND |
ERROR | FAILURE |
SUCCESS | SUCCESS |
Updated about 1 month ago