Getting Started with Trustist Ecommerce API

The Trustist Ecommerce (TE) API enables you to integrate identity verification, KYC/AML checks, and payment processing directly into your applications. This guide will help you get up and running quickly.

📌 New to Trustist? Start by creating an account and requesting TE API keys from Trustist. See our API Keys Guide for detailed instructions.
Important - API permissions:

TE API access is permission based. Your key must be configured for the operations you call, such as payments, customer management, onboarding, AIS, payouts, or webhooks.

See the API Keys Guide for setup, permissions, and merchant context guidance.

What Can You Build?

👥

Customer Management

Create and manage customer records for your organisation. Store customer details securely and associate them with identity verification sessions and payments.

  • Create customers with basic details
  • Search and retrieve customer information
  • Manage customer lifecycle
View Customer Guide
✅

Identity Verification

Conduct KYC (Know Your Customer) checks and AML (Anti-Money Laundering) verification for your customers.

  • Create identity verification sessions
  • Verify identity documents
  • Access verification results
View Verification Guide
🏦

Bank Account Access (AIS)

Access customer bank account information for affordability checks and proof of wealth verification via Open Banking.

  • Retrieve bank account details
  • Access real-time balances
  • View transaction history
  • Automated matching across sessions
View AIS Guide
💳

Payment Processing

Accept payments in-face or via API, with Pay by Bank-first journeys, hosted redirects, embedded options, and attempt-driven control.

  • In-face workflows (TrustistTransfer, QR, NFC)
  • Hosted payment pages
  • Unified payment attempts for bank and card
  • Bank redirect payments with direct auth URL handling
  • Real-time payment status
View Payments Overview
🔔

Webhooks & Events

Receive real-time notifications when important events occur, enabling you to respond immediately to customer actions.

  • Identity verification session completion notifications
  • Payment status updates
  • Custom webhook endpoints
  • Event filtering
View Webhooks Guide

Quick Links

🔐 Authentication

Learn how to authenticate your API requests using Hawk authentication.

Read Guide
🚀 Quick Start

Get up and running with code examples in multiple languages.

Start Building
JavaScript SDK

Hosted redirect, embedded payments, and standing orders in the browser.

View SDK
Payments Overview

Understand payment models, ownership boundaries, and how to choose a payment integration path.

Read Guide
📖 API Reference

Complete API endpoint documentation with request/response examples.

View Reference

Core Concepts

Accounts & Permissions

API operations are scoped to your Trustist organisation. Your API key has specific permissions that control what operations you can perform:

Permission Description
create_customer Create new customer records
read_customers Retrieve customer information
create_onboard_session Initiate identity verification sessions
read_onboard_session View identity verification session details
read_onboard_results Access verification check results
manage_webhooks Register and manage webhook endpoints
create_payment Process payments (requires merchant ID)
read_payment Retrieve payment status
create_standing_order Set up Direct Debit mandates
read_standing_order View standing order details
read_customer_bank_accounts View customer bank accounts from AIS
read_customer_bank_account_balances Retrieve customer bank account balances
read_customer_bank_account_transactions Access customer transaction history
Payment Permissions: Payment-related permissions (create_payment, read_payment, etc.) require merchant context. If your API access can operate across more than one merchant, include X-Trustist-MerchantId or contact support to confirm the correct setup.

API Versioning

All API endpoints are versioned and accessed via the /v1/ path prefix. For example: 

https://api.trustist.com/v1/customers
https://api.trustist.com/v1/onboard/sessions

Response Format

All responses are returned in JSON format. Successful responses typically return:

  • 200 OK - Successful GET request
  • 201 Created - Successful POST request that created a resource
  • 204 No Content - Successful DELETE request

Error responses include:

  • 400 Bad Request - Invalid request data
  • 401 Unauthorized - Missing or invalid authentication
  • 403 Forbidden - Insufficient permissions
  • 404 Not Found - Resource doesn't exist
  • 500 Internal Server Error - Server-side error

Next Steps

Now that you understand the basics, proceed to:

  1. Set up authentication with your API keys
  2. Follow the quick start guide to make your first API call
  3. Use the sandbox environment to test your integration
  4. Choose your payment model (in-face, hosted, embedded, or attempt-driven)
  5. Implement payment attempts when you need direct bank/card execution control
  6. Explore the complete API reference for detailed endpoint documentation
💬 Need Help? Contact our support team at [email protected] or visit the help centre.