HomeGuidesAPI ReferenceChangelog
Log In
API Reference

Webhooks

Arc can send webhooks for notable events. For example, this could include if a new statement is available or we notice a credential is now resulting in login failure.

To specify the webhook URL that you would like the events to be POSTed to, you can update it in the Dashboard from the Webhooks page on the Configuration dropdown or using this endpoint.

When sending a webhook, Arcadia looks for a 2xx response. If such a response is not received, Arcadia assumes that the webhook failed to deliver and the Arcadia platform will continue to attempting to send the webhook response three times every six hours for a total of one day (twelve automatic retries maximum). Each subsequent webhook attempt will have an identical message body.

There is an optional interactive boolean flag when creating new credentials. If this is set to true, a webhookUrl is required, and the system will emit Real-Time-Credential-Notification (RTCV) webhook notifications confirming REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS or REAL_TIME_CREDENTIAL_VALIDATION_FAILURE event types. This will also emit pending status notifications. These webhooks are only retried up to three times.

There are endpoints for viewing and resending the webhooks stored in the system here.

Webhook Parameters

It is possible to optionally specify additional parameters that will be sent along with all webhooks. Namely, you can set the value of any custom headers or query parameters. This can be useful for authentication purposes to verify that a webhook is coming from Arcadia.

Currently, these values must be set by Arcadia internally and cannot be set via the API or Dashboard. To set up these values, please reach out to customer support via Zendesk and let them know what header name(s) and value(s) are required. The maximum length of the header name is 80 characters, and the maximum length of the header value is 255 characters. Both can only contain alphanumeric characters, as well as _ and - characters. The header value can additionally contain the special characters /, ., \, and ,. Spaces are not allowed.

See below for a complete list of webhook event types with example JSON payloads:

Webhooks Relevant for All Integrations

Event TypeResource TypesDescription
STATUS_CHANGEACCOUNT / CREDENTIAL / FILE / DELETION / DOWNLOADArcadia will send this webhook for all status updatesAll status and status detail updates for Credentials, Accounts, Files, and Meters.
EXISTING_DATA_UPDATEDSTATEMENTArcadia will send this webhook for any updates made to a statement that as already been discovered and stored.

Generally, Arcadia updates existing statement data when there is a minor update to our data extraction logic. You can expect the statement ID and / or the uploaded bill ID for the statement to remain the same while the data will slightly change.
NEW_DATA_AVAILABLESTATEMENTArcadia will send this webhook when a new statement has been discovered for the first time. You can expect to get the latest statement data after receiving this webhook.

Arcadia considered adjustment statements to be new statements with their own new and unique statement ID.

Webhooks ONLY Relevant for Building Your Own "Connect"

Event TypeResource TypeDescription
REAL_TIME_CREDENTIAL_VALIDATION_SUCCESSCREDENTIALThis webhook will only be sent for credentials that supports real time credential validation and interactive has been set to true in the POST Create Credential request.

Arcadia has successfully logged into the utility account.
REAL_TIME_CREDENTIAL_VALIDATION_FAILURECREDENTIALThis webhook will only be sent for credentials that supports real time credential validation and interactive has been set to true in the POST Create Credential request.

Arcadia has failed to logged into the utility account.

Webhook Notification Examples

👍

The resource embedded in the data field will be the same schema as the API response for an entity of the corresponding resource type in the resource field

