Getting started
Introduction
Welcome to the SwiftSwitch Partner API.
This API enables partners to programmatically submit new leads into the SwiftSwitch platform. Each successful submission generates a reference number, allowing partners to track leads and raise self-bills for referral fees. Designed for ease of integration, the API supports standard RESTful principles with JSON-formatted requests and responses.
Key features
Instantly add customer leads into the SwiftSwitch system.
Each successful submission returns a lead ID and confirmation message.
Base URL
Use the following base URL for all API requests.
Authentication
All requests must be authenticated using your unique x-api-key. Include this key in the request headers for every API call.
401 status code.Response codes
| Status | Description |
|---|---|
| 201 | Success — Lead Submitted |
| 400 | Missing or Invalid Data |
| 401 | Missing or invalid API key |
| 500 | Internal Server Error |
Content type
All requests and responses use the application/json content type.