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

# Create Subscription

> Create a compliance alert subscription.

The subscription narrows what GET /v1/compliance/alerts returns for this key; there is still no push delivery, so the response carries a ``notice``
saying delivery is by polling that route, not by digest or webhook.



## OpenAPI

````yaml /api-reference/openapi.json post /v1/compliance/subscribe
openapi: 3.1.0
info:
  title: Limitguard.ai
  description: >-
    Lead validation API: the company behind each lead checked against the NL and
    BE business registers, EU VAT and sanctions lists, plus company, KYB and
    agent wallet checks for developers and AI agents
  version: 0.1.0
servers:
  - url: https://api.limitguard.ai
security: []
paths:
  /v1/compliance/subscribe:
    post:
      summary: Create Subscription
      description: >-
        Create a compliance alert subscription.


        The subscription narrows what GET /v1/compliance/alerts returns for this
        key; there is still no push delivery, so the response carries a
        ``notice``

        saying delivery is by polling that route, not by digest or webhook.
      operationId: create_subscription_v1_compliance_subscribe_post
      parameters:
        - name: entity_types
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            default:
              - financial_services
            title: Entity Types
        - name: severity_filter
          in: query
          required: false
          schema:
            type: array
            items:
              $ref: '#/components/schemas/AlertSeverity'
            default:
              - critical
              - high
            title: Severity Filter
        - name: jurisdictions
          in: query
          required: false
          schema:
            type: array
            items:
              type: string
            default:
              - eu
            title: Jurisdictions
        - name: tier
          in: query
          required: false
          schema:
            $ref: '#/components/schemas/SubscriptionTier'
            default: basic
        - name: webhook_url
          in: query
          required: false
          schema:
            anyOf:
              - type: string
              - type: 'null'
            title: Webhook Url
      responses:
        '201':
          description: Successful Response
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/AlertSubscriptionCreated'
        '422':
          description: Validation Error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/HTTPValidationError'
      security:
        - APIKeyHeader: []
components:
  schemas:
    AlertSeverity:
      type: string
      enum:
        - critical
        - high
        - medium
        - low
        - informational
      title: AlertSeverity
    SubscriptionTier:
      type: string
      enum:
        - basic
        - pro
        - enterprise
      title: SubscriptionTier
    AlertSubscriptionCreated:
      properties:
        id:
          type: string
          title: Id
          description: Subscription ID
        entity_types:
          items:
            type: string
          type: array
          title: Entity Types
          description: Sector filters
        severity_filter:
          items:
            $ref: '#/components/schemas/AlertSeverity'
          type: array
          title: Severity Filter
          description: >-
            Minimum severity to receive: the least severe entry is the
            threshold. Narrows global alerts only; your own hits are always
            shown
        jurisdictions:
          items:
            type: string
          type: array
          title: Jurisdictions
          description: Jurisdiction filters
        tier:
          $ref: '#/components/schemas/SubscriptionTier'
          default: basic
        webhook_url:
          anyOf:
            - type: string
            - type: 'null'
          title: Webhook Url
          description: Webhook URL for enterprise tier
        created_at:
          type: string
          format: date-time
          title: Created At
        notice:
          type: string
          title: Notice
          description: Whether the subscribed alert feed has anything to deliver
      type: object
      required:
        - id
        - notice
      title: AlertSubscriptionCreated
      description: A new subscription plus the delivery status of its alert feed.
    HTTPValidationError:
      properties:
        detail:
          items:
            $ref: '#/components/schemas/ValidationError'
          type: array
          title: Detail
      type: object
      title: HTTPValidationError
    ValidationError:
      properties:
        loc:
          items:
            anyOf:
              - type: string
              - type: integer
          type: array
          title: Location
        msg:
          type: string
          title: Message
        type:
          type: string
          title: Error Type
        input:
          title: Input
        ctx:
          type: object
          title: Context
      type: object
      required:
        - loc
        - msg
        - type
      title: ValidationError
  securitySchemes:
    APIKeyHeader:
      type: apiKey
      in: header
      name: X-API-Key

````

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