STATUS_CHANGE

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_cf7146fa-3974-fa07-6813-5d7f4e6cbbde",
    "isActive" : true,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_41428d0c-2804-ca52-e396-4ef9f30754cb",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "status" : "CONNECTION_SUCCESS",
    "statusDetail" : "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_8ed41615-edd4-d81d-bf47-c4ef75edf0d8",
  "resource" : "CREDENTIAL"
}

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumber" : "3323141189896624080",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "system",
    "customData" : null,
    "firstExtractedAt" : "2024-02-21T00:00:00.000+00:00",
    "id" : "act_aa8107f5-0c5d-396f-f11c-c76b9be88934",
    "isCustomerActionRequired" : false,
    "isStatementsProductActive" : true,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "system",
    "lastSuccessfulStatementExtractionAt" : "2024-02-21T00:00:00.000+00:00",
    "latestNewStatementAt" : "2023-09-28T00:00:00.000+00:00",
    "latestStatementDate" : "2023-09-28",
    "nextExpectedPostDate" : "2023-10-28",
    "normalizedAccountNumber" : "3323141189896624080",
    "prepaid" : false,
    "provider" : {
      "country" : "USA",
      "id" : "prv_41428d0c-2804-ca52-e396-4ef9f30754cb",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "providerClassification" : "PUBLISHER",
    "serviceTypes" : [ ],
    "siteNames" : [ ],
    "status" : "NEW_ACCOUNT",
    "statusDetail" : "DATA_ACCESSIBLE",
    "summaryAccountId" : null,
    "summaryAccountNumber" : null,
    "type" : "NORMAL"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_8d67f209-6a03-6ace-8662-406a4ea35c12",
  "resource" : "ACCOUNT"
}

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumbers" : [ ],
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "fileName" : "example-file-name.pdf",
    "id" : "fil_3463af21-32d8-786a-b2af-5028207bad7c",
    "isCustomerActionRequired" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : null,
    "statementDate" : null,
    "statementId" : null,
    "status" : "QUEUED",
    "statusDetails" : [ "READY_FOR_PROCESSING" ],
    "transferMethod" : "CLIENT"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_768b0644-3f71-4eac-9c04-7f75ed622180",
  "resource" : "FILE"
}

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountCount" : 5,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "deletionTargetId" : "crd_31706680-327f-9301-3a91-026940d08bb9",
    "fileCount" : 0,
    "id" : "del_53e41db0-a1a6-227d-dd28-573570cd1312",
    "meterCount" : 4,
    "siteCount" : 0,
    "statementCount" : 2,
    "status" : "SUCCESS"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_4c0130b7-ecf3-91cf-41fc-fc1b2929829f",
  "resource" : "DELETION"
}

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "downloadMethod" : "IN_BROWSER",
    "id" : "dwl_c6395d15-623a-8e26-db9b-df24fc7a0068",
    "status" : "SUCCESS",
    "token" : "abcd"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_375e2133-492c-bc26-7d8f-2cac31f611dc",
  "resource" : "DOWNLOAD"
}

NEW_DATA_AVAILABLE

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_4203b846-f61f-7f99-6a0d-11ddef14d433",
      "accountNumber" : "2335508569404453379",
      "amountDue" : 906.48,
      "dueDate" : "2023-02-28",
      "meterData" : [ {
        "amountDue" : 18.23,
        "meterId" : "mtr_3caedefb-98fe-da5e-7007-1711cb3d11c4",
        "meterNumber" : "8919984383921609981",
        "meterReadDate" : "2023-02-14",
        "normalizedMeterNumber" : "8919984383921609981",
        "normalizedPointOfDeliveryNumber" : "11",
        "outstandingBalance" : 18.23,
        "pointOfDeliveryNumber" : "11",
        "previousReadDate" : "2023-01-15",
        "serviceType" : "water",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 18.23,
        "totalUsage" : 79.4,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 888.25,
        "meterId" : "mtr_b2578a56-7035-ffd9-22da-bef61e0bb810",
        "meterNumber" : "4126359823485640831",
        "meterReadDate" : "2023-02-14",
        "normalizedMeterNumber" : "4126359823485640831",
        "normalizedPointOfDeliveryNumber" : "2",
        "outstandingBalance" : 888.25,
        "pointOfDeliveryNumber" : "2",
        "previousReadDate" : "2023-01-15",
        "serviceType" : "water",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 888.25,
        "totalUsage" : 577.21,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "2335508569404453379",
      "outstandingBalance" : 906.48,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_2f574b92-e2e1-f016-d899-ae80dd274773",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_4203b846-f61f-7f99-6a0d-11ddef14d433"
      },
      "totalCharges" : 906.48
    } ],
    "amountDue" : 906.48,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-02-28",
    "id" : "stm_292cc1b9-790c-7a3a-6f28-05064080a6d7",
    "invoiceNumber" : "5627932318895886448",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 906.48,
    "periodEndDate" : "2023-02-14",
    "periodStartDate" : "2023-01-15",
    "provider" : {
      "country" : "USA",
      "id" : "prv_2f574b92-e2e1-f016-d899-ae80dd274773",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-02-14",
    "summaryAccountNumber" : null,
    "totalCharges" : 906.48,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_652e86f1-6bba-20b5-0111-d2c4ff3628d1",
  "resource" : "STATEMENT"
}

EXISTING_DATA_UPDATED

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_550d9055-ba93-79bd-0ecc-7f2319dd716f",
      "accountNumber" : "6466508566457188658",
      "amountDue" : 314.59,
      "dueDate" : "2023-10-30",
      "meterData" : [ {
        "amountDue" : 314.59,
        "meterId" : "mtr_0704c97f-0e52-9bcc-a26c-a335831b8c55",
        "meterNumber" : "4698299459428819657",
        "meterReadDate" : "2023-10-16",
        "normalizedMeterNumber" : "4698299459428819657",
        "normalizedPointOfDeliveryNumber" : "5",
        "outstandingBalance" : 314.59,
        "pointOfDeliveryNumber" : "5",
        "previousReadDate" : "2023-09-16",
        "serviceType" : "water",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 314.59,
        "totalUsage" : 163.12,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "6466508566457188658",
      "outstandingBalance" : 314.59,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_2627a36a-1592-b76a-f996-cf5a68b7900c",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_550d9055-ba93-79bd-0ecc-7f2319dd716f"
      },
      "totalCharges" : 314.59
    } ],
    "amountDue" : 314.59,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-10-30",
    "id" : "stm_ebb68ea8-2714-7746-997b-48aac9b37563",
    "invoiceNumber" : "1381997427380093758",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 314.59,
    "periodEndDate" : "2023-10-16",
    "periodStartDate" : "2023-09-16",
    "provider" : {
      "country" : "USA",
      "id" : "prv_2627a36a-1592-b76a-f996-cf5a68b7900c",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-10-16",
    "summaryAccountNumber" : null,
    "totalCharges" : 314.59,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "EXISTING_DATA_UPDATED",
  "id" : "whk_e1fcdcae-2144-0cee-5d5f-408cca528a86",
  "resource" : "STATEMENT"
}

REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_9f140095-1253-26b3-3bfe-e305ffe6ff30",
    "isActive" : true,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_f0919a74-b84e-1388-3dce-23bce2f7db19",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_SUCCESS",
    "statusDetail" : "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS",
  "id" : "whk_c65e9551-3c73-5f5e-9e31-ebcb78999294",
  "resource" : "CREDENTIAL"
}

REAL_TIME_CREDENTIAL_VALIDATION_FAILURE

{
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_c285ed74-860d-61b0-d434-53341c1fa59e",
    "isActive" : false,
    "isCustomerActionRequired" : true,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_c829956e-40d3-675a-3636-53822907c00f",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_FAILURE",
    "statusDetail" : "INVALID_CREDENTIALS",
    "totalAccounts" : 0,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "REAL_TIME_CREDENTIAL_VALIDATION_FAILURE",
  "id" : "whk_a69fbae6-ce18-6527-58f1-71ceb933fffb",
  "resource" : "CREDENTIAL"
}

Example Scenarios

Successful RTCV Submission

  1. Credentials submitted

  2. Optionally, credential login event emitted:

    📘

    This is only emitted if the credential was submitted using "interactive": true,via this endpoint.

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_8560e539-21da-663c-b0c0-a97d23426ca5",
    "isActive" : true,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_5ce49928-4246-305b-6f4b-3b9c3922dda3",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_SUCCESS",
    "statusDetail" : "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "REAL_TIME_CREDENTIAL_VALIDATION_SUCCESS",
  "id" : "whk_e7c66600-ea8c-0211-b9f0-6220c1a9d144",
  "resource" : "CREDENTIAL"
}

  3. Credential event emitted:

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_8560e539-21da-663c-b0c0-a97d23426ca5",
    "isActive" : true,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_5ce49928-4246-305b-6f4b-3b9c3922dda3",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_SUCCESS",
    "statusDetail" : "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_08367c3c-b707-53ff-5a48-acd2e90bfe69",
  "resource" : "CREDENTIAL"
}

  4. Account(s) discovered

  5. Account event(s) emitted (1 per account under the credential):

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumber" : "8200191242590839254",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "system",
    "customData" : null,
    "firstExtractedAt" : "2024-02-21T00:00:00.000+00:00",
    "id" : "act_c022ce54-fba7-4f1a-e301-9ed3b47bf99b",
    "isCustomerActionRequired" : false,
    "isStatementsProductActive" : true,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "system",
    "lastSuccessfulStatementExtractionAt" : "2024-02-21T00:00:00.000+00:00",
    "latestNewStatementAt" : "2023-05-20T00:00:00.000+00:00",
    "latestStatementDate" : "2023-05-20",
    "nextExpectedPostDate" : "2023-06-19",
    "normalizedAccountNumber" : "8200191242590839254",
    "prepaid" : false,
    "provider" : {
      "country" : "USA",
      "id" : "prv_5ce49928-4246-305b-6f4b-3b9c3922dda3",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "providerClassification" : "PUBLISHER",
    "serviceTypes" : [ {
      "serviceType" : "natural_gas",
      "serviceTypeClassification" : "SUPPLEMENTAL"
    }, {
      "serviceType" : "sewer",
      "serviceTypeClassification" : "CORE"
    }, {
      "serviceType" : "water",
      "serviceTypeClassification" : "CORE"
    } ],
    "siteNames" : [ ],
    "status" : "NEW_ACCOUNT",
    "statusDetail" : "DATA_ACCESSIBLE",
    "summaryAccountId" : null,
    "summaryAccountNumber" : null,
    "type" : "NORMAL"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_3ca4c373-38ee-3846-f6d0-7f49f6a0517f",
  "resource" : "ACCOUNT"
}

  6. Statement(s) discovered

  7. Statement event(s) emitted (1 per statement):

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_c022ce54-fba7-4f1a-e301-9ed3b47bf99b",
      "accountNumber" : "8200191242590839254",
      "amountDue" : 1400.27,
      "dueDate" : "2023-06-03",
      "meterData" : [ {
        "amountDue" : 686.36,
        "meterId" : "mtr_d4af6eac-3d12-9130-456e-92e85cdc07a9",
        "meterNumber" : "4404303161106713403",
        "meterReadDate" : "2023-05-20",
        "normalizedMeterNumber" : "4404303161106713403",
        "normalizedPointOfDeliveryNumber" : "9",
        "outstandingBalance" : 686.36,
        "pointOfDeliveryNumber" : "9",
        "previousReadDate" : "2023-04-20",
        "serviceType" : "sewer",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 686.36,
        "totalUsage" : 361.33,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 604.6,
        "meterId" : "mtr_fe3bdecb-b738-0fe6-3a98-172a5ebf3861",
        "meterNumber" : "7898248729712635997",
        "meterReadDate" : "2023-05-20",
        "normalizedMeterNumber" : "7898248729712635997",
        "normalizedPointOfDeliveryNumber" : "3",
        "outstandingBalance" : 604.6,
        "pointOfDeliveryNumber" : "3",
        "previousReadDate" : "2023-04-20",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 604.6,
        "totalUsage" : 442.63,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 109.31,
        "meterId" : "mtr_021835aa-343d-5f9e-e67f-25edd5d648aa",
        "meterNumber" : "785246857211584963",
        "meterReadDate" : "2023-05-20",
        "normalizedMeterNumber" : "785246857211584963",
        "normalizedPointOfDeliveryNumber" : "9",
        "outstandingBalance" : 109.31,
        "pointOfDeliveryNumber" : "9",
        "previousReadDate" : "2023-04-20",
        "serviceType" : "water",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 109.31,
        "totalUsage" : 512.64,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "8200191242590839254",
      "outstandingBalance" : 1400.27,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_5ce49928-4246-305b-6f4b-3b9c3922dda3",
        "name" : "Example RTCV Provider",
        "publisherProviderAccountId" : "act_c022ce54-fba7-4f1a-e301-9ed3b47bf99b"
      },
      "totalCharges" : 1400.27
    } ],
    "amountDue" : 1400.27,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-06-03",
    "id" : "stm_ee7af981-00c2-65e0-d7f6-9353bdb4c08b",
    "invoiceNumber" : "4771234994523997829",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 1400.27,
    "periodEndDate" : "2023-05-20",
    "periodStartDate" : "2023-04-20",
    "provider" : {
      "country" : "USA",
      "id" : "prv_5ce49928-4246-305b-6f4b-3b9c3922dda3",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "statementDate" : "2023-05-20",
    "summaryAccountNumber" : null,
    "totalCharges" : 1400.27,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_e28f64d8-1a66-2dd8-ca9e-45f246158d52",
  "resource" : "STATEMENT"
}

