API
/revoke
post
An endpoint used by GOV.UK Wallet credential issuers to revoke a status list index associated with a GOV.UK Wallet credential that they issued. This API will use the issuer’s /.well-known/jwks.json endpoint to locate the signing keys to verify the signature.
Responses
| Status | Description | Schema |
|---|---|---|
| 202 |
Revocation processed successfully application/json
|
RevokeResponse |
| 400 |
Bad request (invalid JWT, missing fields, wrong content-type, etc.) application/json
|
Revoke400ErrorResponse |
| 401 |
Unauthorized (client not found or client mismatch) application/json
|
Revoke401ErrorResponse |
| 403 |
Forbidden (status list entry not found or issuer mismatch) application/json
|
Revoke403ErrorResponse |
| 404 |
Entry not found in status list table application/json
|
Revoke404ErrorResponse |
| 500 |
Internal server error application/json
|
Revoke500ErrorResponse |
| 503 |
Service temporarily unavailable application/json
|
Revoke503ErrorResponse |
Schemas
RevokeResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| message | string | true | Status message indicating the result |
|
| revokedAt | number | true | Unix timestamp when the credential was revoked |
Revoke400ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Revoke401ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Revoke403ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Revoke404ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Revoke500ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |
Revoke503ErrorResponse
| Name | Type | Required | Description | Schema |
|---|---|---|---|---|
| error | string | true | An error code - must be |
|
| error_description | string | false | A human-readable explanation of the error. |