The shape of the integration
1
One key for your desk
ScripX issues your desk one API key. Every call is authenticated with
X-ScripX-Key; tenant isolation is enforced on every call. See Authentication.2
A child key per client service
Mint scoped child keys yourself, one per sub-account or app, each carrying a subset of your scopes. Revoke any of them instantly without touching the parent.
3
Register and verify firms from your UI
Register each client firm and verify it inside your own product, completed with a one-time authorization code. The onboarding experience stays fully yours; the verification machinery stays with ScripX.
4
A direct quote per credit
For each connected firm, list its credits and take one direct quote per credit at ScripX’s price. No aggregation or price modelling on your side.
Scale is built in
- Hundreds of firms, one integration. Register once per firm, then trade every credit through the same quote-and-order loop.
- One audit trail across the book. The audit export is hash-chained and verifiable offline, across every client on your desk.
- Firm states you route on. Your UI sends
verification_pendingandreconnect_neededfirms back to their connect link;connectedfirms trade.
White-label the experience
Set your brand on the surfaces ScripX renders:PUT /v1/branding in the contract; logo_url must be HTTPS.
Build against sandbox first
Everything a platform needs to build client-facing screens works on ascripx_test_… key alone: market snapshot and SSE stream for a live price panel, quote to order to positions for the trade flow, and webhooks with signature verification for real-time status. See Environments, then swap the key for scripx_live_… to go live.
Real-time status without polling
Register a webhook fororder.matched, settlement.settled and payout.sent, verify the signature on the raw body, and dedupe on X-ScripX-Delivery. Your product feels alive without a single poll. See the Webhooks guide.