/v1/issuer/offers/{uuid}/revoke
API Key
Revoke a credential offer
Cancel an unclaimed credential offer. Only pending offers can be revoked.
Once revoked, the offer can no longer be claimed by the holder.
Parameters
| Name | Location | Type | Description |
|---|---|---|---|
uuid
*
|
path | string | Credential offer UUID |
X-API-Key
*
|
header | string | Issuer API key for authentication |
* Required parameter
Response
Content-Type: application/json
success
boolean
data
object
message
string
offer
object
A credential offer that holders can claim via wallet apps (OID4VCI)
uuid
*
string (uuid)
Unique identifier for the offer
Example: e8738e4f-2867-485d-9a00-fbe913ffca20
status
*
string
Current status of the offer: - pending: Awaiting holder claim - accepted: Successfully claimed by holder - expired: Past expiration time - revoked: Cancelled by issuer before claim
Allowed values: "pending", "accepted", "expired", "revoked"
Example: pending
subject_identifier
string
nullable
Email or DID of the intended recipient
Example: [email protected]
subject_claims
*
object
Pre-filled claim values for the credential
Example: {"name":"Jane Doe","degree":"Bachelor of Science"}
expires_at
string (date-time)
nullable
When the offer expires
Example: 2025-02-15T23:59:59Z
created_at
*
string (date-time)
When the offer was created
Example: 2025-01-15T10:00:00Z
schema
*
object
The credential schema for this offer
uuid
string (uuid)
Example: 7dceea59-9eef-406c-bca9-acaa0211bf8a
name
string
Schema display name
Example: University Degree
slug
string
URL-friendly schema identifier
Example: university-degree
offer_uri
string (uri)
nullable
URL where the offer can be retrieved (included on show)
Example: https://aho.com/openid4vci/offers/027b08a5-83e6-4cb3-b20e-8c5c9d517363
deep_link
string
nullable
Deep link for wallet apps (openid-credential-offer://...) (included on show)
Example: openid-credential-offer://?credential_offer_uri=https%3A%2F%2Faho.com%2Fopenid4vci%2Foffers%2Fcb20c0ad
Code Examples
import os
from aho_sdk import AhoSdk
client = AhoSdk.issuer(api_key=os.environ["AHO_API_KEY"])
result = client.offers.revoke(
uuid="example_uuid"
)
client = AhoSdk.issuer(api_key: ENV["AHO_API_KEY"])
result = client.offers.revoke(
uuid: "example_uuid"
)
import { AhoSdk } from '@aho/sdk';
const client = AhoSdk.issuer({ apiKey: process.env.AHO_API_KEY });
const result = await client.offers.revoke({
uuid: "example_uuid"
});
curl -X POST 'https://api.aho.com/v1/issuer/offers/example_uuid/revoke' \
-H 'X-API-Key: $AHO_API_KEY'
Try It
Log in to test this endpoint directly from the documentation.
Log in