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

# Create an EPCIS capture key

> Create a key that captures EPCIS events for the organization. The response carries the `secret`, the only time it is shown. A capture key can only post EPCIS events, which the Owner, Manager or Editor who creates it can already do. Requires one of those roles; a read-only key is refused with 403.



## OpenAPI

````yaml /openapi/openapi-compliance.json post /compliance/api/v1/organizations/{organization_id}/capture-keys
openapi: 3.1.0
info:
  title: Compliance API
  version: 1.0.0
  description: >
    Product safety and compliance data: recalls, hazards, and remedies; and an
    organization's FSMA 204 settings and record-retention minimums.


    ## Authentication


    All endpoints require an API key passed via the `X-API-Key` HTTP header,
    unless otherwise noted.


    ```

    X-API-Key: csb_<body>_<checksum>

    ```


    Generate API keys in **Settings > API Keys** in your dashboard, or via the
    Account API.

    Session-based (cookie) authentication is also accepted for browser-based
    access.


    ## Rate Limits


    | Tier        | Requests / minute | Requests / day |

    |-------------|-------------------|----------------|

    | Default     | 300               | 10,000         |

    | Custom      | Contact us        | Contact us     |


    Those windows are per key. Your plan also caps each organization per hour,
    across every key,

    login and session acting for it: 100 requests on Free (or while a
    subscription is lapsed),

    10,000 on Business. While a subscription is lapsed, any method other than
    `GET`, `HEAD` and

    `OPTIONS` returns `403`.


    Rate-limit headers are included on every response so callers can
    self-throttle without

    hitting our 429s ("informed governor"):


    - `RateLimit-Policy` — every active window, e.g. `300;w=60, 10000;w=86400`

    - `RateLimit-Limit` — quota for the **most-restrictive** currently-active
    window

    - `RateLimit-Remaining` — requests left in that window

    - `RateLimit-Reset` — seconds until that window resets (relative; clock-skew
    safe)


    Legacy `X-RateLimit-*` aliases are also emitted for back-compat.
    `X-RateLimit-Reset`

    keeps the absolute Unix-timestamp shape to avoid breaking existing
    consumers.


    When rate-limited, you receive `429 Too Many Requests` with a
    `retry_after_seconds` field

    in the error envelope and a `Retry-After` header.


    ## Pagination


    List endpoints return paginated results in this envelope:


    ```json

    {
      "data": [...],
      "pagination": {
        "page": 1,
        "page_size": 25,
        "total_count": 342,
        "total_pages": 14,
        "has_next": true,
        "has_previous": false
      }
    }

    ```


    Use `?page=2&page_size=50` query parameters. Maximum page size is 100.


    ## Error Responses


    All errors conform to [RFC 9457 Problem
    Details](https://www.rfc-editor.org/rfc/rfc9457)

    with `Content-Type: application/problem+json`:


    ```json

    {
      "type": "https://closient.com/docs/errors/not_found",
      "title": "Not Found",
      "status": 404,
      "detail": "The requested resource was not found.",
      "error_code": "not_found",
      "retryable": false,
      "timestamp": "2026-03-31T12:00:00+00:00"
    }

    ```


    Common error codes: `unauthorized` (401), `forbidden` (403), `not_found`
    (404),

    `validation_error` (422), `rate_limited` (429), `internal_error` (500).
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Compliance
    description: Product recall and safety queries.
  - name: FSMA configuration
    description: >-
      An organization's FSMA 204 designated contact, lot-code settings and
      retention minimums.
  - name: EPCIS capture configuration
    description: >-
      An organization's EPCIS capture keys, serial-number pools and public-page
      visibility.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /compliance/api/v1/organizations/{organization_id}/capture-keys:
    post:
      tags:
        - EPCIS capture configuration
      summary: Create an EPCIS capture key
      description: >-
        Create a key that captures EPCIS events for the organization. The
        response carries the `secret`, the only time it is shown. A capture key
        can only post EPCIS events, which the Owner, Manager or Editor who
        creates it can already do. Requires one of those roles; a read-only key
        is refused with 403.
      operationId: create_capture_key
      parameters:
        - in: path
          name: organization_id
          schema:
            description: Identifier of the organization.
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            title: Organization Id
            type: string
          required: true
          description: Identifier of the organization.
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/CaptureKeyCreateIn'
        required: true
      responses:
        '201':
          description: Created
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CaptureKeyCreatedOut'
        '400':
          description: Bad Request
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '401':
          description: Unauthorized
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '403':
          description: Forbidden
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '404':
          description: Not Found
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '405':
          description: Method Not Allowed
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '422':
          description: Unprocessable Content
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
        '429':
          description: Too Many Requests
          content:
            application/problem+json:
              schema:
                $ref: '#/components/schemas/ErrorOut'
      security:
        - APIKeyHeaderAuth: []
        - OAuthTokenAuth: []
        - CookieGatedSessionAuth: []
components:
  schemas:
    CaptureKeyCreateIn:
      description: The capture key to create.
      examples:
        - expires_at: '2027-01-01T00:00:00Z'
          name: Warehouse scanner
      properties:
        name:
          description: >-
            Label for the key, 1 to 255 characters, such as the device or system
            that will use it.
          maxLength: 255
          minLength: 1
          pattern: ^[^\x00]{1,255}$
          title: Name
          type: string
        expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When the key stops working, as a time with a UTC offset. Omit for a
            key that never expires.
          title: Expires At
      required:
        - name
      title: CaptureKeyCreateIn
      type: object
    CaptureKeyCreatedOut:
      description: >-
        A new EPCIS capture key, with its secret. This is the only response that
        ever carries the secret.
      examples:
        - created: '2026-10-15T09:30:00Z'
          expires_at: '2027-01-01T00:00:00Z'
          id: 7nZq1vXr4kGd9mPbT2uYcA
          is_active: true
          name: Warehouse scanner
          prefix: epk_a1B2
          secret: epk_a1B2c3D4e5F6g7H8i9J0k1L2m3N4o5P6q7R8s9T0u1V
      properties:
        id:
          description: Identifier of the key, for revoking it.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        name:
          description: Label the key was given, such as the device or system that uses it.
          title: Name
          type: string
        prefix:
          description: >-
            First 8 characters of the secret, to tell keys apart. It is not
            enough to use the key.
          title: Prefix
          type: string
        is_active:
          description: False once the key is revoked; a revoked key captures nothing.
          title: Is Active
          type: boolean
        expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the key stops working; null for a key that never expires.
          title: Expires At
        last_used_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: When the key last captured an event; null if never used.
          title: Last Used At
        created:
          description: When the key was created.
          format: date-time
          title: Created
          type: string
        secret:
          description: >-
            The key itself, sent as the credential when capturing EPCIS events.
            Shown only in this response; Closient stores a hash, so a lost
            secret cannot be recovered and the key must be replaced.
          title: Secret
          type: string
      required:
        - id
        - name
        - prefix
        - is_active
        - expires_at
        - last_used_at
        - created
        - secret
      title: CaptureKeyCreatedOut
      type: object
    ErrorOut:
      description: |-
        RFC 9457 Problem Details response.

        All API errors are returned in this format with Content-Type:
        application/problem+json.
      examples:
        - detail: The requested resource was not found.
          error_code: not_found
          retryable: false
          status: 404
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Not Found
          type: https://closient.com/docs/errors/not_found
        - detail: Validation error.
          details:
            - loc:
                - body
                - name
              msg: Field required
              type: missing
          error_code: validation_error
          retryable: false
          status: 422
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Validation Error
          type: https://closient.com/docs/errors/validation_error
        - detail: Rate limit exceeded. Please try again later.
          error_code: rate_limited
          retry_after: 31
          retryable: true
          status: 429
          timestamp: '2026-03-31T12:00:00+00:00'
          title: Rate Limited
          type: https://closient.com/docs/errors/rate_limited
      properties:
        type:
          description: URI reference identifying the error type.
          title: Type
          type: string
        title:
          description: Short human-readable summary of the error.
          title: Title
          type: string
        status:
          description: HTTP status code.
          title: Status
          type: integer
        detail:
          description: Human-readable explanation of this specific occurrence.
          title: Detail
          type: string
        error_code:
          description: Machine-readable error code (e.g. not_found, unauthorized).
          title: Error Code
          type: string
        retryable:
          default: false
          description: Whether retrying the same request can succeed.
          title: Retryable
          type: boolean
        timestamp:
          description: ISO 8601 timestamp of when the error occurred.
          title: Timestamp
          type: string
        retry_after:
          anyOf:
            - type: integer
            - type: 'null'
          description: Seconds to wait before retrying (when applicable).
          title: Retry After
        owner_action_required:
          anyOf:
            - type: boolean
            - type: 'null'
          description: Whether the error requires account owner intervention.
          title: Owner Action Required
        details:
          description: Additional context (validation errors, etc.).
          title: Details
      required:
        - type
        - title
        - status
        - detail
        - error_code
        - timestamp
      title: ErrorOut
      type: object
  securitySchemes:
    APIKeyHeaderAuth:
      type: apiKey
      in: header
      name: X-API-Key
    OAuthTokenAuth:
      type: http
      scheme: bearer
    CookieGatedSessionAuth:
      type: apiKey
      in: cookie
      name: sessionid

````

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