v1

latestOpenAPI 3.1.02026-07-1342111193.6 KB

Utility Credentials

Get Utility Credential

Returns a single UtilityCredential specified by ID.

get/utility_credentials/{utility_credential_id}

Path parameters

utility_credential_idinteger required

Headers

Arcadia-Versionstring required

The Arcadia-Version for the request

Response

Success

idinteger required

client_user_idstring required

utility_namestring required

The list of supported Arcadia utilities can be found here.

utility_long_namestring required

Provides greater detail than utility_name. The list of supported Arcadia utilities can be found here.

usernamestring nullable required

verification_status'pending' | 'verified' | 'rejected' | 'error' required

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 Arcadia will continue to retry verification in the background.

accounts_load_in_progressboolean required

Indicates if Arcadia 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_atstring date-time nullable required

created_atstring date-time required

updated_atstring date-time required

sandboxedboolean required

uses_test_scenarioboolean required

Indicates if the utility credential was created using a designated test username and password.

Example response

{
  "id": 12345,
  "client_user_id": "fff57dc7-3a2b-4395-8a62-e3486d46dabe",
  "utility_name": "AEP SWEPCO",
  "utility_long_name": "AEP SWEPCO AR",
  "username": "great_customer"
}