Unsuccessful RTCV Submission

  1. Credentials submitted

  2. Optionally, credential login event emitted:

    📘

    This is only emitted if the credential was submitted using "interactive": true,via this endpoint.

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_e3073c1b-bdac-d10e-0786-40e4f4dd9653",
    "isActive" : false,
    "isCustomerActionRequired" : true,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_c8f5df44-8a06-4e7d-e308-d7b03374c9b6",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_FAILURE",
    "statusDetail" : "INVALID_CREDENTIALS",
    "totalAccounts" : 0,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "REAL_TIME_CREDENTIAL_VALIDATION_FAILURE",
  "id" : "whk_03194ac2-aa4a-eec0-aa97-64521f067b8d",
  "resource" : "CREDENTIAL"
}

  3. Credential failure or pending event emitted:

    📘

    A pending event indicates that the data extraction failed for a presumably temporary reason, such as the provider website being down.

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_e3073c1b-bdac-d10e-0786-40e4f4dd9653",
    "isActive" : false,
    "isCustomerActionRequired" : true,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_c8f5df44-8a06-4e7d-e308-d7b03374c9b6",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_FAILURE",
    "statusDetail" : "INVALID_CREDENTIALS",
    "totalAccounts" : 0,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_3fba3873-1d17-65ce-d8a8-cb86df66a7bb",
  "resource" : "CREDENTIAL"
}

    Or

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_e3073c1b-bdac-d10e-0786-40e4f4dd9653",
    "isActive" : false,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_c8f5df44-8a06-4e7d-e308-d7b03374c9b6",
      "name" : "Example RTCV Provider",
      "supportsCredentialValidation" : true
    },
    "status" : "CONNECTION_IN_PROGRESS",
    "statusDetail" : "PROVIDER_WEBSITE_INACCESSIBLE",
    "totalAccounts" : 0,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_40275c3a-e5a5-67bb-c364-ec3cf350df50",
  "resource" : "CREDENTIAL"
}

