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.
const url = 'https://api.xovris.ai/v1/exposure';const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
try { const response = await fetch(url, options); const data = await response.json(); console.log(data);} catch (error) { console.error(error);}curl --request GET \ --url https://api.xovris.ai/v1/exposure \ --header 'Authorization: Bearer <token>'A token that can read is enough.
Authorizations
Section titled “Authorizations”Responses
Section titled “Responses”Done.
object
object
object
object
object
object
object
object
object
object
object
object
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
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.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}default
Section titled “default”Any other refusal or failure. The answer says what happened and what to do next.
object
object
A stable code a program can branch on.
What happened, in plain words.
What to do next.
The recorded authorisation decision, when a role refused it.
Example generated
{ "error": { "code": "example", "message": "example", "nextStep": "example", "decisionId": "example" }}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.