Skip to content
Bottle

End trust centre access early

POST
/console/trust/requests/{id}/revoke
curl --request POST \
  --url https://example.com/console/trust/requests/019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f/revoke \
  --header 'Content-Type: application/json' \
  --cookie bottle.session_token=<bottle.session_token> \
  --data '{ "note": "example" }'

Stops the access at once, on every browser holding it, and throws away any link not yet clicked. Recorded in the console log.

Authorizations

Section titled “Authorizations”

Parameters

Section titled “Parameters”

Path Parameters

Section titled “Path Parameters”
id
required

UUID v7

string format: uuid
Example
019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f

UUID v7

Request Body

Section titled “Request Body”
Media typeapplication/json
object
note
string
<= 1000 characters
Examplegenerated
{
  "note": "example"
}

Responses

Section titled “Responses”

200

Section titled “200”

The request, as it now stands

Media typeapplication/json
object
id
required

UUID v7

string format: uuid
kind
required
string
Allowed values: visitor customer
status
required
string
Allowed values: draft unverified pending approved declined revoked
fullName
required
string
email
required
string
company
required
string
companyNumber
required
string | null
registeredAddress
required
string | null
role
required
string | null
reason
required
string | null
tenantId
required

UUID v7

string | null format: uuid
tenantName
required
string | null
ndaVersion
required
string | null
ndaAcceptedAt
required
string | null format: date-time
verifiedAt
required
string | null format: date-time
ndaSha256
required
string | null
decidedByName
required
string | null
decidedAt
required
string | null format: date-time
decisionNote
required
string | null
accessExpiresAt
required
string | null format: date-time
createdAt
required
string format: date-time
Example
{
  "id": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f",
  "kind": "visitor",
  "status": "draft",
  "tenantId": "019205d1-6e7a-7c3b-9f6e-3a2b1c0d9e8f"
}

401

Section titled “401”

Not signed in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

403

Section titled “403”

Not Bottle staff, or no two-step sign-in

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

404

Section titled “404”

No such request, or the trust centre is not set up here

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

409

Section titled “409”

Already answered, or the access has already ended

Media typeapplication/json
object
error
required
string
message
required
string
Example
{
  "error": "not_found",
  "message": "Customer not found"
}

422

Section titled “422”

Validation failed

Media typeapplication/json
object
error
required
string
Allowed values: validation
message
required
string
issues
required
Array<object>
object
path
required
string
message
required
string
Example
{
  "error": "validation",
  "issues": [
    {
      "path": "email",
      "message": "Invalid email"
    }
  ]
}