Returns a conversation as it stands: its score, what the score is made of, and optionally the transcript and the score's history. Use it to poll, or to look a conversation up afterwards. It's the same as sending POST /v1/fraud with just the conversation's id.
Note
This is one of a group of endpoints that work together. The setup guide walks through all of them in order. To be told the moment the score changes instead of polling, use Follow the score live.
text
GET https://api.spoofey.com/v1/fraud/:idPath
| Path param | Required | Type | Notes |
|---|---|---|---|
id |
Yes | string | The conversation's id. |
Query
| Query param | Required | Type | Notes |
|---|---|---|---|
include |
No | string | transcript, history, or both as transcript,history. transcript adds every utterance (kept for 30 days). history adds each change of score, with what changed it. |
Example
bash
curl "https://api.spoofey.com/v1/fraud/5fa8406c-0601-4eba-aa70-797917434f29?include=history" \
-H "Authorization: Bearer sk_live_..."Response
200 with the conversation, shortened here. The fields are explained under Reading the score.
json
{
"id": "5fa8406c-0601-4eba-aa70-797917434f29",
"status": "active",
"risk_score": 100,
"band": "critical",
"recommended_action": "end_call",
"scam_type": "bank_impersonation",
"claimed_identity": { "organization": "Chase", "kind": "financial" },
"summary": "Caller claiming to be Chase's fraud team asks for the code just texted and says not to tell the branch.",
"advice": "Hang up and call the number on the back of your card.",
"components": {
"model_score": 92,
"cue_score": 91,
"classification_adjustment": 20,
"adjustments": [
{ "key": "claim_unverified_number", "points": 20, "detail": "Claims to be Chase, but the number isn't tied to any organization." }
]
},
"score_history": [
{ "at": 1790812805000, "score": 91, "ai_score": null, "cue_score": 91, "adjustment": 0, "trigger": "cues" },
{ "at": 1790812809000, "score": 100, "ai_score": 92, "cue_score": 91, "adjustment": 20, "trigger": "ai" }
]
}Errors
| Status | Code | When |
|---|---|---|
404 |
not_found |
No conversation of yours has that id. |