Skip to main content

Electronic Statements, Jobs and Error Codes & OpenAPI 1.10.0

This release syncs the Candescent DI API reference to specification version 1.10.0. The Electronic Statements subcategory is updated with renamed endpoints, refreshed request and response schemas, and expanded category documentation for account and user-level preferences. Jobs reference pages (used when uploading participants to Customer Campaigns — Experience Groups) document paginated import-job monitoring, job status values, and log entry-level error retrieval. The Error Codes Reference and Digital Banking APIs MCP guides are aligned with the updated contracts.

You can view the OpenAPI specification in the public GitHub repository candescent-dev/openapi.

What's New​

Electronic Statements​

  • Electronic Statements — Prerequisites, scopes, required headers, and UXESTMT_* error codes are documented.
  • Retrieve E-Statement Account Preferences — GET /v1/e-statements/{accountId}/disclosures replaces the prior disclosure lookup endpoint with updated descriptions, parameters, and response schema.
  • Update E-Statement Account Preferences — PUT /v1/e-statements/preference updates statement delivery for a single account after disclosure and multi-statement validation.
  • Update E-Statement User Preferences — PUT /v2/e-statements/user/preferences applies a user-level statement delivery choice across eligible accounts. When multi-statement is enabled, some accounts may update successfully while others do not (partial success).
  • Retrieve E-Statement Accounts Opt-In Report — POST /v1/reports/e-statements generates an opt-in report by customer with optional account-type filtering.

Jobs​

  • Jobs Overview — Documents import jobs created by experience-group participant uploads, including scopes, required headers, and job error codes.
  • List Jobs — GET /v3/jobs reference updated with explicit page, size, and sort parameters, optional groupId filtering, and paginated response examples.
  • Get Job by ID — GET /v3/jobs/{jobId} documents job status values (CREATED, PROCESSING, SUCCESSFUL, PARTIAL_SUCCESS, FAILED, CANCELLED, UNKNOWN), upload type (ADD, REMOVE, REPLACE), and record counts.
  • Get Job Errors — GET /v3/jobs/{jobId}/errors documents paginated, sortable row-level error retrieval for PARTIAL_SUCCESS and FAILED imports.

Error Codes Reference​

  • Electronic Statements — UXESTMT_11008 now maps to 404 for invalid paths; UXESTMT_11017 accepts dd-MM-yyyy or yyyy-MM-dd'T'HH:mm:ssXXX date formats.
  • Jobs Overview — Error codes 2000, 2001, and 2003 updated with contract-aligned messages.

Digital Banking APIs​

  • Electronic Statements — Tool names and REST reference links updated for getEStatementsAccountsReportV1 and getEStatementAccountPreferencesV1 with revised sample prompts.

Get Started​

  1. Electronic Statements — Review account and user-level preference endpoints and updated schemas.
  2. Jobs — Monitor participant import jobs and retrieve row-level errors after uploads.
  3. Error Codes Reference — Updated UXESTMT_* and Jobs error mappings.
  4. Digital Banking APIs — MCP tool catalog aligned with the 1.10.0 Electronic Statements endpoints.
  5. Candescent DI API — Updated reference (OpenAPI 1.10.0); use Try It on endpoint pages for live Stage requests.

The Candescent Developer Experience Team