Successful Non-RTCV Submission

  1. Credentials submitted

  2. Credential event emitted:

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_5b4a3c86-3879-654d-98a5-4c36c7d44e6c",
    "isActive" : true,
    "isCustomerActionRequired" : false,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_3ac39cf2-fdcf-5efd-1d98-0840559258ab",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "status" : "CONNECTION_SUCCESS",
    "statusDetail" : "LOGIN_AND_DATA_DISCOVERY_SUCCESS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_199fa171-d729-e2df-c4da-c43f78475896",
  "resource" : "CREDENTIAL"
}

  3. Account(s) discovered

  4. Account event(s) emitted (1 per account under the credential):

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumber" : "2904783206795329220",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "system",
    "customData" : null,
    "firstExtractedAt" : "2024-02-21T00:00:00.000+00:00",
    "id" : "act_9b3ac933-dc05-db96-aa6d-c284efe7dff4",
    "isCustomerActionRequired" : false,
    "isStatementsProductActive" : true,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "system",
    "lastSuccessfulStatementExtractionAt" : "2024-02-21T00:00:00.000+00:00",
    "latestNewStatementAt" : "2023-09-04T00:00:00.000+00:00",
    "latestStatementDate" : "2023-09-04",
    "nextExpectedPostDate" : "2023-10-04",
    "normalizedAccountNumber" : "2904783206795329220",
    "prepaid" : false,
    "provider" : {
      "country" : "USA",
      "id" : "prv_3ac39cf2-fdcf-5efd-1d98-0840559258ab",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "providerClassification" : "PUBLISHER",
    "serviceTypes" : [ {
      "serviceType" : "lighting",
      "serviceTypeClassification" : "CORE"
    }, {
      "serviceType" : "natural_gas",
      "serviceTypeClassification" : "SUPPLEMENTAL"
    } ],
    "siteNames" : [ ],
    "status" : "NEW_ACCOUNT",
    "statusDetail" : "DATA_ACCESSIBLE",
    "summaryAccountId" : null,
    "summaryAccountNumber" : null,
    "type" : "NORMAL"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_a40cb6c4-17ca-141c-7a28-d7c2be2d4080",
  "resource" : "ACCOUNT"
}

  5. Statement(s) discovered

  6. Statement event(s) emitted (1 per statement):

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_9b3ac933-dc05-db96-aa6d-c284efe7dff4",
      "accountNumber" : "2904783206795329220",
      "amountDue" : 480.47,
      "dueDate" : "2023-09-18",
      "meterData" : [ {
        "amountDue" : 452.41,
        "meterId" : "mtr_70dfb081-cf58-3868-8be3-2b720b2eb6e4",
        "meterNumber" : "3781243442887905123",
        "meterReadDate" : "2023-09-04",
        "normalizedMeterNumber" : "3781243442887905123",
        "normalizedPointOfDeliveryNumber" : "9",
        "outstandingBalance" : 452.41,
        "pointOfDeliveryNumber" : "9",
        "previousReadDate" : "2023-08-05",
        "serviceType" : "lighting",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 452.41,
        "totalUsage" : 531.3,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 28.06,
        "meterId" : "mtr_f94897e2-80da-70da-dfa5-b0a03e7172a8",
        "meterNumber" : "6270239762449179538",
        "meterReadDate" : "2023-09-04",
        "normalizedMeterNumber" : "6270239762449179538",
        "normalizedPointOfDeliveryNumber" : "7",
        "outstandingBalance" : 28.06,
        "pointOfDeliveryNumber" : "7",
        "previousReadDate" : "2023-08-05",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 28.06,
        "totalUsage" : 168.37,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "2904783206795329220",
      "outstandingBalance" : 480.47,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_3ac39cf2-fdcf-5efd-1d98-0840559258ab",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_9b3ac933-dc05-db96-aa6d-c284efe7dff4"
      },
      "totalCharges" : 480.47
    } ],
    "amountDue" : 480.47,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-09-18",
    "id" : "stm_25452bb8-36db-ce83-c6b4-7ca540e6500b",
    "invoiceNumber" : "4334075956818835921",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 480.47,
    "periodEndDate" : "2023-09-04",
    "periodStartDate" : "2023-08-05",
    "provider" : {
      "country" : "USA",
      "id" : "prv_3ac39cf2-fdcf-5efd-1d98-0840559258ab",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-09-04",
    "summaryAccountNumber" : null,
    "totalCharges" : 480.47,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_5ce638b8-071d-88c6-f04e-6945e6912929",
  "resource" : "STATEMENT"
}

Unsuccessful Non-RTCV Submission

  1. Credentials submitted
  2. Credential failure event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_52d9cfd2-54c9-568e-00f6-b6506541032f",
    "isActive" : false,
    "isCustomerActionRequired" : true,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_e019cc24-8628-d363-1bce-6d0d5ee1687e",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "status" : "CONNECTION_FAILURE",
    "statusDetail" : "INVALID_CREDENTIALS",
    "totalAccounts" : 0,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_e3cf8615-c199-27ca-e945-de73c2d4e859",
  "resource" : "CREDENTIAL"
}

