An API overview for the new user – introducing our core design principles
Everything you need to get up and running with the Seccl API
Visit nowSimple, powerful tools to quickly build investment solutions into your application.
Coming soonAt Seccl, we build reliable, secure and efficient APIs designed to meet the needs of modern investing. Our API design principles show our commitment to real-time processing and enterprise-grade reliability, while being agile enough to grow with your business. These core concepts guide our approach to API design, ensuring you can build mission-critical financial services with confidence:
Seccl offers multiple authentication protocols based on your risk appetite. Our authentication is managed via Okta Auth0
Idempotency ensures that repeated API requests don't result in unintended duplicate transactions, providing safety for retries during network issues or timeouts. When making POST, PUT, PATCH, or DELETE requests to Seccl's API, you can include an idempotency key in the request header to guarantee that multiple identical requests will result in only one execution.
To use idempotency, include a UUID v4 formatted key in your request header. If you retry a request with the same key within 72 hours, you'll receive the same response as the original request. This is particularly important for financial operations where avoiding duplicates is crucial. While idempotency keys are optional, we strongly recommend their use for any state-changing operations.
The platform uses webhooks for comprehensive event notification across all resource interactions. Where possible, webhooks contain the complete resource data, eliminating the need for subsequent API calls to fetch updated information. This includes eventual consistency updates (both success and error states), inbound flows and manual operations such as reconciliation activities (should they arise). Any change to platform resources triggers a corresponding webhook, ensuring systems remain synchronised. Webhook availability can be extended through account management if additional notification needs are identified.
We design our systems to accommodate your reconciliation needs by supporting external reference mapping across all relevant resources. This principle ensures seamless integration between Seccl and your internal systems. Where available this can be sent to us in the following format: 256 characters, alphanumeric, spaces, dashes and underscores only and stored against the resource and available on Webhooks and GET requests.
Our platform scales with your business. Rather than enforcing rigid limits, we design our rate limiting around your specific load patterns and scaling needs. When limits are reached, requests receive a 429 'Too Many Requests' response, along with standard rate limit headers showing current limits, remaining requests and reset timing. We recommend implementing exponential backoff strategies in your applications to handle these. Before going live, please share your expected usage patterns—including peak volumes, daily patterns, and growth projections—so we can configure appropriate limits for your business needs. This approach ensures reliable service delivery while maintaining platform stability for all users.
The platform's APIs support real-time data access as the primary and recommended interaction model. For scenarios requiring large periodic data extracts, such as end-of-day reporting, SFTP-based delivery can be arranged through account managers. This complementary service supports specific business needs while maintaining the platform's focus on real-time API operations.
The platform maintains a single codebase, focusing on continuous evolution rather than maintaining multiple API versions. This approach ensures all clients benefit from the latest improvements while providing clear migration paths for changes.
Error responses are designed with standardisation in mind. This approach aims to provide machine-readable yet human-friendly error responses, enabling both automated processing and efficient debugging. The error handling design delivers actionable and contextual errors, including problem type identification, clear descriptions, and request traceability through unique identifiers.
The platform is built to enterprise standards with clear service level commitments, ensuring reliable performance for business-critical operations. These service levels encompass availability, response time, and recovery objectives.
Service availability SLA
API response time (95th percentile)