> ## 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.

# Verify Credential



## OpenAPI

````yaml certify-api/openapi.json GET /verify/{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:
  /verify/{credential_id}:
    get:
      tags:
        - Verification
      summary: Verify issued credential
      description: >-
        Public endpoint to verify the authenticity and current status of a
        digital certificate or badge. This endpoint can be used by third parties
        to validate credentials without authentication.
      operationId: verifyCredential
      parameters:
        - $ref: '#/components/parameters/Xerobi-Version'
        - in: path
          name: credential_id
          required: true
          schema:
            type: string
            description: Unique identifier of the credential to verify
            example: cred_1234567890abcdef
      responses:
        '200':
          description: Credential verification result
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/VerificationResponse'
              example:
                valid: true
                recipient: John Doe
                issued_at: '2025-12-01T10:00:00Z'
                revoked: false
        '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:
    VerificationResponse:
      type: object
      description: Response containing credential verification result
      properties:
        valid:
          type: boolean
          description: Whether the credential is valid and authentic
          example: true
        recipient:
          type: string
          description: Name of the credential recipient
          example: John Doe
        issued_at:
          type: string
          format: date-time
          description: Timestamp when the credential was issued
          example: '2025-12-01T10:00:00Z'
        revoked:
          type: boolean
          description: Whether the credential has been revoked
          example: false
    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

- [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)
- [Xerobi Certification & Badge API Introduction](https://docs.xerobi.com/certify/introduction.md)
- [Revoke Credential](https://docs.xerobi.com/certify/endpoint/revoke-credential.md)


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