Skip to content

Read what is exposed about you

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.

GET
/v1/exposure
curl --request GET \  --url https://api.xovris.ai/v1/exposure \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

Done.

Media typeapplication/json
object
plan
required
object
addresses
required
One of:
object
on
required
boolean
domainsAndBrand
required
One of:
object
on
required
boolean
sources
required
object
breaches
required
object
name
required
string
on
required
boolean
message
required
One of:
string
attribution
required
One of:
object
text
required
string
url
required
string
lookalikes
required
object
method
required
string
on
required
boolean
certificateTransparency
required
object
name
required
string
on
required
boolean
reports
required
object
netcraft
required
boolean
registrarEmail
required
boolean
watches
required
Array<object>
object
id
required
string
kind
required
string
value
required
string
display
required
string
state
required
string
proof
required
One of:
object
waitingFor
required
string
linkSentAt
required
One of:
string
linkExpiresAt
required
One of:
string
dnsRecord
required
One of:
object
name
required
string
type
required
string
value
required
string
by
at
lastCheckedAt
required
One of:
string
problem
required
One of:
string
lookalikesKnown
required
One of:
number
coverage
required
object
key
additional properties
findings
required
Array<object>
object
id
required
string
watchId
required
string
kind
required
string
subject
required
string
display
required
string
severity
required
string
Allowed values: high medium low critical
title
required
string
words
required
string
nextStep
required
string
evidence
required
object
key
additional properties
likelyYours
required
boolean
state
required
string
dismissed
required
One of:
string
firstSeen
required
string
lastSeen
required
string
alertedAt
required
One of:
string
responses
required
Array<object>
object
id
required
string
findingId
required
string
kind
required
string
Allowed values: guided identity_reset lookalike_report
state
required
string
Allowed values: done running waiting incomplete
verified
required
boolean
verifiedAt
required
One of:
string
words
required
One of:
string
steps
required
Array<object>
object
id
required
string
words
required
string
state
required
string
Allowed values: done failed unavailable pending submitting
ref
One of:
string
readBack
One of:
string
to
One of:
string
runId
required
One of:
string
decisionId
required
One of:
string
requestedBy
required
string
createdAt
required
string
finishedAt
required
One of:
string
counts
required
object
watching
required
number
waitingForProof
required
number
open
required
number
critical
required
number
high
required
number
resolved
required
number
empty
required
One of:
string

Example

{  "plan": {    "addresses": {      "on": true    },    "domainsAndBrand": {      "on": true    }  },  "sources": {    "breaches": {      "name": "string",      "on": true,      "message": "string",      "attribution": {        "text": "string",        "url": "string"      }    },    "lookalikes": {      "method": "string",      "on": true    },    "certificateTransparency": {      "name": "string",      "on": true    },    "reports": {      "netcraft": true,      "registrarEmail": true    }  },  "watches": [    {      "id": "string",      "kind": "string",      "value": "string",      "display": "string",      "state": "string",      "proof": {        "waitingFor": "string",        "linkSentAt": "string",        "linkExpiresAt": "string",        "dnsRecord": {          "name": "string",          "type": "string",          "value": "string"        },        "by": null,        "at": null      },      "lastCheckedAt": "string",      "problem": "string",      "lookalikesKnown": 1,      "coverage": {}    }  ],  "findings": [    {      "id": "string",      "watchId": "string",      "kind": "string",      "subject": "string",      "display": "string",      "severity": "high",      "title": "string",      "words": "string",      "nextStep": "string",      "evidence": {},      "likelyYours": true,      "state": "string",      "dismissed": "string",      "firstSeen": "string",      "lastSeen": "string",      "alertedAt": "string"    }  ],  "responses": [    {      "id": "string",      "findingId": "string",      "kind": "guided",      "state": "done",      "verified": true,      "verifiedAt": "string",      "words": "string",      "steps": [        {          "id": "string",          "words": "string",          "state": "done",          "ref": "string",          "readBack": "string",          "to": "string"        }      ],      "runId": "string",      "decisionId": "string",      "requestedBy": "string",      "createdAt": "string",      "finishedAt": "string"    }  ],  "counts": {    "watching": 1,    "waitingForProof": 1,    "open": 1,    "critical": 1,    "high": 1,    "resolved": 1  },  "empty": "string"}

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.