Skip to content

See the laws that apply to your business and what each asks of 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.

POST
/v1/laws
curl --request POST \  --url https://api.xovris.ai/v1/laws \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "profile": null }'

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
profile

Example

{  "profile": null}

Done.

Media typeapplication/json
object
laws
required
Array<object>
object
id
required
string
name
required
string
why
required
string
next
required
One of:
object
what
required
string
on
required
string
dates
required
Array<object>
object
what
required
string
on
required
string
change
required
Array<string>
xovrisDoes
required
string
source
required
string
note
string
ahead
required
Array<object>
object
id
required
string
name
required
string
why
required
string
change
required
Array<string>
source
required
string
checked
required
string

Example

{  "laws": [    {      "id": "string",      "name": "string",      "why": "string",      "next": {        "what": "string",        "on": "string"      },      "dates": [        {          "what": "string",          "on": "string"        }      ],      "change": [        "string"      ],      "xovrisDoes": "string",      "source": "string",      "note": "string"    }  ],  "ahead": [    {      "id": "string",      "name": "string",      "why": "string",      "change": [        "string"      ],      "source": "string"    }  ],  "checked": "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.