Skip to main content
PUT
Revokes an authorisation.

Authorizations

X-API-KEY
string
header
required

Path Parameters

authorisation_id
string<uuid>
required

ID of the authorisation to revoke

Response

OK

id
string<uuid>
required

Unique identifier for the authorisation record

Example:

"7f3b8c2a-1d4e-4f6a-8b8c-9a0b1c2d3e4f"

status
enum<string>
required

The status of a authorisation record

Available options:
active,
revoked,
expired
Example:

"active"

ip_address
string
required

Optional IP address of the user. If not provided, captured from request headers. Use when recording authorisation via server-to-server calls.

Example:

"192.168.1.1"

is_valid
boolean
required

Whether this authorisation is currently valid. True when status is active AND the associated term is active.

Example:

true

accepted_at
string<date-time>
required

Server timestamp when the authorisation was accepted

Example:

"2019-05-17T00:00:00.000Z"

created_at
string<date-time>
required

When the authorisation record was created

Example:

"2019-05-17T00:00:00.000Z"

user_id
string<uuid>
required

The ID of the user accepting the authorisation

Example:

"95a0e70b-fe02-4f47-aef9-2efff279df71"

user_agent
string
required

User agent string of the browser or application

Example:

"Mozilla/5.0 (Windows NT 10.0; Win64; x64) AppleWebKit/537.36"

revoked_at
string<date-time> | null

Server timestamp when the authorisation was revoked

Example:

"2019-05-17T00:00:00.000Z"

expires_at
string<date-time> | null

Expiry timestamp for the authorisation. Present for one-time authorisations, which expire 1 day after acceptance. Null for recurring authorisations.

Example:

"2019-05-17T00:00:00.000Z"

term_id
string<uuid>

The ID of the authorisation term being accepted. If not provided, auto-resolves to the latest active term based on user's recurring check configuration.

Example:

"550e8400-e29b-41d4-a716-446655440000"

fingerprint
string

Optional device or browser fingerprint for additional verification

Example:

"a1b2c3d4e5f6g7h8i9j0k1l2m3n4o5p6"