Request Support
Thank you! Your submission has been received!
Oops! Something went wrong while submitting the form.
Home
/
Send Module Guides
CORE MODULE

Overview of APIs

What you'll learn in this guide

‍A quick tour of the APIs available in CX Platform — what each one does, when you'd reach for it, and how they fit together to connect CX Platform with the rest of your systems.

Overview

CX Platform is built API-first. That means every part of the platform can be triggered, queried, or integrated from your own systems — your CRM, registry, customer data platform, core banking system, or anything else in your stack.

Whether you're generating a statement from a core system, sending a one-time pin from a login flow, or pulling correspondence history into a customer service tool, there's an API for it. And because the platform is designed for regulated industries, every call is auditable, secure, and built to handle the volumes you'll throw at it.

If you're integrating with CX Platform for the first time, the patterns will feel familiar — RESTful endpoints, JSON or XML payloads, and standard security via HMAC or JWT.

Key features at a glance

  • RESTful and real-time APIs
  • JSON and XML payload support
  • HMAC and JWT security
  • Built to scale for high-volume workloads
  • ISO 27001 and CPS 234 compliant

‍

A suite of APIs

Here's a quick rundown of each API in the suite and what you'd use it for. Each API has its own dedicated guide with endpoints, payload structure, and example requests — this page is the map.

API What it's for
Document Generation API Generate correspondence on demand across email, SMS, and direct mail by submitting a JSON or XML payload. Near real-time, so it's well suited to triggered communications like welcome packs, statements, and service notifications. The workhorse of the suite, and where most integrations start.
Batch Messaging API Built for high-volume workflows. Submit up to 5,000 pre-rendered documents in a single batch for enhancement, cross-channel processing, and distribution. Handy when you're running large scheduled sends — think monthly statements, regulatory notices, or end-of-year communications.
OTP Verification API Generate and send one-time pins (OTPs) and password reset notifications via email or SMS, synchronously. Useful for login flows, transaction confirmations, and any other moment where you need to verify someone's identity in real time without slowing the experience down.
Document Archival and Retrieval API Pull correspondence back into your core systems. Retrieve correspondence by type, view content, and access attachments — including print and mail records — without your team having to jump into a separate tool to find what they need.
Webhooks and Callbacks Push real-time event data and notifications to external systems. Track delivery, processing, and data capture activities as they happen, so connected platforms can react without polling or waiting for a manual check.

‍

What's next

Each API in the suite has its own guide covering authentication, available endpoints, payload structure, and example requests. If you're ready to start integrating, contact your System Administrator — or if you're still working out which one fits, the table above is a good place to start.

‍

In this GUIDE
Article link for H2 class