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

# Create Badge



## OpenAPI

````yaml certify-api/openapi.json POST /badges
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:
  /badges:
    post:
      tags:
        - Badges
      summary: Create badge definition
      description: >-
        Create a new digital badge definition with metadata including name,
        image, and earning criteria. Badge definitions are reusable templates
        for issuing achievement badges.
      operationId: createBadge
      parameters:
        - $ref: '#/components/parameters/Xerobi-Version'
      requestBody:
        required: true
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CreateBadgeRequest'
            example:
              name: Certified Expert
              image_url: https://example.com/badges/expert-badge.png
              criteria: >-
                Successfully complete advanced certification exam with 90% or
                higher score
      responses:
        '201':
          description: Badge definition created successfully
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/BadgeResponse'
              example:
                id: badge_1234567890abcdef
                name: Certified Expert
        '400':
          $ref: '#/components/responses/BadRequest'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '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:
    CreateBadgeRequest:
      type: object
      description: Request payload for creating a new badge definition
      required:
        - name
        - image_url
      properties:
        name:
          type: string
          description: Display name for the badge
          example: Certified Expert
        image_url:
          type: string
          format: uri
          description: URL to the badge image
          example: https://example.com/badges/expert-badge.png
        criteria:
          type: string
          description: Description of how to earn this badge
          example: >-
            Successfully complete advanced certification exam with 90% or higher
            score
    BadgeResponse:
      type: object
      description: Response containing badge definition information
      properties:
        id:
          type: string
          description: Unique identifier for the badge definition
          example: badge_1234567890abcdef
        name:
          type: string
          description: Display name of the badge
          example: Certified Expert
    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'
    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)
- [Create Program](https://docs.xerobi.com/certify/endpoint/create-program.md)
- [Create Template](https://docs.xerobi.com/certify/endpoint/create-template.md)
- [Create Webhook](https://docs.xerobi.com/certify/endpoint/create-webhook.md)
- [Xerobi Certification & Badge API Introduction](https://docs.xerobi.com/certify/introduction.md)


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