Skip to main content

Legal

Ṣọ Shield API Terms

The terms governing use of the Ṣọ Shield API and the developer dashboard.

Effective: July 25, 2026Last Updated: July 25, 2026

These API Terms are an agreement between SO Labs (“we,” “our,” or “us”) and the person or organisation that registers for API access (“you” or the “Customer”). They apply in addition to our Terms of Service and Privacy Policy. Where a point is specific to the API, these API Terms apply.

Document status. This version was last updated on 25 July 2026. It is written in plain English and describes how the API works today. It has not yet been reviewed by a qualified lawyer. A lawyer admitted in the relevant jurisdictions should review it before it is published as the final, binding version.

Read this first: detection is probabilistic. The API returns a judgement, not a fact. It will sometimes flag safe content and sometimes miss real threats. It is an aid to your own security controls, never a guarantee of safety, and it must not be the only control protecting a system or a person. Section 08 sets this out in full.

01Scope

These API Terms govern:

  • The Ṣọ Shield API, served at api-service.soone.soemailsecurity.com, including all endpoints, responses, and documentation.
  • The developer dashboard, where you create and manage API keys, view usage, and manage your plan.
  • Any sandbox or test environment we make available for development.

By creating an API key or sending a request to the API, you accept these API Terms. If you are accepting on behalf of an organisation, you confirm you have authority to bind it.

02Accounts and API Keys

  • Keys are issued in the developer dashboard. Production keys begin with so_live_. Sandbox keys begin with so_test_.
  • A key is shown in full once, at the moment it is created. We store only a one-way hash of the key and a short display prefix so you can tell your keys apart. We cannot recover a lost key, so you will need to create a new one.
  • You are responsible for keeping keys secret. Do not put a production key in client-side code, a mobile app binary, a public repository, or a support ticket.
  • All activity on a key is treated as your activity, and credits used on a key are billed to you.
  • You can rotate or revoke a key at any time in the dashboard. We may rotate or revoke a key if we believe it has been exposed, is being abused, or is being used in breach of these API Terms. Where practical we will tell you first.
  • Tell us promptly at sales@soemailsecurity.com if you believe a key has been exposed.

03Credits and Billing

3.1 How credits work

Every request consumes credits. The cost depends on the endpoint:

  • Email analysis: 5 credits
  • Document compare: 3 credits
  • Business email compromise (BEC) score: 2 credits
  • QR code scan: 2 credits
  • URL analysis: 1 credit
  • Domain check: 1 credit
  • Header validation: 1 credit

Credit costs may change with reasonable notice. Current costs are shown in the developer documentation.

3.2 Plans

  • Free: 3,000 credits per month, no charge.
  • Starter: 29 USD per month, 25,000 credits per month.
  • Growth: 99 USD per month, 75,000 credits per month.
  • Pro: 199 USD per month, 150,000 credits per month.
  • Enterprise: custom credit allowance and pricing under a separate written agreement.

Yearly billing saves about 17 percent against paying monthly. Prices are in US dollars and exclude any applicable taxes. Paid plans are billed in advance and renew automatically until cancelled. Credit allowances reset at the start of each billing period and unused credits do not carry over.

3.3 Malformed requests

Known issue, being fixed. Today, some malformed or invalid requests can still consume credits, because credits are deducted before the request body is fully validated. We think that is the wrong behaviour. We are changing it so credits are charged only after a request passes validation. Until that change ships, if malformed requests have consumed a meaningful number of your credits, contact us at sales@soemailsecurity.com and we will credit your account.

Requests that fail because of a fault on our side are not intended to consume credits. If they do, we will credit your account on request.

04Rate Limits

  • Hourly and daily request limits apply to each plan. Current limits are shown in the developer documentation and in your dashboard.
  • Requests over the limit are rejected with HTTP status 429. Build retry and backoff handling into your integration.
  • Sandbox keys are not rate limited. They are for development and testing only, must not be used in production, and their responses must not be relied on for real security decisions.
  • We may apply short-term limits to protect the service for everyone, including during an incident or an unusual traffic spike.

