Documentation Intro

Welcome to Subphonic documentation. Explore our products, find support resources, and learn how to integrate with our platform.

How can we help?

This documentation

This documentation provides comprehensive guidance for all Subphonic products, including feature walkthroughs, troubleshooting, integrations, and tips for getting the most from the platform.

• ℹ️ Help with getting help
• 📖 Full walkthroughs of all product features
• 🩺 Quick self-help steps (password reset etc.)
• ❓ Known error codes and how to resolve them
• 🧑‍💻 Getting started with integrations
• ✨ What's new - Highlights of new products, feature updates, improvements, and research from the Subphonic team.
• 🚑 Support - Need a little extra help? Our Customer Support team is ready to assist.

Our products

Use the menu on the left to jump directly to specific support and integration documentation about our core products:

• 🎙️ Subphonic Focus
• 💳 Subphonic Transact
• 🕸️ Subphonic AI API

Using this guide

1. The top menu will take you between our user documentation, API documentation and News blog
2. The expandable menu lets you jump directly to the section or product documentation you need
3. A direct link to our support portal if you need further help
4. Toggle for dark/light mode
5. This help document explains how to get the most from our help centre. A guide for using the guide!
6. An example of our easy-to-follow diagrams. The numbered descriptions below each image correspond to the numbered callouts, helping guide you through each item
7. A local table of contents lets you jump directly to specific topics within the current page

What you need to know

Whether you're using our platform or building an integration, our guides are designed to help you get started quickly, ddiscover powerful features and make the most of the platform.

If You’re a User...

The user guide is designed to make every task easy, no matter how complex it might seem at first glance. Here’s how it can help you maximise the platform:

1. Get the most from the platform: Learn every feature, from everyday tasks to advanced settings

2. Save time with shortcuts – Discover tips, keyboard shortcuts, and hidden features that improve your workflow

3. Unlock advanced capabilities – Explore customisation options, filters, and powerful tools designed for experienced users

4. Stay up to date – Keep track of new features, improvements, and enhancements as they're release

If You’re a Developer...

Our API documentation is designed to help you integrate quickly and confidently. With interactive, OpenAPI-compliant documentation, our developer guides give you everything you need to get up and running quickly and efficiently.

1. Interactive API Guides to Get You Started: (Coming soon) Our API documentation is more than just text, it’s a hands-on, interactive experience. Test API calls right in the guide, check responses in real-time, and make sure your setup is just right. This lets you troubleshoot early and avoid surprises later

2. Comprehensive Endpoint Documentation: Every endpoint is fully documented, with clear descriptions, parameter requirements, and sample responses, so you’ll know exactly how to send requests and handle responses. Say goodbye to guesswork and focus on building

3. Standardised with OpenAPI for Smooth Integration: Built on the OpenAPI standard, our API docs ensure a clear and consistent experience. Whether you’re new to APIs or an experienced developer, OpenAPI provides structured, reliable guidance across the board, with built-in tools to make your integration process faster

4. Best Practices and Use Cases: We’ve included best practices and example use cases to inspire and guide you as you build. Whether you’re automating workflows, creating custom dashboards, or building a full-fledged application, our examples will get you off to a solid start and save you time in the process

5. End-to-End Support for Developers: We understand that building an integration goes beyond documentation. From sandbox environments for safe testing to support channels if you hit a roadblock, we’re here to make your development experience smooth and seamless

Ready to Get Started?

You're all set! If you need help getting started or have any questions, our Customer Support Team is always happy to help.