Skip to content

Check a message for a scam

What you can call today

Every example here runs against api.xovris.ai with a key from your account’s settings. GET /v1/health and GET /v1/public/status answer without one.

POST
/v1/scam/check
curl --request POST \  --url https://api.xovris.ai/v1/scam/check \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "ok": true, "message": "string", "next": "string", "req": { "text": "string", "subject": "string", "from": { "name": "string", "address": "string" }, "links": [ "string" ], "attachments": [ "string" ], "already": { "clicked": true, "enteredPassword": true, "paid": true, "account": "string" }, "conversation": [ { "from": "them", "text": "string", "name": "string", "at": "string" } ], "image": { "mediaType": "image/png", "data": "string" } } }'

Needs a token that can read and change. A token without change access is refused with token_read_only and the step to take.

Media typeapplication/json
object
ok
boolean
message
string
next
string
req
object
text
string
subject
string
from
object
name
string
address
string
links
Array<string>
attachments
Array<string>
already
object
clicked
boolean
enteredPassword
boolean
paid
boolean
account
string
conversation
Array<object>
object
from
required
string
Allowed values: them me
text
required
string
name
string
at
string
image
object
mediaType
required
string
Allowed values: image/png image/jpeg image/gif image/webp
data
required
string

Example

{  "ok": true,  "message": "string",  "next": "string",  "req": {    "text": "string",    "subject": "string",    "from": {      "name": "string",      "address": "string"    },    "links": [      "string"    ],    "attachments": [      "string"    ],    "already": {      "clicked": true,      "enteredPassword": true,      "paid": true,      "account": "string"    },    "conversation": [      {        "from": "them",        "text": "string",        "name": "string",        "at": "string"      }    ],    "image": {      "mediaType": "image/png",      "data": "string"    }  }}

Done.

Media typeapplication/json
One of:
object
scope
string
verdict
required
string
Allowed values: scam suspicious no_signs_found
score
required
number
reasons
required
Array<string>
doNow
required
Array<string>
signs
required
Array<string>
Allowed values: organizer_lookalike organizer_claims_brand bad_link meeting_host_mismatch qr_in_attachment risky_attachment premium_dial_in callback_number scam_words added_itself
invites
required
number
checkedAt
required
string
brands
required
number
listsReadAt
required
null

Example

{  "scope": "string",  "verdict": "scam",  "score": 1,  "reasons": [    "string"  ],  "doNow": [    "string"  ],  "signs": [    "organizer_lookalike"  ],  "invites": 1,  "checkedAt": "string",  "brands": 1,  "listsReadAt": null}

Not signed in: the token is missing, expired or revoked. The answer says how to get a new one.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Signed in, but this token or role may not do this. The answer names the permission it needs.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Nothing with that id here, or it belongs to another workspace. Nothing was changed.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Any other refusal or failure. The answer says what happened and what to do next.

Media typeapplication/json
object
error
required
object
code
required

A stable code a program can branch on.

string
message
required

What happened, in plain words.

string
nextStep
required

What to do next.

string
decisionId

The recorded authorisation decision, when a role refused it.

string

Example generated

{  "error": {    "code": "example",    "message": "example",    "nextStep": "example",    "decisionId": "example"  }}

Ask Xovris

Open the full page

Your data is never used to train our AI. How your data is kept

A problem is called fixed only once it works again. How each fix is checked

XOVRIS LTD, registered in England and Wales, company number 17499910. Registered office: 66 Paul Street, London EC2A 4NA.