05Customer Data and Roles

  • Roles. You are the controller of the content you submit to the API. We act as your processor for that content and process it only to return a result to you and to run the service.
  • Your responsibility. You must have the legal right and any consents or notices needed to submit the content, including content that belongs to your own end users or employees. You must not submit content you have no right to submit.
  • Content is not stored. Submitted content, including email bodies, headers, documents, URLs, and images, is analysed in memory and is not written to persistent storage by the API.
  • Metadata is retained. We retain request metadata such as timestamp, endpoint, key identifier, credits used, and response status. We need it for usage accounting, billing, abuse prevention, and debugging.
  • Data processing terms. For enterprise and partner use, a Data Processing Agreement applies. A draft is published at soemailsecurity.com/dpa. Request the signed version from sales@soemailsecurity.com.

06Acceptable Use

You must not:

  • Submit content you do not have the legal right or the necessary consents to submit.
  • Reverse engineer, decompile, or try to extract the models, rules, weights, or source behind the API.
  • Run benchmarks or comparative tests and publish the results without our written consent. Ask us and we will usually say yes, and we would like the chance to check the methodology first.
  • Use the API to build, train, or enrich a competing threat-detection dataset, model, or service.
  • Circumvent rate limits or credit accounting, including by creating multiple accounts, sharing keys, or spreading traffic across keys to avoid a limit.
  • Use the API for anything unlawful, or to build a product whose purpose is unlawful.
  • Interfere with the service, probe it for weaknesses without written permission, or use it to attack anyone.
  • Present API results as your own detection technology in a way that misleads your users about who performs the analysis, where a signed agreement does not permit it.

07Service Levels and Beta Features

  • We offer no uptime commitment on self-serve plans, including Free, Starter, Growth, and Pro. We work to keep the API available and we do not promise a service level on these plans.
  • Uptime commitments, support response times, and remedies for enterprise customers are set out in a separate signed agreement.
  • Features labelled alpha, beta, preview, or early access are provided as is. They may change or be withdrawn at any time and are excluded from any uptime or support commitment.
  • We may change endpoints, response shapes, and credit costs. For changes that break existing integrations we will give reasonable notice through the developer documentation and to the email on your account.

08Accuracy and the Limits of Detection

This section describes what the API can and cannot do. Please read it before you build on it.

  • Detection is probabilistic. The API returns a score or a verdict produced by statistical models and heuristics. It is a judgement about likelihood, not a statement of fact.
  • False positives happen. Safe email, safe links, and legitimate senders will sometimes be flagged as risky.
  • False negatives happen. Real phishing, real business email compromise, real malicious links, and real deepfakes will sometimes be missed. New attacks in particular may pass undetected.
  • It is an aid, not a guarantee. A clean result does not mean content is safe. A flagged result does not prove wrongdoing. Nothing the API returns is a warranty of safety.
  • Do not make it the only control. The API must not be the sole control protecting a system, a payment, an account, or a person. Keep independent controls such as human review, out-of-band verification of payment changes, multi-factor authentication, and your own monitoring.
  • Your decisions remain yours. You decide what to block, quarantine, warn on, or allow. You are responsible for those decisions and for the effect they have on your users, including the effect of wrongly blocking legitimate messages.
  • Not professional advice. API output is not legal, financial, or compliance advice, and it is not a substitute for a security programme.

The API is provided as is and as available, without warranties of any kind, to the fullest extent permitted by law. Section 10 of our Terms of Service sets out the disclaimers and the limitation of liability that apply.

09Changes, Suspension, and Termination

  • Changes to these terms. We may update these API Terms. Material changes will be sent to the email on your account with reasonable notice before they take effect. Continued use after that date means you accept the new version.
  • Suspension. We may suspend or limit API access for abuse, unlawful use, a security risk to the service or other customers, or non-payment. Where practical we will contact you first. For a serious or ongoing risk we may act immediately and explain afterwards.
  • Your cancellation. You may cancel at any time in the developer dashboard. Cancellation takes effect at the end of the current billing period. Fees already paid are non-refundable except as required by law or as stated in our Terms of Service.
  • Effect of termination. On termination or non-payment, your keys stop working and in-flight requests will fail. Remove the integration from anything that depends on it. We keep billing and usage records as required by law and as described in our Privacy Policy.

10Contact

  • API and enterprise enquiries: sales@soemailsecurity.com
  • Mailing address: SO Labs, 7909 Flint Rd SE #202 Calgary AB T2H 1G3 Canada

By creating an API key or sending a request to the Ṣọ Shield API, you acknowledge that you have read, understood, and agree to be bound by these API Terms.