Cancel Request

This action will cancel a credential request. Once a request is canceled, it cannot be undone and will prevent the request from being completed by any subjects. A request can be canceled if it contains credentials in draft status.

DELETE /request/{requestId}

Cancel Request

cURL

curl --request DELETE \
  --url https://api.example.com/request/{requestId}

200

{
  "success": true
}

Headers

API-Version · string

Pin responses to a specific API version (YYYY-MM-DD). When omitted, defaults to the version stored in your issuer config or today's date.

Pattern: ^\d{4}-\d{2}-\d{2}$

Example:

"2026-03-03"

Path Parameters

requestId · string · required

Unique identifier of the credential request to cancel. Must be a valid MongoDB ObjectId.

Example:

"507f1f77bcf86cd799439011"

Response

200

application/json

Returns a confirmation of the cancellation.

success · boolean · required

Whether the operation was successful

Example:

true