HomeGuidesAPI ReferenceChangelog
Log In
Guides

Status Mapping

Suggest Edits

Credential

Statuses

Legacy Utility Cloud StatusPlug API Status
OKCONNECTION_SUCCESS
PENDING
ACTION_REQUIRED		CONNECTION_IN_PROGRESS
NON_FUNCTIONALCONNECTION_FAILURE

Status details

Legacy Utility Cloud Status Detail Plug API Status Detail
NO_ACTION_REQUIREDLOGIN_AND_DATA_DISCOVERY_SUCCESS
DATA_EXTRACTION_IN_PROGRESS
WEBSITE_DOWNPROVIDER_WEBSITE_INACCESSIBLE
UNDER_REVIEWISSUE_UNDER_REVIEW
NAVIGATION_FAILUREPROVIDER_WEBSITE_NAVIGATION_FAILURE
UNSUPPORTED_CAPTCHAUNSUPPORTED_CAPTCHA
LOGIN_FAILUREINVALID_CREDENTIALS
MULTI_FACTOR_AUTH_FAILUREUNSUPPORTED_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 APIPlug API
OKCONNECTION_SUCCESS
PENDINGCONNECTION_IN_PROGRESS
ACCESS_ISSUEDATA_ACCESS_FAILURE
OLDINACTIVE

Status details

Legacy Utility Cloud APIPlug API
NO_ACTION_REQUIREDDATA_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
DORMANTNO_BILLS_DISCOVERED_AFTER_MOST_RECENT_NEXT_EXPECTED_POST_DATE
ACCOUNT_CLOSEDNO_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 APINew status name
PENDINGQUEUED
PENDINGIN_PROGRESS
PENDINGCOVERAGE_REQUEST
FAILUREFAILURE
SUCCESSSUCCESS

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 type string. The updated fileDetails are type array, 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 APIPlug API
New
In Progress		READY_FOR_PROCESSING
Unsupported Bill Format
Input File Corrupted		PROVIDER_UNIDENTIFIABLE
Unsupported ProviderSERVICE_TYPE_NOT_SUPPORTED
Unsupported LanguageLANGUAGE_NOT_SUPPORTED
nullREQUIRED_DATA_FIELDS_MISSING
“” BILL_INSUFFICIENTLY_LEGIBLE
File Processing Timed OutTIMED_OUT
Provider Not SupportedIDENTIFYING_PROVIDER
Under ReviewBILL_ANOMALY_FLAGGED
Under ReviewDATA_EXTRACTION_FAILURE_INVESTIGATION_STARTED
Under ReviewDATA_AUDIT_FAILURE_INVESTIGATION_STARTED
nullREQUEST_CREATED
nullIN_PROGRESS
""DATA_EXTRACTION_SUCCESSFUL

Download

Legacy Utility Cloud APIPlug API
SUCCESSSUCCESS
PENDINGPREPARING
FAILED
EMAIL_FAILED		FAILURE
NO_CONTENTNO_CONTENT

Webhook

Legacy Utility Cloud APIPlug API
WAITING_RESENDWAITING_RESEND
ERRORFAILURE
SUCCESSSUCCESS

Updated 17 days ago