Getting started
Authentication
To ensure secure and authorised access to the SwiftSwitch Partner API, all requests must include a valid API key. API keys are exclusively provided by the SwiftSwitch team.
API key
Your API key is a unique token assigned to your account. It must be included in the header of each request using the x-api-key field.
Replace YOUR_API_KEY with the actual key issued to you by SwiftSwitch.
Access control
Only authorised partners with a valid API key will be able to use the API. Requests without this key — or with an incorrect one — will result in a 401 Unauthorized response.
Include your key with every request
Your API key identifies your partner account and authorises access to the API.
Security guidelines
Keep your API key confidential
Do not expose it in public repositories or client-side applications.
Request a new key if compromised
If you believe your key has been compromised, please contact SwiftSwitch support immediately to request a new one.