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

# Redeem enrollment code

> Exchange a single-use enrollment code for the consumer's pairwise subject, and create or reactivate the consumer's link to your retailer. Authenticate with HTTP Basic using your retailer client id and secret. Requires a client with `write` scope: a `read` client is refused with 403 (`reason: insufficient_scope`) and the code is left untouched. A client whose organization no longer holds its retailer also answers 403. Expired and revoked codes answer 410, an already redeemed code 409, and an unknown code or one minted for a different retailer 404; repeated failures lock redemption for your retailer and answer 429 with `Retry-After`.



## OpenAPI

````yaml /openapi/openapi-account.json post /account/api/v1/retailer/enrollment-codes/redeem
openapi: 3.1.0
info:
  title: Account API
  version: 1.0.0
  description: >
    Authenticate and manage users, organizations, and API keys.


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


    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: Account
    description: Authenticate and introspect the current user and API key.
  - name: Organizations
    description: Create and manage organizations (businesses).
  - name: Members
    description: Invite, update, and remove organization members.
  - name: API Keys
    description: Create, list, and revoke API keys.
  - name: Preferences
    description: >-
      Create, list, update, and delete the authenticated user's stored trait
      preferences (allergens, dietary stances, certifications, sensitivities).
  - name: Scan History
    description: >-
      Read the current visitor's scan history (authenticated or
      anonymous/session-based) and capture anonymous resolver scans.
  - name: Enrollment Codes
    description: >-
      Mint, list, view, and revoke single-use manual enrollment codes for
      linking a retailer to your account (C-4793).
  - name: Retailer Clients
    description: >-
      Register, list, rotate the secret of, and enable or disable the retailer
      API clients of an organization (C-5848).
  - name: Retailer Enrollment
    description: >-
      Retailer-facing redemption of consumer enrollment codes, authenticated
      with a retailer client's credentials (C-4918).
  - name: Retailer Links
    description: >-
      List, view, unlink, and delete purchase history for the retailers linked
      to your account (C-4794).
externalDocs:
  description: Closient Documentation
  url: https://docs.closient.com
paths:
  /account/api/v1/retailer/enrollment-codes/redeem:
    post:
      tags:
        - Retailer Enrollment
      summary: Redeem enrollment code
      description: >-
        Exchange a single-use enrollment code for the consumer's pairwise
        subject, and create or reactivate the consumer's link to your retailer.
        Authenticate with HTTP Basic using your retailer client id and secret.
        Requires a client with `write` scope: a `read` client is refused with
        403 (`reason: insufficient_scope`) and the code is left untouched. A
        client whose organization no longer holds its retailer also answers 403.
        Expired and revoked codes answer 410, an already redeemed code 409, and
        an unknown code or one minted for a different retailer 404; repeated
        failures lock redemption for your retailer and answer 429 with
        `Retry-After`.
      operationId: redeem_code
      parameters: []
      requestBody:
        content:
          application/json:
            schema:
              $ref: '#/components/schemas/EnrollmentCodeRedeem'
        required: true
      responses:
        '200':
          description: OK
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/EnrollmentCodeRedeemed'
        '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'
        '410':
          description: Gone
          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:
        - RetailerClientBasicAuth: []
components:
  schemas:
    EnrollmentCodeRedeem:
      examples:
        - code: 7K2M-9QXA-5
      properties:
        code:
          description: >-
            The enrollment code the consumer gave you, with or without display
            hyphens.
          maxLength: 64
          minLength: 1
          pattern: ^[^\x00]{1,64}$
          title: Code
          type: string
      required:
        - code
      title: EnrollmentCodeRedeem
      type: object
    EnrollmentCodeRedeemed:
      examples:
        - link_status: created
          pairwise_subject: Zk3x9VQhYw1b2m7r8t0uJg
      properties:
        pairwise_subject:
          description: >-
            Stable identifier for this consumer at your sector. The only
            identifier Closient ever gives you for them; it cannot be correlated
            with any other retailer's.
          title: Pairwise Subject
          type: string
        link_status:
          $ref: '#/components/schemas/LinkOutcomeEnum'
          description: >-
            `created` for a new link, `reactivated` when the consumer had
            unlinked earlier, `already_linked` when the link was already active.
      required:
        - pairwise_subject
        - link_status
      title: EnrollmentCodeRedeemed
      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
    LinkOutcomeEnum:
      enum:
        - created
        - reactivated
        - already_linked
      title: LinkOutcomeEnum
      type: string
  securitySchemes:
    RetailerClientBasicAuth:
      type: http
      scheme: basic

````

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