The Broker Panel API lets you connect your systems to supported broker workflows. Use it to manage services, process service requests, and get reports.
For endpoint details, open the API Reference tab.
API Center
Only broker admins can open the API Center. It has these areas:
- API Keys: Create, regenerate, activate, deactivate, and delete API keys. You can select Live or Sandbox and set access scopes.
- API Firewall: Add or remove IP addresses in the shared IP whitelist.
- API Documentation: Open the in-app documentation for authentication, the firewall, and supported endpoints.
- API Logs: Review request activity and filter Live and Sandbox traffic.
API Firewall And IP Whitelist
You can enable IP restriction for each API key. The API Firewall IP whitelist is shared by all restricted keys for your broker account.
Requests And Responses
Send request bodies as JSON when an endpoint needs a body. Set Content-Type to application/json.
Successful responses contain success: true and a data value. List responses can also contain pagination data.
Error responses contain success: false. The error object contains a code and a message. Use the HTTP status and the error details to handle the result.
The API checks authentication, the IP whitelist, the rate limit, and access scopes before it runs the endpoint. The API isolates records by broker account.
Sandbox
Create a Sandbox API key to test an integration. Sandbox requests return simulated responses. They do not make real service changes or write business records.
Use a Live API key only when you are ready to run real workflows. Live requests can change production data and services.
Rate Limit
The API applies a rate limit to each API key. If a key reaches its configured limit, the API returns an HTTP 429 response. Follow the Retry-After response header before you send another request. Last modified on August 2, 2026
