Skip to content

Respond to an exposure finding

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/exposure/findings/{id}/respond
curl --request POST \  --url https://api.xovris.ai/v1/exposure/findings/example/respond \  --header 'Authorization: Bearer <token>' \  --header 'Content-Type: application/json' \  --data '{ "consent": null, "idempotencyKey": "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.

id
required
string
Media typeapplication/json
object
consent
idempotencyKey
string

Example

{  "consent": null,  "idempotencyKey": "string"}

Done.

Media typeapplication/json
One of:
object
error
required
object
code
required
string
message
required
string
nextStep
required
string

Example

{  "error": {    "code": "string",    "message": "string",    "nextStep": "string"  }}

Done: something new was made, and the answer is it.

Media typeapplication/json
object
response
required
object
id
required
string
findingId
required
string
kind
required
string
Allowed values: guided identity_reset lookalike_report
state
required
string
Allowed values: done running waiting incomplete
verified
required
boolean
verifiedAt
required
One of:
string
words
required
One of:
string
steps
required
Array<object>
object
id
required
string
words
required
string
state
required
string
Allowed values: done failed unavailable pending submitting
ref
One of:
string
readBack
One of:
string
to
One of:
string
runId
required
One of:
string
decisionId
required
One of:
string
requestedBy
required
string
createdAt
required
string
finishedAt
required
One of:
string
again
required
boolean

Example

{  "response": {    "id": "string",    "findingId": "string",    "kind": "guided",    "state": "done",    "verified": true,    "verifiedAt": "string",    "words": "string",    "steps": [      {        "id": "string",        "words": "string",        "state": "done",        "ref": "string",        "readBack": "string",        "to": "string"      }    ],    "runId": "string",    "decisionId": "string",    "requestedBy": "string",    "createdAt": "string",    "finishedAt": "string"  },  "again": true}

Started: the answer says where to follow it.

Media typeapplication/json
object

Example generated

{}

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.