Skip to content

Read any compliance framework you name against your live evidence

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/compliance/frameworks
curl --request POST \  --url https://api.xovris.ai/v1/compliance/frameworks \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "name": "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
name
string

Example

{  "name": "string"}

Done.

Media typeapplication/json
object
coverage
required
object
framework
required
string
name
required
string
source
required
One of:
string
version
required
One of:
string
controls
required
Array<object>
object
state
required
string
Allowed values: unknown met not_met
blocking
required
Array<string>
control
required
string
title
required
string
from
required
Array<string>
met
required
number
notMet
required
number
unknown
required
number
outside
required
Array<string>
summary
required
string
way
required
string
Allowed values: read known
checked
required
Array<string>

Example

{  "coverage": {    "framework": "string",    "name": "string",    "source": "string",    "version": "string",    "controls": [      {        "state": "unknown",        "blocking": [          "string"        ],        "control": "string",        "title": "string",        "from": [          "string"        ]      }    ],    "met": 1,    "notMet": 1,    "unknown": 1,    "outside": [      "string"    ],    "summary": "string",    "way": "read",    "checked": [      "string"    ]  }}

Started: the answer says where to follow it.

Media typeapplication/json
object
tried
required
Array<string>
next
required
string

Example

{  "tried": [    "string"  ],  "next": "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.