> ## Documentation Index
> Fetch the complete documentation index at: https://docs.truthlocks.com/llms.txt
> Use this file to discover all available pages before exploring further.
# Record velocity action
> Record a subject action and evaluate it against velocity-based anomaly scoring. Auto-ingests a risk signal when the velocity score reaches 60 or above.
Records an action for a subject and updates rolling window counters across four time windows (1 m, 5 m, 1 h, 24 h). A weighted velocity score is computed from the updated counts. When the score reaches 60 or above, a risk signal with `signal_type: "velocity"` is automatically ingested into the [risk signal pipeline](/guides/risk-signals).
See the [velocity and anomaly scoring guide](/guides/velocity-scoring) for the full workflow, scoring model, and integration patterns.
## Scoring weights
| Window | Weight | Purpose |
| :-------- | :----- | :------------------------- |
| 1 minute | 30 | Burst detection |
| 5 minutes | 20 | Sustained short-term abuse |
| 1 hour | 10 | Medium-term patterns |
| 24 hours | 5 | Persistent anomalies |
## Request
Identifier of the subject performing the action (user ID, device ID, IP address, or any entity reference).
The type of action being recorded (e.g. `login.failed`, `api.request`, `transaction.create`).
Source IP address associated with this action.
## Response
The subject that was recorded.
The action type that was recorded.
Current action counts per rolling window: `1m`, `5m`, `1h`, `24h`.
Weighted velocity score (0–100). Scores at or above 60 trigger automatic signal ingestion.
`true` if a risk signal was auto-ingested because the velocity score reached 60 or above.
UUID of the auto-ingested risk signal (only present when `signal_ingested` is `true`).
## OpenAPI
````yaml mint-openapi.yaml POST /v1/risk/velocity/record
openapi: 3.0.3
info:
title: Truthlocks API
description: >
Truthlocks is a universal verification infrastructure for documents,
credentials, and digital assets.
This specification defines the canonical API for interacting with Truthlocks
services.
## Base URLs
- **Production**: `https://api.truthlocks.com`
- **Sandbox**: `https://sandbox-api.truthlocks.com`
## Authentication
- **API Keys**: Use `X-API-Key` header for machine-to-machine operations
- **Bearer Tokens**: Use `Authorization: Bearer ` for user-initiated
operations
## Tenant Identity
In production, tenant identity is derived from the authenticated context
(API key or JWT).
The `X-Tenant-ID` header is ignored in production to prevent spoofing.
version: 1.0.0
contact:
name: Truthlocks Support
url: https://truthlocks.com/support
email: support@truthlocks.com
servers:
- url: https://api.truthlocks.com
description: Production API
- url: https://sandbox-api.truthlocks.com
description: Sandbox Environment
security:
- APIKey: []
tags:
- name: Authentication
description: API key and token management
- name: Issuers
description: Issuer registration and trust management
- name: Keys
description: Cryptographic key management for issuers
- name: Attestations
description: Attestation lifecycle (mint, revoke, supersede)
- name: Verification
description: Attestation verification and proof bundles
- name: Governance
description: Issuer governance workflows (admin only)
- name: Identity
description: Organization, user, and role management
- name: Audit
description: Audit event queries
- name: Platform
description: Platform administration (super admin only)
- name: Platform Review
description: Staff review workflows for issuer applications
- name: Tenant Console
description: Tenant profile and lifecycle endpoints
- name: Health
description: Service health and readiness endpoints
- name: Risk
description: Risk signal ingestion and fraud detection
- name: Risk Enforcement
description: Risk enforcement actions — block, challenge, quarantine, and configuration
- name: Billing
description: Billing, subscription, and addon management
- name: Machine Identity
description: >-
Machine Agent Identity Protocol (MAIP) — agent registration, sessions,
trust, witness, compliance, orchestration, and observability
externalDocs:
description: Transparency read-only API (separate service spec)
url: >-
https://github.com/truthlocks/truthlock/blob/main/docs/transparency/openapi.yaml
paths:
/v1/risk/velocity/record:
post:
tags:
- Risk
summary: Record velocity event
description: Records a velocity event for rate-limit and anomaly detection.
operationId: risk.velocity.record
requestBody:
required: true
content:
application/json:
schema:
type: object
required:
- subject_id
- action
properties:
subject_id:
type: string
action:
type: string
description: Action type being tracked
metadata:
type: object
responses:
'201':
description: Velocity event recorded
content:
application/json:
schema:
type: object
properties:
event_id:
type: string
current_count:
type: integer
window:
type: string
'401':
description: Authentication required
content:
application/json:
schema:
$ref: '#/components/schemas/ErrorEnvelope'
security:
- APIKey: []
components:
schemas:
ErrorEnvelope:
type: object
required:
- code
- message
- http_status
properties:
code:
type: string
description: Machine-readable error code
enum:
- AUTH_REQUIRED
- AUTH_INVALID
- PERMISSION_DENIED
- TENANT_IDENTITY_UNVERIFIED
- NOT_FOUND
- VALIDATION_ERROR
- CONFLICT
- PAYLOAD_TOO_LARGE
- RATE_LIMIT_EXCEEDED
- QUOTA_EXCEEDED
- SERVICE_UNAVAILABLE
- INTERNAL_ERROR
message:
type: string
description: Human-readable error message
http_status:
type: integer
description: HTTP status code
retry_after_ms:
type: integer
description: Milliseconds to wait before retrying (for rate limits)
details:
type: object
description: Additional error context
example:
code: AUTH_REQUIRED
message: Authentication required
http_status: 401
securitySchemes:
APIKey:
type: apiKey
in: header
name: X-API-Key
description: API key for machine-to-machine authentication
````