Existing Credential Stops Working

  1. Credential login fails
  2. Credential failure event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "id" : "crd_96033ff1-3721-05cf-efc7-c0b17e53d5b9",
    "isActive" : true,
    "isCustomerActionRequired" : true,
    "isThirdPartyPortal" : false,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "[email protected]",
    "nextScheduledAccountRunAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : {
      "country" : "USA",
      "id" : "prv_cffcbe6a-f19c-8c00-9483-70228911897b",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "status" : "CONNECTION_FAILURE",
    "statusDetail" : "INVALID_CREDENTIALS",
    "totalAccounts" : 1,
    "username" : "example-username",
    "username2" : null,
    "username3" : null,
    "username4" : null
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_46106989-b814-3372-f36a-fe386b7fa139",
  "resource" : "CREDENTIAL"
}

New Statement Discovered Under Existing Credential

  1. Statement discovered
  2. Statement event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_b4959376-ce6c-2264-a56f-b3c6165f2030",
      "accountNumber" : "5259855414716385627",
      "amountDue" : 218.75,
      "dueDate" : "2023-07-03",
      "meterData" : [ {
        "amountDue" : 218.75,
        "meterId" : "mtr_ce21d956-7d20-4b56-2f36-4b120efc5317",
        "meterNumber" : "4579340490711809375",
        "meterReadDate" : "2023-06-19",
        "normalizedMeterNumber" : "4579340490711809375",
        "normalizedPointOfDeliveryNumber" : "4",
        "outstandingBalance" : 218.75,
        "pointOfDeliveryNumber" : "4",
        "previousReadDate" : "2023-05-20",
        "serviceType" : "irrigation",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 218.75,
        "totalUsage" : 600.53,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "5259855414716385627",
      "outstandingBalance" : 218.75,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_866c1681-7cb5-c5cc-6ae6-04c37af5faa7",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_b4959376-ce6c-2264-a56f-b3c6165f2030"
      },
      "totalCharges" : 218.75
    } ],
    "amountDue" : 218.75,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-07-03",
    "id" : "stm_7e85d4d4-be8a-7f5d-b5db-a23cda3f01b6",
    "invoiceNumber" : "4713211246408171234",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 218.75,
    "periodEndDate" : "2023-06-19",
    "periodStartDate" : "2023-05-20",
    "provider" : {
      "country" : "USA",
      "id" : "prv_866c1681-7cb5-c5cc-6ae6-04c37af5faa7",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-06-19",
    "summaryAccountNumber" : null,
    "totalCharges" : 218.75,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_294496d2-db8e-578c-2311-302abcc886ba",
  "resource" : "STATEMENT"
}

