TrustShield
Get TrustShield

Developer portal

Build trust checks into your own workflows

API documentation for integrating Trust Scores, Risk Scores, Security Reports, and enterprise trust decisions into backend workflows.

Quick StartAPI ReferenceExamples

Quick start

Create an API key, submit a trust signal, receive a score, inspect risk indicators, and apply your product policy.

Read getting started
Enterprise Trust API
curl $NEXT_PUBLIC_API_BASE_URL/api/public/analyze/url \
  -H "Authorization: Bearer $TRUSTSHIELD_API_KEY" \
  -H "Content-Type: application/json" \
  -d '{"url":"https://example.com/login"}'
{
  "trustScore": 86,
  "verdict": "trusted",
  "recommendation": "allow",
  "signals": [
    "valid_tls",
    "no_suspicious_redirects",
    "domain_reputation_positive"
  ],
  "explanation": "No high-risk indicators were detected."
}

Developer documentation

Search pages, endpoints, examples, and error handling guidance without leaving the developer portal.

Getting StartedPageCreate a key, authenticate, verify a URL, and read the trust decision.AuthenticationPageUse API keys, bearer tokens, rotation practices, and future OAuth patterns.REST APIsPageExplore TrustShield URL, QR, message, payment, browser, and APK APIs.ExamplesPagePractical integration examples for URL, QR, message, and payment checks.SDKsPagePlanned SDKs for Java, Kotlin, TypeScript, Python, Go, Flutter, and React Native.Rate LimitsPageDesign resilient clients for quota windows, bursts, retries, and 429 handling.

Getting Started

Create a key, authenticate, verify a URL, and read the trust decision.

Authentication

Use API keys, bearer tokens, rotation practices, and future OAuth patterns.

REST APIs

Explore TrustShield URL, QR, message, payment, browser, and APK APIs.

Examples

Practical integration examples for URL, QR, message, and payment checks.

SDKs

Planned SDKs for Java, Kotlin, TypeScript, Python, Go, Flutter, and React Native.

Rate Limits

Design resilient clients for quota windows, bursts, retries, and 429 handling.

Security Controls

Secure integration guidance for HTTPS, validation, OWASP, logging, and privacy.

Error Codes

Understand error responses, likely causes, and recommended resolutions.

OpenAPI

Prepare for Swagger, Postman collections, generated clients, and schema-driven docs.

Platform Support

Understand Android availability and web, mobile, and server integration paths.

Rate limits

Example limits are documented for implementation planning. Production quotas are governed by workspace policy, module access, and enterprise agreements.

View rate limit guidance

SDK roadmap

Planned SDKs target TypeScript, Java/Kotlin, Python, and server-side JVM integrations after the public OpenAPI schema is stabilized.

Explore SDKs

API error handling

Production integrations should treat validation failures, authentication issues, rate limits, network failures, and service errors as typed application states with safe user messaging and correlation-aware logs.

Review error codes