Skip to content

Take the proof receipt of one change or undo, with the checks anyone can run on it without Xovris

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/actions/{seq}/receipt
curl --request GET \  --url https://api.xovris.ai/v1/actions/example/receipt \  --header 'Authorization: Bearer <token>'

A token that can read is enough.

seq
required
string

Done.

Media typeapplication/json
object
seq
required
number
kind
required
string
at
required
string
subject
required
string
asset
required
One of:
string
action
required
One of:
string
runId
required
One of:
string
state
required
One of:
string
changed
required
string
before
required
after
required
evidenceDigest
required
string
verdict
required
One of:
object
passed
required
boolean
kind
required
string
at
required
string
steps
required
Array<object>
object
id
required
string
Allowed values: target evidence chain entry
how
required
string
Allowed values: http sha256
says
required
string
input
string
url
string
expect
required
One of:
string
byHand
required
string
sentence
required
string

Example

{  "seq": 1,  "kind": "string",  "at": "string",  "subject": "string",  "asset": "string",  "action": "string",  "runId": "string",  "state": "string",  "changed": "string",  "before": null,  "after": null,  "evidenceDigest": "string",  "verdict": {    "passed": true,    "kind": "string",    "at": "string"  },  "steps": [    {      "id": "target",      "how": "http",      "says": "string",      "input": "string",      "url": "string",      "expect": "string",      "byHand": "string"    }  ],  "sentence": "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.