Revoke identity assurance evidence.

POST

/api/admin/users/{id}/assurance/evidence/{evidenceId}/revoke

Code sample: Shell / cURL

curl --request POST \
  --url https://auth.example.com/api/admin/users/example/assurance/evidence/example/revoke \
  --header 'Authorization: Bearer <token>'

Revokes one piece of the person’s evidence, of any source, recording who revoked it. It stops counting at once and is audited after (user.assurance.evidence_revoked, naming who revoked it); when the audit fails (503) the evidence stays revoked and a retry, by anyone, audits it. Revoking revoked evidence answers it again.

Authorizations

• adminBearer
• adminSessionCookie

Parameters

Path Parameters

id

required

string

evidenceId

required

string

>= 1 characters <= 256 characters

Header Parameters

X-Tenant-Id

string

Tenant selector for multi-tenant admin requests.

Responses

200

The revoked evidence.

Media type application/json

object

evidence_id

required

string

evidence_type

required

Admin_attestation, document_check, in_person_check and remote_supervised_check from an administrator; scim and import from provisioning; tenant_policy for the tenant’s default IAL.

string

issuer_ref

required

Who recorded it (admin:, scim:, import:, tenant_policy).

string | null

assurance_framework

required

string | null

assurance_level

required

string | null

evidence_hash

required

string | null

evidence_storage_ref

required

string | null

verified_at

required

string | null format: date-time

expires_at

required

string | null format: date-time

revoked_at

required

string | null format: date-time

revoked_by

required

Who revoked it (admin:, or the provisioning source that replaced it).

string | null

created_at

required

string | null format: date-time

status

required

Active counts toward the IAL; pending does not yet (verified in the future, or recorded and awaiting its audit).

string

Allowed values: active pending expired revoked

key

additional properties

Example

{
  "status": "active"
}

403

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

404

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}

503

Error response.

Media type application/json

object

error

string

message

string

error_description

string

key

additional properties

Example ^generated

{
  "error": "example",
  "message": "example",
  "error_description": "example"
}