Webhook posted when an error was encountered attempting to verify the utility credentials.
See the description of verification_status in the Response section of Get Utility Credential for more information. The id field represents a utility credential (utility_credential_id) that is associated with the user whose client_user_id is in the data object.
Request Body Schema
| Property name | Data type | Required? | Description |
|---|---|---|---|
type | string | yes | Value: "utility_credential_verification_error" |
created_at | string | yes | |
data | object (UtilityCredential) | yes |
UtilityCredential
| Property name | Data type | Required? | Description |
|---|---|---|---|
id | integer | yes | |
client_user_id | string | yes | |
utility_name | string | yes | The list of supported Arc utilities can be found here. |
utility_long_name | string | yes | Provides greater detail than utility_name. The list of supported Arc utilities can be found here. |
username | null or string | yes | |
verification_status | string | yes | Enum:"pending" "verified" "rejected" "error" The verification status of the Utility Credential. - pending: Credential verification is pending- verified: The credentials were found to be correct- rejected: The credentials were found to be incorrect- error: There was an error attempting to verify the credentials. This status may be transient, as Arc will continue to retry verification in the background. |
accounts_load_in_progress | boolean | yes | Indicates if Arc is in the process of verifying a utility credential or loading associated utility accounts. The combination of verification_status: verified and account_load_in_progress: false will indicate that utility accounts are available in the API. Alternatively, the utility_accounts_discovered webhook will alert you when utility accounts are available in the API. |
verification_updated_at | null or string <date-time> | yes | |
created_at | string <date-time> | yes | |
updated_at | string <date-time> | yes | |
sandboxed | boolean | yes | |
uses_test_scenario | boolean | yes | Indicates if the utility credential was created using a designated test username and password. |
Request sample
Content type: application/json
{
"type": "utility_credential_verification_error",
"created_at": "2019-08-24T14:15:22Z",
"data": {
"id": 12345,
"client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
"utility_name": "Pepco",
"utility_long_name": "Pepco DC",
"username": "great_customer",
"verification_status": "pending",
"accounts_load_in_progress": false,
"verification_updated_at": null,
"created_at": "2019-08-24T14:15:22Z",
"updated_at": "2019-08-24T14:15:22Z",
"sandboxed": false,
"uses_test_scenario": false
}
}