Documentation

The Txnworks scoring API accepts a transaction payload, computes 140+ behavioral signals across six categories, and returns a risk score 0–1000, ALLOW/REVIEW/BLOCK label, contributing signals with weights, and latency_ms — all within 50ms. Start with the Quickstart to send your first POST /v1/score in under 10 minutes, or go directly to the API Reference for full parameter and response schema documentation.

Quickstart Score your first transaction in 10 minutes. Install the SDK, initialize the client, POST your first score request, and read the response. API Reference Full endpoint documentation. POST /v1/score, POST /v1/feedback, GET /v1/cases, GET /v1/score/{id}. Parameters, response schemas, and code examples.

Authentication

All API requests require an API key passed in the Authorization header:

Authorization: Bearer txnw_sk_your_api_key

API keys are scoped to either score-only or full-access. Request your key via the early access form.

Base URL

https://api.txnworks.com/v1

Rate limits

Rate limits are based on your plan tier:

  • Starter: 100 requests/second
  • Growth: 500 requests/second
  • Scale: 2,000 requests/second

Rate limit headers are included in every response: X-RateLimit-Limit, X-RateLimit-Remaining, X-RateLimit-Reset.

Response format

All responses are JSON. Successful responses return HTTP 200 with a data object. Errors return the appropriate HTTP status code with an error object containing code and message.