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

# Get Digital Product Passport readiness

> The figures behind the dashboard's EU Digital Product Passport page: how many of your products carry circularity, environmental impact, substance, end-of-life and certification data, and the 20 most recently modified products with their per-product flags. Requires VIEW permission.



## OpenAPI

````yaml /openapi/openapi-resolver.json get /resolver/api/v1/diagnostics/dpp-dashboard
openapi: 3.1.0
info:
  title: Resolver API
  version: 1.0.0
  description: >
    GS1 Digital Link resolution with content negotiation and linkset support.


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


    ## Versioning and Deprecation


    Every response from an operation in this document carries
    `Closient-API-Version` (its `info.version`).

    An operation marked `deprecated` answers with `Deprecation: @<Unix seconds>`

    ([RFC 9745](https://www.rfc-editor.org/rfc/rfc9745)), `Sunset: <HTTP-date>`
    once a

    retirement date is set ([RFC 8594](https://www.rfc-editor.org/rfc/rfc8594)),
    and

    `Link` entries for `rel="deprecation"`, `rel="sunset"` and
    `rel="successor-version"`.

    After its sunset it answers `410 Gone` naming the replacement. Policy:

    https://docs.closient.com/api-versioning
  termsOfService: https://www.closient.com/terms/
servers:
  - url: https://www.closient.com
security: []
tags:
  - name: Resolver
    description: GS1 Digital Link resolution with content negotiation and linkset support.
  - name: Custom URLs
    description: >-
      Reusable custom-URL catalog — create, list, edit, and delete the custom
      redirect destinations that resolution rules point at.
  - name: Resolver Configuration
    description: >-
      Organization resolver settings and per-product resolver state — the
      routing timezone, whether the resolver serves a product, and its per-GTIN
      behavior controls (enhanced resolution, expiry, serial policy, shelf-life
      offset, age gate). The same audited writes the dashboard pages make.
  - name: Link-type sections
    description: >-
      Organization-owned GS1 link-type records — documents (GDTI), coupons (GCN)
      and service relations (GSRN): list, read, create, update and delete. The
      same audited writes the dashboard's Link-type sections page makes.
  - name: Link-type documents
    description: The barcode for one stored GS1 document (GDTI, GS1 AI 253).
  - name: Link-type coupons
    description: >-
      The barcode for one stored GS1 coupon (GCN, GS1 AI 255; not a Stripe
      coupon).
  - name: Link-type service relations
    description: >-
      The barcode for one stored GS1 service relation (GSRN, GS1 AI 8017 or
      8018).
  - name: Lot groups
    description: >-
      Lot groups — named, brand-owned sets of lots that a rule can be scoped to:
      list, read, create, list members, add members and remove a member. Groups
      are never renamed or deleted. The same audited writes the dashboard's lot
      group pages make.
  - name: Serial groups
    description: >-
      Serial groups — named, brand-owned sets of serials that a rule can be
      scoped to: list, read, create, list members, add members and remove a
      member. Groups are never renamed or deleted. The same audited writes the
      dashboard's serial group pages make.
  - name: Routing rules
    description: >-
      Conditional routing rules — per-product rules that decorate the redirect a
      scan resolves to (query parameters and/or the path) when the scanned date,
      lot or serial matches: list, read, create, update, activate and
      deactivate. Rules are never deleted. The same audited writes the
      dashboard's Routing rules pages make.
  - name: Resolver Diagnostics
    description: >-
      Read-only resolver diagnostics — unresolved scans, the resolution log,
      demand signals and a CSV export of every routing rule. The same data the
      dashboard's Resolver diagnostic pages show.
  - name: Verification
    description: >-
      Serial verification (`gs1:verificationService`) — tiered, rate-limited
      responses for serialized GTIN scans. Experimental v1; see the
      verification-service guide.
  - name: GS1 Primitives (Public)
    description: >-
      Keyless GS1 Digital Link primitives — parse, validate, build, decompress,
      and check-digit analysis. **No API key, no signup.** Pure functions over
      strings: no database, no network, no catalog data. IP-throttled and
      edge-cached so repeat calls cost nothing. This is the reference
      implementation the resolver itself runs on.
  - name: Resolver Custom Hostnames
    description: >-
      BYO domain — register a customer-owned hostname, publish the CNAME
      records, verify ownership, and serve an org's Digital Link QRs from its
      own DNS.
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /resolver/api/v1/diagnostics/dpp-dashboard:
    get:
      tags:
        - Resolver Diagnostics
      summary: Get Digital Product Passport readiness
      description: >-
        The figures behind the dashboard's EU Digital Product Passport page: how
        many of your products carry circularity, environmental impact,
        substance, end-of-life and certification data, and the 20 most recently
        modified products with their per-product flags. Requires VIEW
        permission.
      operationId: get_dpp_dashboard
      parameters:
        - in: query
          name: organization_id
          schema:
            description: >-
              Organization to act on. Omit it: an API key acts on its own
              organization, and a session or OAuth caller on its single
              organization. Required only for a session or OAuth caller that
              belongs to more than one organization (400 without it).
            title: Organization Id
            format: shortuuid
            maxLength: 22
            minLength: 22
            pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
            type: string
          required: false
          description: >-
            Organization to act on. Omit it: an API key acts on its own
            organization, and a session or OAuth caller on its single
            organization. Required only for a session or OAuth caller that
            belongs to more than one organization (400 without it).
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/DppDashboardOut'
        '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:
    DppDashboardOut:
      description: >-
        EU Digital Product Passport readiness: catalog-wide coverage and the 20
        most recently modified products.
      examples:
        - coverage:
            total: 120
            with_any_dpp: 45
            with_certifications: 18
            with_circularity: 20
            with_env_impact: 30
            with_eol: 25
            with_substances: 12
          recent_products:
            - gtin: '00952000000019'
              has_certifications: false
              has_circularity: true
              has_env_impact: false
              has_eol: true
              has_substances: false
              id: keATfB8VP2gSjcnTbsMNQL
              product_name: Trail Mix (Demo)
      properties:
        coverage:
          $ref: '#/components/schemas/DppCoverageOut'
          description: Passport-data coverage across the organization's products.
        recent_products:
          description: The 20 most recently modified products, newest first.
          items:
            $ref: '#/components/schemas/DppRecentProductOut'
          title: Recent Products
          type: array
      required:
        - coverage
        - recent_products
      title: DppDashboardOut
      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
    DppCoverageOut:
      description: >-
        How many of the organization's products carry each kind of Digital
        Product Passport data.
      examples:
        - total: 120
          with_any_dpp: 45
          with_certifications: 18
          with_circularity: 20
          with_env_impact: 30
          with_eol: 25
          with_substances: 12
      properties:
        total:
          description: Products the organization owns.
          title: Total
          type: integer
        with_any_dpp:
          description: Products with at least one kind of passport data below.
          title: With Any Dpp
          type: integer
        with_circularity:
          description: Products with a circularity score.
          title: With Circularity
          type: integer
        with_env_impact:
          description: Products with environmental impact data.
          title: With Env Impact
          type: integer
        with_substances:
          description: Products with declared substances of concern.
          title: With Substances
          type: integer
        with_eol:
          description: Products with end-of-life instructions.
          title: With Eol
          type: integer
        with_certifications:
          description: Products with at least one certification.
          title: With Certifications
          type: integer
      required:
        - total
        - with_any_dpp
        - with_circularity
        - with_env_impact
        - with_substances
        - with_eol
        - with_certifications
      title: DppCoverageOut
      type: object
    DppRecentProductOut:
      description: One recently modified product and which kinds of passport data it has.
      examples:
        - gtin: '00952000000019'
          has_certifications: false
          has_circularity: true
          has_env_impact: false
          has_eol: true
          has_substances: false
          id: keATfB8VP2gSjcnTbsMNQL
          product_name: Trail Mix (Demo)
      properties:
        id:
          description: Product public ID.
          format: shortuuid
          maxLength: 22
          minLength: 22
          pattern: ^[23456789ABCDEFGHJKLMNPQRSTUVWXYZabcdefghijkmnopqrstuvwxyz]{22}$
          title: Id
          type: string
        gtin:
          description: The product's GTIN-14.
          title: Gtin
          type: string
        product_name:
          description: Product name.
          title: Product Name
          type: string
        has_circularity:
          description: Has a circularity score.
          title: Has Circularity
          type: boolean
        has_env_impact:
          description: Has environmental impact data.
          title: Has Env Impact
          type: boolean
        has_substances:
          description: Has declared substances of concern.
          title: Has Substances
          type: boolean
        has_eol:
          description: Has end-of-life instructions.
          title: Has Eol
          type: boolean
        has_certifications:
          description: Has at least one certification.
          title: Has Certifications
          type: boolean
      required:
        - id
        - gtin
        - product_name
        - has_circularity
        - has_env_impact
        - has_substances
        - has_eol
        - has_certifications
      title: DppRecentProductOut
      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.