# generated: '2026-07-18'
# method: generated
# source: https://docs.clearme.com/docs/webhooks
asyncapi: 3.0.0
info:
  title: CLEAR1 Webhooks
  version: 1.0.0
  description: Server-to-server webhook events emitted by CLEAR when a verification session changes. Generated by API Evangelist from the documented CLEAR webhook catalog (contact CLEAR support to enable
    webhooks).
defaultContentType: application/json
servers:
  consumer:
    host: your-app.example.com
    protocol: https
    description: Your HTTPS endpoint that receives CLEAR webhook POSTs
channels:
  clearWebhook:
    address: /
    messages:
      verificationSessionCreated:
        $ref: '#/components/messages/verificationSessionCreated'
      verificationSessionCompleted:
        $ref: '#/components/messages/verificationSessionCompleted'
      verificationSessionStatusUpdate:
        $ref: '#/components/messages/verificationSessionStatusUpdate'
operations:
  receive_verificationSessionCreated:
    action: receive
    channel:
      $ref: '#/channels/clearWebhook'
    messages:
    - $ref: '#/channels/clearWebhook/messages/verificationSessionCreated'
  receive_verificationSessionCompleted:
    action: receive
    channel:
      $ref: '#/channels/clearWebhook'
    messages:
    - $ref: '#/channels/clearWebhook/messages/verificationSessionCompleted'
  receive_verificationSessionStatusUpdate:
    action: receive
    channel:
      $ref: '#/channels/clearWebhook'
    messages:
    - $ref: '#/channels/clearWebhook/messages/verificationSessionStatusUpdate'
components:
  messages:
    verificationSessionCreated:
      name: event_verification_session_created_v1
      title: verificationSessionCreated
      contentType: application/json
      payload:
        type: object
        properties:
          event_id:
            type: string
            examples:
            - event_gS8XPhiNFOssvZ345ekOAdMnKBRb8oGGP
          event_type:
            type: string
            const: event_verification_session_created_v1
          object_name:
            type: string
            const: event
          created_at:
            type: number
          data:
            type: object
            properties:
              verification_session_id:
                type: string
                examples:
                - verify_U2uXnRZrN52397ycZfVmHodhHO0Xhbr0wH
    verificationSessionCompleted:
      name: event_verification_session_completed_v1
      title: verificationSessionCompleted
      contentType: application/json
      payload:
        type: object
        properties:
          event_id:
            type: string
            examples:
            - event_gS8XPhiNFOssvZ345ekOAdMnKBRb8oGGP
          event_type:
            type: string
            const: event_verification_session_completed_v1
          object_name:
            type: string
            const: event
          created_at:
            type: number
          data:
            type: object
            properties:
              verification_session_id:
                type: string
                examples:
                - verify_U2uXnRZrN52397ycZfVmHodhHO0Xhbr0wH
    verificationSessionStatusUpdate:
      name: event_verification_session_status_update_v1
      title: verificationSessionStatusUpdate
      contentType: application/json
      payload:
        type: object
        properties:
          event_id:
            type: string
            examples:
            - event_gS8XPhiNFOssvZ345ekOAdMnKBRb8oGGP
          event_type:
            type: string
            const: event_verification_session_status_update_v1
          object_name:
            type: string
            const: event
          created_at:
            type: number
          data:
            type: object
            properties:
              verification_session_id:
                type: string
                examples:
                - verify_U2uXnRZrN52397ycZfVmHodhHO0Xhbr0wH
  securitySchemes:
    bearer:
      type: http
      scheme: bearer
    hmac:
      type: httpApiKey
      name: X-CLEAR-HMAC-SHA256
      in: header
      description: HMAC-SHA256 of the request body signed with a shared secret