Jump to Content
API Reference
v1.0
Log In
API Reference
Log In
v1.0
API Reference
returns the full email template
JUMP TO
Helpdesk
auth
Authenticate a user
post
Authenticates a user using a one-time pin
post
Register a new user
post
Request Password Reset
post
Reset Password using Token
post
Update User Password Using Reset Token
put
Request a Password Reset Token
post
Get digital communication
post
resends a registration token
put
Test if a token is valid
get
schema
Get Supported Authentication Schema Properties
get
Get Customer Schema
get
invite
Get Authentication Invitation Details
get
Register Using Invitation
post
Associate an Invitation Link with an Existing Login
put
auth_legacy
returns the schema of supports properties
get
Register
post
Login
post
Accountless Login
post
Resend Verify
post
Verify Account
put
check is a token is valid
get
Reset Password
post
Forgotten Password
post
Get Profile
get
Update Profile
put
appointment
Get Appointments
get
Add Appointments
post
Delete Appointment
del
core
Get customer account references
get
Get the balance for a specified account.
get
Get the benefits indicator for a specified user.
get
Get the full benefits calculation for a specified user.
get
Get a list of customer's saved cards.
get
Get a list of customer's direct debit details.
get
Get payment plans associated with an account reference.
get
Get a list of payments.
get
Get transactions for a specified account.
get
Get the schema of supported properties.
get
Get Property
get
Add Property
post
Update Property
put
customer
Get customer profiles
get
Link new Account
post
Verify Login
post
documents
Get Documents
get
Upload Document
post
Get Account Documents
get
Get account documents by FCAID
get
Get Document w/ UUID
get
Delete Document w/ UUID
del
payments
Save 3Ds Card
post
Challenge 3Ds Card
post
Start Apple Pay session
post
Google Pay Gateway Merchant ID
get
Create Direct Debit
post
Start Open Banking Flow
post
Get Direct Debit Merchant
get
Create 3DS Card Payment Plan
post
Direct Debit Account Lookup
post
Challenge 3DSv2 Card
post
Direct Debit Payment Plan
post
Create Apple Pay Payment Plan
post
Create Google Pay Payment Plan
post
Google Pay Challenge Flow
post
Get payment information from token
get
websockets
3DS Authentication
post
3DS Challenge
post
postcode
Get Postcode
get
offer
Make an offer
post
flow
get proeprty flow
get
save data via flow
post
Core API
crm
Read CRM Data
get
Create CRM Data
post
Update CRM Data
put
Delete CRM Data
del
schemas
Get Schemas
get
Get Supported Properties
get
customer
Create Customer
post
Delete Customer
del
Create Account
post
Delete Account
del
List Customer Accounts
get
events
Get Event
get
/heartbeat
check server is up
get
/version
get api version
get
Payments API
Health
Heartbeat
get
Arrangements
Create V1 Arrangement
post
Cancel V1 Arrangement
put
Card V2
Tokenise Card
post
Get Cards
get
Remove a Card
del
Direct Debit
Create Direct Debit
post
Cancel Direct Debit
del
Payment Plan
Single Payment
post
Topup Payment
post
Settlement Payment
post
Weekly Payment
post
Monthly (Date) Payment
post
Monthly (Day) Payment
post
First/ Last Working Day Payment
post
Update Payment Plan
put
Cancel Payment Plan
del
Card V1
Get Cards
get
Tokenise Card
post
Delete Card
del
Dashboards
Dashboard entry operations
Create a dashboard entry
post
Search dashboard entries
post
Get dashboard entry
get
Delete dashboard entry
del
Assign agents to a dashboard entry
post
Assign dashboard entry to a customer
post
Remove dashboard entry from dashboards
post
Unassign agents from dashboard entry
post
adds attachment
post
removes attachment from an entry
post
downloads attachment
post
search by reference
post
Search Entries for specified agent
post
Search Entries by FCCID
post
Search Entries for current agent
post
Dashboard operations
Return a list of dashboards
get
Create a new dashboard
post
Update dashboard
put
Delete dashboard
del
Get a dashboard
get
Get dashboard stats
get
Update the status of a dashboard entry
put
Update the actionDate of a dashboard entry
put
Add comment to dashboard item
post
Add entry to additional dashboards
post
Documents
upload_document
Upload Document
post
get_documents
Get available documents for a FCCID
get
UUID
Download document
get
Delete document
del
update Document information
put
Communications
status
returns 200 if the API is able to retrieve data
get
communication
This route will send a single communication to a customer
post
sends bulk communications targeting segments
post
sends bulk communication based on status and reason
post
sends bulk commination from an uploaded file
post
templates
returns email template meta data
get
returns the full email template
get
updates an email template
put
returns sms template meta data
get
returns sms template
get
returns letter template meta data
get
returns full letter template
get
attachment
Upload an attachment to be used as an template attachment
post
Update an attachment
put
Delete an attachment and remove it from all templates
del
Get full attachment data
get
Get all attachments
get
Generate a signed url to download an attachment
get
Search API
/heartbeat
get
get
/reference
get
get
/contact
get
get
/dob
get
get
/name
get
get
Powered by
returns the full email template
Ask AI
get
https://example.com/comms-api/template/email/
{id}
Language
Shell
Node
Ruby
PHP
Python
Response
Click
Try It!
to start a request and see the response here!
