Skip to main content
GET
/
v1
/
risk
/
signals
/
{id}
Get Risk Signal
curl --request GET \
  --url https://api.truthlocks.com/v1/risk/signals/{id} \
  --header 'X-API-Key: <api-key>'
{
  "id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "tenant_id": "3c90c3cc-0d44-4b50-8888-8dd25736052a",
  "source": "device_fingerprint",
  "signal_type": "velocity_anomaly",
  "score": 0.85,
  "details": {
    "ip": "203.0.113.42",
    "country": "US",
    "reason": "multiple_accounts_same_device"
  },
  "entity_type": "user",
  "entity_id": "usr_8f14e45f",
  "created_at": "2023-11-07T05:31:56Z"
}
Retrieves a specific risk signal by its unique ID. Returns the full signal record including source, score, subject reference, and any attached metadata.

​
Parameters

​
id
string
required
The UUID of the risk signal to retrieve

Authorizations

​
X-API-Key
string
header
required

API key for machine-to-machine authentication

Path Parameters

​
id
string<uuid>
required

Response

Risk signal details

​
id
string<uuid>
​
tenant_id
string<uuid>
​
source
string

Origin of the signal (e.g. device_fingerprint, ip_reputation, email_verification, document_analysis, behavioral)

Example:

"device_fingerprint"

​
signal_type
string

Classification of the risk signal

Example:

"velocity_anomaly"

​
score
number<float>

Risk score between 0 (no risk) and 1 (highest risk)

Required range: 0 <= x <= 1
Example:

0.85

​
details
object

Arbitrary metadata associated with the signal

Example:
{
  "ip": "203.0.113.42",
  "country": "US",
  "reason": "multiple_accounts_same_device"
}
​
entity_type
enum<string>

The type of entity this signal relates to

Available options:
user,
device,
ip,
document,
session
Example:

"user"

​
entity_id
string

Identifier of the entity being evaluated

Example:

"usr_8f14e45f"

​
created_at
string<date-time>