> ## Documentation Index
> Fetch the complete documentation index at: https://docs.xerobi.com/llms.txt
> Use this file to discover all available pages before exploring further.

# Revoke Credential



## OpenAPI

````yaml certify-api/openapi.json POST /revoke/{credential_id}
openapi: 3.0.0
info:
  title: Xerobi Certification & Badge API
  version: '2026-01-01'
  description: >-
    A comprehensive API for issuing, managing, and verifying digital
    certificates and badges. Perfect for educational institutions, certification
    bodies, and organizations requiring verifiable credential management.
    Supports certificate templates, digital badges, credential lifecycle
    management, public verification, webhooks, and comprehensive audit logging.
  contact:
    name: Xerobi Support
    email: support@xerobi.com
  license:
    name: Proprietary
servers:
  - url: https://api.hixbe.com/certify
    description: Production
security:
  - BearerAuth: []
tags:
  - name: Templates
    description: >-
      Certificate template management - create and manage reusable certificate
      designs
  - name: Credentials
    description: >-
      Issued credential management - view and track digital certificates and
      badges
  - name: Badges
    description: Digital badge definitions - create and manage badge metadata and criteria
  - name: Verification
    description: Public credential verification - validate issued certificates and badges
  - name: Issuance
    description: >-
      Credential issuance - create and distribute digital certificates and
      badges
  - name: Webhooks
    description: Event notifications - configure webhooks for credential lifecycle events
  - name: Audit Logs
    description: >-
      Activity tracking - comprehensive audit trail for all credential
      operations
  - name: Programs
    description: Certification programs - organize credentials into structured programs
  - name: Revocation
    description: Credential revocation - invalidate certificates and badges when necessary
paths:
  /revoke/{credential_id}:
    post:
      tags:
        - Revocation
      summary: Revoke a credential
      description: >-
        Revoke a previously issued credential, marking it as invalid. This
        action cannot be undone. The credential will no longer be verifiable and
        the recipient will be notified if webhooks are configured.
      operationId: revokeCredential
      parameters:
        - $ref: '#/components/parameters/Xerobi-Version'
        - in: path
          name: credential_id
          required: true
          schema:
            type: string
            description: Unique identifier of the credential to revoke
            example: cred_1234567890abcdef
      responses:
        '200':
          description: Credential revoked successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/RevocationResponse'
              example:
                status: revoked
                revoked_at: '2025-12-03T10:00:00Z'
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '404':
          $ref: '#/components/responses/NotFound'
        '500':
          $ref: '#/components/responses/InternalServerError'
components:
  parameters:
    Xerobi-Version:
      name: Xerobi-Version
      in: header
      required: true
      schema:
        type: string
        example: '2026-01-01'
      description: API version in YYYY-MM-DD format
  schemas:
    RevocationResponse:
      type: object
      description: Response confirming credential revocation
      properties:
        status:
          type: string
          description: Revocation status
          example: revoked
        revoked_at:
          type: string
          format: date-time
          description: Timestamp when the credential was revoked
          example: '2025-12-03T10:00:00Z'
    Error:
      type: object
      description: Standard error response format
      properties:
        error:
          type: string
          description: Error type identifier
          example: invalid_request
        message:
          type: string
          description: Human-readable error message
          example: The credential ID provided is invalid
        code:
          type: string
          description: Optional error code for programmatic handling
          example: INVALID_CREDENTIAL_ID
      required:
        - error
        - message
  responses:
    BadRequest:
      description: Bad Request
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Unauthorized:
      description: Unauthorized
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    Forbidden:
      description: Forbidden
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    NotFound:
      description: Not Found
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
    InternalServerError:
      description: Internal Server Error
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
  securitySchemes:
    BearerAuth:
      type: http
      scheme: bearer

````

## Related topics

- [Xerobi Certification & Badge API Introduction](https://docs.xerobi.com/certify/introduction.md)
- [Certification API FAQ](https://docs.xerobi.com/faq-guides/certification-api-faq.md)
- [List Credentials](https://docs.xerobi.com/certify/endpoint/list-credentials.md)
- [Issue Credential](https://docs.xerobi.com/certify/endpoint/issue-credential.md)
- [Verify Credential](https://docs.xerobi.com/certify/endpoint/verify-credential.md)


This documentation is built and hosted on [Mintlify](https://mintlify.com), a developer documentation platform.