Skip to content

See the company's password health without any password being sent

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/passwords/health
curl --request POST \  --url https://api.xovris.ai/v1/passwords/health \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "accounts": null, "at": "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
accounts
at
string

Example

{  "accounts": null,  "at": "string"}

Done.

Media typeapplication/json
One of:
object
banners
required
Array<object>
object
id
required
string
person
required
string
service
required
string
level
required
string
Allowed values: warning danger
says
required
string
action
required
string
feeds
required
One of:
object
read
required
boolean
says
required
string
findings
required
Array<object>
object
person
required
string
service
required
string
problems
required
Array<string>
Allowed values: expired duplicate reused expiring shared leaked too_short_alone site_breached_unchanged imported_from_breached in_another_account unsecured second_step_unused
move
required
string
Allowed values: passkey new_password_and_mfa
order
required
number
people
required
number
leaked
required
number
reused
required
number
shared
required
number
compromisedSites
required
number
importedFromBreached
required
number
inAnotherAccount
required
number
unsecured
required
number
secondStepUnused
required
number
expiring
required
number
duplicates
required
number
whatXovrisDoes
required
string
doItYourself
required
string

Example

{  "banners": [    {      "id": "string",      "person": "string",      "service": "string",      "level": "warning",      "says": "string",      "action": "string"    }  ],  "feeds": {    "read": true,    "says": "string"  },  "findings": [    {      "person": "string",      "service": "string",      "problems": [        "expired"      ],      "move": "passkey",      "order": 1    }  ],  "people": 1,  "leaked": 1,  "reused": 1,  "shared": 1,  "compromisedSites": 1,  "importedFromBreached": 1,  "inAnotherAccount": 1,  "unsecured": 1,  "secondStepUnused": 1,  "expiring": 1,  "duplicates": 1,  "whatXovrisDoes": "string",  "doItYourself": "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.