Statement Data Changed

  1. Statement discovered

  2. Statement event emitted:

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_a73d0035-9349-3462-992e-2627d1784610",
      "accountNumber" : "9082839858871928420",
      "amountDue" : 1801.31,
      "dueDate" : "2023-11-30",
      "meterData" : [ {
        "amountDue" : 973.02,
        "meterId" : "mtr_22f8c274-fa14-fb46-0ff8-0328608fb9ce",
        "meterNumber" : "5054876103637543193",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "5054876103637543193",
        "normalizedPointOfDeliveryNumber" : "6",
        "outstandingBalance" : 973.02,
        "pointOfDeliveryNumber" : "6",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 973.02,
        "totalUsage" : 149.82,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 363.76,
        "meterId" : "mtr_0d9753d7-f8f2-2b93-1401-7a5e197121f9",
        "meterNumber" : "8543281613601682056",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "8543281613601682056",
        "normalizedPointOfDeliveryNumber" : "13",
        "outstandingBalance" : 363.76,
        "pointOfDeliveryNumber" : "13",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 363.76,
        "totalUsage" : 891.54,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 464.53,
        "meterId" : "mtr_0c09ae21-3ad8-0f98-fc37-e5581122c212",
        "meterNumber" : "5037777525089024684",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "5037777525089024684",
        "normalizedPointOfDeliveryNumber" : "5",
        "outstandingBalance" : 464.53,
        "pointOfDeliveryNumber" : "5",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "lighting",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 464.53,
        "totalUsage" : 920.69,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "9082839858871928420",
      "outstandingBalance" : 1801.31,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_2f22b8fd-2c45-2ddb-5f9e-d7296f4b4aeb",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_a73d0035-9349-3462-992e-2627d1784610"
      },
      "totalCharges" : 1801.31
    } ],
    "amountDue" : 1801.31,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-11-30",
    "id" : "stm_f4361009-6740-40b5-20fd-104f6a80963a",
    "invoiceNumber" : "4031450722819636662",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 1801.31,
    "periodEndDate" : "2023-11-16",
    "periodStartDate" : "2023-10-17",
    "provider" : {
      "country" : "USA",
      "id" : "prv_2f22b8fd-2c45-2ddb-5f9e-d7296f4b4aeb",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-11-16",
    "summaryAccountNumber" : null,
    "totalCharges" : 1801.31,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_af63c1de-d765-338d-7fe8-72a30d821a3e",
  "resource" : "STATEMENT"
}

  3. Much later, Arcadia's data extraction for the provider is updated

  4. Extracted statement data changes

  5. Modified statement event emitted:

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_a73d0035-9349-3462-992e-2627d1784610",
      "accountNumber" : "9082839858871928420",
      "amountDue" : 1801.31,
      "dueDate" : "2023-11-30",
      "meterData" : [ {
        "amountDue" : 973.02,
        "meterId" : "mtr_22f8c274-fa14-fb46-0ff8-0328608fb9ce",
        "meterNumber" : "5054876103637543193",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "5054876103637543193",
        "normalizedPointOfDeliveryNumber" : "6",
        "outstandingBalance" : 973.02,
        "pointOfDeliveryNumber" : "6",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 973.02,
        "totalUsage" : 149.82,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 363.76,
        "meterId" : "mtr_0d9753d7-f8f2-2b93-1401-7a5e197121f9",
        "meterNumber" : "8543281613601682056",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "8543281613601682056",
        "normalizedPointOfDeliveryNumber" : "13",
        "outstandingBalance" : 363.76,
        "pointOfDeliveryNumber" : "13",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "natural_gas",
        "serviceTypeClassification" : "SUPPLEMENTAL",
        "totalCharges" : 363.76,
        "totalUsage" : 891.54,
        "totalUsageUnit" : "kWh"
      }, {
        "amountDue" : 464.53,
        "meterId" : "mtr_0c09ae21-3ad8-0f98-fc37-e5581122c212",
        "meterNumber" : "5037777525089024684",
        "meterReadDate" : "2023-11-16",
        "normalizedMeterNumber" : "5037777525089024684",
        "normalizedPointOfDeliveryNumber" : "5",
        "outstandingBalance" : 464.53,
        "pointOfDeliveryNumber" : "5",
        "previousReadDate" : "2023-10-17",
        "serviceType" : "lighting",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 464.53,
        "totalUsage" : 920.69,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "9082839858871928420",
      "outstandingBalance" : 1801.31,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_2f22b8fd-2c45-2ddb-5f9e-d7296f4b4aeb",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_a73d0035-9349-3462-992e-2627d1784610"
      },
      "totalCharges" : 1801.31
    } ],
    "amountDue" : 1801.31,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "UTILITY_WEBSITE_ACCESS",
    "dueDate" : "2023-12-07",
    "id" : "stm_f4361009-6740-40b5-20fd-104f6a80963a",
    "invoiceNumber" : "4031450722819636662",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 1801.31,
    "periodEndDate" : "2023-11-16",
    "periodStartDate" : "2023-10-17",
    "provider" : {
      "country" : "USA",
      "id" : "prv_2f22b8fd-2c45-2ddb-5f9e-d7296f4b4aeb",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-11-16",
    "summaryAccountNumber" : null,
    "totalCharges" : 1801.31,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "EXISTING_DATA_UPDATED",
  "id" : "whk_b2c8687e-6168-85b2-ded9-bf811d71632a",
  "resource" : "STATEMENT"
}

