Skip to content

The sealed receipt of a starter or leaver run: every system's step as it read back, fingerprinted for an auditor

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

A token that can read is enough.

id
required
string

Done.

Media typeapplication/json
object
document
required
object
v
required
number
Allowed values: 1
kind
required
string
Allowed values: xovris.run-receipt
workspace
required
string
run
required
string
runKind
required
string
person
required
object
email
required
string
name
required
One of:
string
state
required
string
requestedBy
required
One of:
string
decisionId
required
One of:
string
startedAt
required
string
finishedAt
required
string
reverifiedAt
required
One of:
string
systems
required
Array<object>
object
system
required
string
connectionId
required
One of:
string
outcome
required
string
Allowed values: unread confirmed contradicted
readAt
required
One of:
string
readBack
required
One of:
string
remaining
required
Array<string>
steps
required
Array<object>
object
seq
required
number
action
required
string
state
required
string
words
required
One of:
string
at
required
One of:
string
decisionId
required
One of:
string
sha256
required
string
signature
required
One of:
object
alg
required
string
Allowed values: Ed25519
keyId
required
string
value
required
string
publicKey
required
One of:
string
signing
required
object
on
required
boolean
said
required
string
verify
required
object
key
required
string
how
required
string

Example

{  "document": {    "v": 1,    "kind": "xovris.run-receipt",    "workspace": "string",    "run": "string",    "runKind": "string",    "person": {      "email": "string",      "name": "string"    },    "state": "string",    "requestedBy": "string",    "decisionId": "string",    "startedAt": "string",    "finishedAt": "string",    "reverifiedAt": "string",    "systems": [      {        "system": "string",        "connectionId": "string",        "outcome": "unread",        "readAt": "string",        "readBack": "string",        "remaining": [          "string"        ],        "steps": [          {            "seq": 1,            "action": "string",            "state": "string",            "words": "string",            "at": "string",            "decisionId": "string"          }        ]      }    ]  },  "sha256": "string",  "signature": {    "alg": "Ed25519",    "keyId": "string",    "value": "string"  },  "publicKey": "string",  "signing": {    "on": true,    "said": "string"  },  "verify": {    "key": "string",    "how": "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.