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

# Check the brand domain's .well-known file

> Fetches the verification file URL named in the verification status response and compares its contents with the claim token. A match records a domain-control proof for the reviewer; it does not verify the claim. Returns 409 when HTTP verification is not enabled on this deployment; use the DNS check instead. Requires the ``organization.contribute_organization`` permission on the membership owning the GTIN. Rate-limited per user and per organization; over the limit returns 429.



## OpenAPI

````yaml /openapi/openapi-products.json post /products/api/v1/products/{gtin}/verification/http-check
openapi: 3.1.0
info:
  title: Products API
  version: 1.0.0
  description: >
    Look up, claim, and browse GTINs in the Closient product repository.


    ## 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: Products
    description: Look up, claim, and browse products.
  - name: Product Group
    description: Manage GDSN packaging hierarchy relationships.
  - name: Import
    description: >-
      Bulk import products, batch/lots (GS1 AI 10) and serial numbers (GS1 AI
      21) from CSV, TSV or XLSX files, with a downloadable template per entity.
  - name: Digital Link
    description: >-
      Parse GS1 Digital Link URIs into structured AIs (GTIN, lot, expiry,
      serial).
  - name: Labels
    description: >-
      Bulk label-export jobs: ZIPs of QR / DataMatrix / 1D symbols and multi-up
      sheet PDFs, asynchronous, with status polling.
  - name: Lots
    description: >-
      Lot generator v2: format templates with persistent counters,
      reserve/commit/discard runs, soft/hard collision handling, and an
      asynchronous path with SSE progress; and the barcode for one stored lot.
  - name: Serials
    description: >-
      The barcode for one stored serial (GS1 AI 21), with its lot when it is
      linked to one.
  - name: Returnable assets
    description: >-
      The barcode for one stored GRAI (GS1 AI 8003), the identifier of a pallet,
      crate, keg or other returnable asset.
  - name: Product models
    description: >-
      The barcode for the GMN (GS1 AI 8013) a stored product carries, the
      identifier of a product model.
  - name: Individual assets
    description: >-
      The barcode for one stored GIAI (GS1 AI 8004), the identifier of a
      forklift, laptop, tool or other individually tracked fixed asset.
  - name: Logistic units
    description: >-
      The barcode for one stored SSCC (GS1 AI 00), the identifier of a pallet or
      other logistic unit.
  - name: Lots and serials
    description: >-
      The lots (GS1 AI 10) and serials (GS1 AI 21) registered on one of the
      organization's products: list, read, create, update and delete each, or
      register a value seen in scan history.
  - name: Retailer Catalog Import
    description: >-
      Server-side retailer catalog import jobs: stage normalised rows, then run
      the GTIN-keyed cross-retailer merge with a dry-run mode, per-field
      provenance and a quarantine report for every row refused.
  - name: HRI Presets
    description: >-
      Saved, named per-organisation Human Readable Interpretation (HRI)
      configurations — placement, layout, notation and typography. Referenceable
      by name from the QR generation endpoint, with an org default applied when
      no options or preset are supplied.
  - name: PIP Embed (Public)
    description: >-
      Unauthenticated, cross-origin read powering the embeddable PIP panel
      (`/widget/v1/pip-panel.js`) that retailers drop into their own product
      detail pages. Reduced to the disclosure level the hosted page would serve
      an anonymous visitor.
  - name: Recipes
    description: >-
      Recipes shown on a product's hosted page. Create a recipe, attach it to
      the organization's products by GTIN, and update or delete it.
  - name: Firmware
    description: >-
      Firmware releases shown on a product's hosted page. Publish a release for
      the organization's products by GTIN, mark it latest or stable, and update
      or delete it.
  - name: App Links
    description: >-
      Companion-app download and launch links shown on a product's hosted page,
      one per platform. Create, list, update and delete the links on the
      organization's products.
  - name: Replacement Parts
    description: >-
      Replacement parts shown on a product's hosted page. List one of the
      organization's products as a part of another, repoint it, or remove it.
  - name: Accessories
    description: >-
      Accessories shown on a product's hosted page. List one of the
      organization's products as an accessory of another, repoint it, or remove
      it.
  - name: Consumables
    description: >-
      Consumables shown on a product's hosted page (filters, refills,
      cartridges). List one of the organization's products as a consumable of
      another, with its lifespan and whether it is required, repoint it, or
      remove it.
  - name: Product Families
    description: >-
      Consumer variant groups: one organization's products that are the same
      concept in different sizes, shades, flavors or scents. Create a family,
      then add, update, reorder and remove its member products. Distinct from
      Product Group, which is packaging hierarchy.
  - name: Product Links
    description: >-
      Generic, GS1-link-type-keyed brand CTA links (e.g. reviews, promotions,
      loyalty programs, homepage) attached to a product or a brand and rendered
      on the hosted page.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /products/api/v1/products/{gtin}/verification/http-check:
    post:
      tags:
        - Products
      summary: Check the brand domain's .well-known file
      description: >-
        Fetches the verification file URL named in the verification status
        response and compares its contents with the claim token. A match records
        a domain-control proof for the reviewer; it does not verify the claim.
        Returns 409 when HTTP verification is not enabled on this deployment;
        use the DNS check instead. Requires the
        ``organization.contribute_organization`` permission on the membership
        owning the GTIN. Rate-limited per user and per organization; over the
        limit returns 429.
      operationId: post_claim_http_check
      parameters:
        - in: path
          name: gtin
          schema:
            description: >-
              GTIN barcode (8, 12, 13, or 14 digits). Normalized to GTIN-14 for
              lookup.
            format: gtin
            maxLength: 14
            minLength: 8
            pattern: ^[0-9]{8}$|^[0-9]{12,14}$
            title: Gtin
            type: string
          required: true
          description: >-
            GTIN barcode (8, 12, 13, or 14 digits). Normalized to GTIN-14 for
            lookup.
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ClaimHttpCheckOut'
        '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'
        '409':
          description: Conflict
          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:
    ClaimHttpCheckOut:
      description: >-
        Result of fetching the brand domain's .well-known file for the claim
        token.
      examples:
        - claim_verification_status: unverified
          evidence:
            badge: pending
            created: '2026-09-29T14:03:11Z'
            evidence_type: domain_match
            has_file: true
            id: 2N4kq7ZxYQ8vR3sT1bWnCp
            notes: GS1 US company prefix certificate, issued 2024.
            review_status: pending
            strength: medium
          file_url: https://acme.example/.well-known/closient-verification.txt
          message: Domain ownership verified via the .well-known file.
          outcome: proof_recorded
          token: closient-verify=3f9c1a7e5b2d4c6a8e0f1b3d5c7a9e1f
      properties:
        outcome:
          $ref: '#/components/schemas/HttpCheckOutcomeEnum'
          description: >-
            proof_recorded means the file held the token and a domain-control
            proof was recorded for the reviewer. It does not change the claim's
            status. destination_refused means the file was not fetched: the
            domain resolves to an address that is not public, or the server
            answered with a redirect, which is never followed.
        message:
          description: What happened and, on a miss, what to fix.
          title: Message
          type: string
        file_url:
          description: URL that was fetched; empty if the brand has no domain.
          title: File Url
          type: string
        token:
          description: The token the file must contain.
          title: Token
          type: string
        evidence:
          anyOf:
            - $ref: '#/components/schemas/ClaimEvidenceOut'
            - type: 'null'
          description: The recorded proof when outcome is proof_recorded.
        claim_verification_status:
          $ref: '#/components/schemas/ClaimVerificationStatusEnum'
          description: >-
            The claim's status after the check, which a domain check never
            changes.
      required:
        - outcome
        - message
        - file_url
        - token
        - evidence
        - claim_verification_status
      title: ClaimHttpCheckOut
      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
    HttpCheckOutcomeEnum:
      description: |-
        Result of an HTTP ``.well-known`` domain-control check.

        Maps ``HttpVerificationOutcome``; a
        match is ``proof_recorded`` on the wire for the same reason as
        ``DnsCheckOutcomeEnum``.
      enum:
        - proof_recorded
        - no_domain
        - no_file
        - token_mismatch
        - fetch_error
        - destination_refused
      title: HttpCheckOutcomeEnum
      type: string
    ClaimEvidenceOut:
      description: One piece of evidence the organization has filed for this claim.
      examples:
        - badge: pending
          created: '2026-09-29T14:03:11Z'
          evidence_type: gs1_certificate
          has_file: true
          id: 2N4kq7ZxYQ8vR3sT1bWnCp
          notes: GS1 US company prefix certificate, issued 2024.
          review_status: pending
          strength: strong
      properties:
        id:
          description: Evidence identifier.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        evidence_type:
          $ref: '#/components/schemas/EvidenceTypeEnum'
          description: What kind of proof this is.
        strength:
          $ref: '#/components/schemas/EvidenceStrengthEnum'
          description: How much it counts toward Verified, set from the evidence type.
        review_status:
          $ref: '#/components/schemas/EvidenceReviewStatusEnum'
          description: >-
            Staff review state. Only approved, unexpired evidence counts toward
            Verified.
        badge:
          description: >-
            Display state combining review status and expiry: approved,
            rejected, expired or pending. An approved row past its expires_at
            reads expired and no longer counts.
          title: Badge
          type: string
        notes:
          description: Free-text description submitted with the evidence.
          title: Notes
          type: string
        has_file:
          description: >-
            Whether a file is attached. The file itself is visible only to
            reviewers.
          title: Has File
          type: boolean
        expires_at:
          anyOf:
            - format: date-time
              type: string
            - type: 'null'
          description: >-
            When approved evidence stops counting toward Verified; null means it
            does not expire.
          title: Expires At
        created:
          description: When the evidence was submitted.
          format: date-time
          title: Created
          type: string
      required:
        - id
        - evidence_type
        - strength
        - review_status
        - badge
        - notes
        - has_file
        - expires_at
        - created
      title: ClaimEvidenceOut
      type: object
    ClaimVerificationStatusEnum:
      description: |-
        Tier of verification applied to a GTIN ownership claim.

        Mirrors ``ClaimVerificationStatus``.
        Null on the wire when a product has never been claimed.
      enum:
        - unverified
        - prefix_matched
        - verified
        - disputed
        - rejected
      title: ClaimVerificationStatusEnum
      type: string
    EvidenceTypeEnum:
      description: >-
        Kind of evidence backing a GTIN ownership claim.


        Mirrors ``EvidenceType``. ``domain_match`` and

        ``dns_txt_proof`` are written only by the automated domain checks and

        ``staff_attestation`` only by Closient staff, ``proof_of_brand`` only by
        an

        approved Proof of Brand licence claim; a caller uploads one of

        ``SubmittableEvidenceTypeEnum``.
      enum:
        - gs1_certificate
        - gepir_lookup
        - domain_match
        - dns_txt_proof
        - invoice
        - other
        - staff_attestation
        - proof_of_brand
      title: EvidenceTypeEnum
      type: string
    EvidenceStrengthEnum:
      description: |-
        How much a piece of evidence counts toward verification.

        Mirrors ``EvidenceStrength``.
      enum:
        - strong
        - medium
        - weak
      title: EvidenceStrengthEnum
      type: string
    EvidenceReviewStatusEnum:
      description: |-
        Staff review state of a piece of claim evidence.

        Mirrors ``EvidenceReviewStatus``.
      enum:
        - pending
        - approved
        - rejected
      title: EvidenceReviewStatusEnum
      type: string
  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.