Account Created Via File Upload

  1. Account discovered

  2. Account event emitted:

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumber" : "6261216952107022980",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "system",
    "customData" : null,
    "firstExtractedAt" : "2024-02-21T00:00:00.000+00:00",
    "id" : "act_f7a99e66-5d2b-fe62-df24-36e7049f0a3e",
    "isCustomerActionRequired" : false,
    "isStatementsProductActive" : true,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "lastModifiedBy" : "system",
    "lastSuccessfulStatementExtractionAt" : "2024-02-21T00:00:00.000+00:00",
    "latestNewStatementAt" : "2023-01-09T00:00:00.000+00:00",
    "latestStatementDate" : "2023-01-09",
    "nextExpectedPostDate" : "2023-02-08",
    "normalizedAccountNumber" : "6261216952107022980",
    "prepaid" : false,
    "provider" : {
      "country" : "USA",
      "id" : "prv_746a3349-3c5c-4020-23a9-39db1d094027",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "providerClassification" : "PUBLISHER",
    "serviceTypes" : [ {
      "serviceType" : "irrigation",
      "serviceTypeClassification" : "CORE"
    } ],
    "siteNames" : [ ],
    "status" : "NEW_ACCOUNT",
    "statusDetail" : "DATA_ACCESSIBLE",
    "summaryAccountId" : null,
    "summaryAccountNumber" : null,
    "type" : "NORMAL"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_b9869a30-4ea9-abf9-c1df-4083a21b95b7",
  "resource" : "ACCOUNT"
}

  3. Statement discovered

  4. Statement event emitted (1 per file uploaded):

    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountData" : [ {
      "accountId" : "act_f7a99e66-5d2b-fe62-df24-36e7049f0a3e",
      "accountNumber" : "6261216952107022980",
      "amountDue" : 461.11,
      "dueDate" : "2023-01-23",
      "meterData" : [ {
        "amountDue" : 461.11,
        "meterId" : "mtr_310754d5-47db-8740-344d-9cde05140acc",
        "meterNumber" : "5543991471039568371",
        "meterReadDate" : "2023-01-09",
        "normalizedMeterNumber" : "5543991471039568371",
        "normalizedPointOfDeliveryNumber" : "19",
        "outstandingBalance" : 461.11,
        "pointOfDeliveryNumber" : "19",
        "previousReadDate" : "2022-12-10",
        "serviceType" : "irrigation",
        "serviceTypeClassification" : "CORE",
        "totalCharges" : 461.11,
        "totalUsage" : 435.65,
        "totalUsageUnit" : "kWh"
      } ],
      "normalizedAccountNumber" : "6261216952107022980",
      "outstandingBalance" : 461.11,
      "provider" : {
        "classification" : "PUBLISHER",
        "id" : "prv_746a3349-3c5c-4020-23a9-39db1d094027",
        "name" : "Example Non-RTCV Provider",
        "publisherProviderAccountId" : "act_f7a99e66-5d2b-fe62-df24-36e7049f0a3e"
      },
      "totalCharges" : 461.11
    } ],
    "amountDue" : 461.11,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "dataIngestionMethod" : "BILL_UPLOAD",
    "dueDate" : "2023-01-23",
    "id" : "stm_b407daa4-71f0-0d16-3165-bb1f9171eb1d",
    "invoiceNumber" : "6633179451935500554",
    "normalizedSummaryAccountNumber" : null,
    "outstandingBalance" : 461.11,
    "periodEndDate" : "2023-01-09",
    "periodStartDate" : "2022-12-10",
    "provider" : {
      "country" : "USA",
      "id" : "prv_746a3349-3c5c-4020-23a9-39db1d094027",
      "name" : "Example Non-RTCV Provider",
      "supportsCredentialValidation" : false
    },
    "statementDate" : "2023-01-09",
    "summaryAccountNumber" : null,
    "totalCharges" : 461.11,
    "type" : "BILL"
  },
  "errors" : [ ],
  "eventType" : "NEW_DATA_AVAILABLE",
  "id" : "whk_9eeba4c4-72af-fd35-c9d2-633ab75a91c1",
  "resource" : "STATEMENT"
}

File Data Extraction Fails

  1. File is uploaded
  2. File reviewed and unable to extract data
  3. File failure event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountNumbers" : [ ],
    "correlationId" : "example-correlation-id",
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "fileName" : "example-file-name.pdf",
    "id" : "fil_df563657-df8c-6ec8-5b33-1a7da258fe55",
    "isCustomerActionRequired" : true,
    "lastModifiedAt" : "2024-02-21T00:00:00.000+00:00",
    "provider" : null,
    "statementDate" : null,
    "statementId" : null,
    "status" : "FAILURE",
    "statusDetails" : [ "TIMED_OUT" ],
    "transferMethod" : "CLIENT"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_7cf801a5-b023-36a6-6aad-7dcd0d195c5e",
  "resource" : "FILE"
}

Deletion Successful

  1. Deletion is scheduled via deletion log
  2. Deletion is performed
  3. Deletion successful event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "accountCount" : 6,
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "createdBy" : "[email protected]",
    "deletionTargetId" : "crd_24a64cfd-a75c-a8b0-5e7c-1c99699306c9",
    "fileCount" : 0,
    "id" : "del_bb79dbe4-562f-9035-5177-17f4224479e2",
    "meterCount" : 4,
    "siteCount" : 0,
    "statementCount" : 2,
    "status" : "SUCCESS"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_d0b7c43d-8063-d22a-e60a-01e8e968468d",
  "resource" : "DELETION"
}

Download Ready

  1. Download is requested
  2. Download is prepared
  3. Download status change event emitted: 
    {
  "createdAt" : "2024-02-21T00:00:00.000+00:00",
  "data" : {
    "createdAt" : "2024-02-21T00:00:00.000+00:00",
    "downloadMethod" : "IN_BROWSER",
    "id" : "dwl_e4da9de7-0211-deef-24b3-af21e714c19b",
    "status" : "SUCCESS",
    "token" : "abcd"
  },
  "errors" : [ ],
  "eventType" : "STATUS_CHANGE",
  "id" : "whk_26539b9e-6cd9-b5a3-6c73-3e93ae2c9024",
  "resource" : "DOWNLOAD"
}