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

# Fetch a chip

> Returns a single chip by its identifier, including a snapshot of the unit it is paired to and that unit's issuance status.



## OpenAPI

````yaml /openapi.json get /v1/chips/{chip_id}
openapi: 3.1.0
info:
  title: Endstate API
  version: 0.1.0
  description: Endstate developer API for chip verification and ownership workflows.
servers:
  - url: https://api2.endstate.io
    description: Production
  - url: https://api-staging.endstate.io
    description: Staging
security: []
paths:
  /v1/chips/{chip_id}:
    get:
      tags:
        - Chips
      summary: Fetch a chip
      description: >-
        Returns a single chip by its identifier, including a snapshot of the
        unit it is paired to and that unit's issuance status.
      operationId: getChip
      parameters:
        - schema:
            type: string
            pattern: ^[0-9A-Fa-f]{10}$
            description: Chip identifier from the tap URL. Always returned uppercase.
            example: ABCDEF0123
          required: true
          name: chip_id
          in: path
      responses:
        '200':
          description: The chip.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Chip'
              example:
                chip_id: ABCDEF0123
                is_test: false
                scan_count: 47
                created_at: '2026-05-16T12:00:00.000Z'
                unit:
                  id: 22222222-2222-2222-2222-222222222222
                  external_id: unit-001
                  name: Example Unit
                  attributes:
                    custom_attribute: value
                  created_at: '2026-05-16T12:00:00.000Z'
                  redirect_url: null
                  collection:
                    id: 8e1a7f50-90ab-4cde-8012-3456789abcde
                    name: Example Collection
                    external_id: collection-001
                    contract:
                      address: '0x1111111111111111111111111111111111111111'
                      chain_id: 84532
                      status: active
                    token:
                      status: active
                      serial: 5
        '400':
          description: >-
            The request was malformed or failed validation.


            | Error code | When |

            | --- | --- |

            | `validation.failed` | The request failed schema validation. See
            `error.details` for per-field issues. |
          x-error-codes:
            - validation.failed
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                validation.failed:
                  summary: >-
                    The request failed schema validation. See `error.details`
                    for per-field issues.
                  value:
                    error:
                      code: validation.failed
                      message: >-
                        The request failed schema validation. See
                        `error.details` for per-field issues.
                      request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde
                      doc_url: https://docs.endstate.io/errors/validation-failed
        '401':
          description: |-
            Authentication failed.

            | Error code | When |
            | --- | --- |
            | `auth.unauthorized` | Credential is missing or malformed. |
          x-error-codes:
            - auth.unauthorized
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                auth.unauthorized:
                  summary: Credential is missing or malformed.
                  value:
                    error:
                      code: auth.unauthorized
                      message: Credential is missing or malformed.
                      request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde
                      doc_url: https://docs.endstate.io/errors/auth-unauthorized
        '404':
          description: >-
            The resource does not exist within your organization.


            | Error code | When |

            | --- | --- |

            | `chip.not_found` | The chip ID does not exist in your
            organization. |
          x-error-codes:
            - chip.not_found
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                chip.not_found:
                  summary: The chip ID does not exist in your organization.
                  value:
                    error:
                      code: chip.not_found
                      message: The chip ID does not exist in your organization.
                      request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde
                      doc_url: https://docs.endstate.io/errors/chip-not-found
        '429':
          description: |-
            Too many requests.

            | Error code | When |
            | --- | --- |
            | `rate_limit.exceeded` | Per-key rate limit exceeded. |
          x-error-codes:
            - rate_limit.exceeded
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                rate_limit.exceeded:
                  summary: Per-key rate limit exceeded.
                  value:
                    error:
                      code: rate_limit.exceeded
                      message: Per-key rate limit exceeded.
                      request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde
                      doc_url: https://docs.endstate.io/errors/rate-limit-exceeded
        '500':
          description: >-
            Something went wrong on our end.


            | Error code | When |

            | --- | --- |

            | `internal.error` | An unexpected server error occurred. Retry with
            exponential backoff and include `request_id` in any support request.
            |
          x-error-codes:
            - internal.error
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorResponse'
              examples:
                internal.error:
                  summary: >-
                    An unexpected server error occurred. Retry with exponential
                    backoff and include `request_id` in any support request.
                  value:
                    error:
                      code: internal.error
                      message: >-
                        An unexpected server error occurred. Retry with
                        exponential backoff and include `request_id` in any
                        support request.
                      request_id: req_8e1a7f50-90ab-4cde-f012-3456789abcde
                      doc_url: https://docs.endstate.io/errors/internal-error
      security:
        - ApiKeyBearer: []
components:
  schemas:
    Chip:
      type: object
      properties:
        chip_id:
          type: string
          pattern: ^[0-9A-F]{10}$
          description: Chip identifier from the tap URL.
          example: ABCDEF0123
        is_test:
          type: boolean
          description: >-
            True for a test chip, false for a chip encoded onto physical
            hardware.
        scan_count:
          type: integer
          minimum: 0
          description: Number of taps recorded for this chip.
        created_at:
          type: string
          format: date-time
        unit:
          type:
            - object
            - 'null'
          properties:
            id:
              type: string
              format: uuid
            external_id:
              type:
                - string
                - 'null'
            name:
              type:
                - string
                - 'null'
            attributes:
              type:
                - object
                - 'null'
              additionalProperties: {}
            created_at:
              type: string
              format: date-time
            redirect_url:
              type:
                - string
                - 'null'
              format: uri
              description: >-
                Tap redirect URL for this unit; takes precedence over
                product/collection/org defaults.
              example: https://brand.example/p
            collection:
              $ref: '#/components/schemas/CollectionMembership'
          required:
            - id
            - external_id
            - name
            - attributes
            - created_at
            - redirect_url
            - collection
          description: >-
            Snapshot of the unit this chip is paired to, including its
            collection and issuance status. Null when the chip is not paired to
            a unit.
      required:
        - chip_id
        - is_test
        - scan_count
        - created_at
        - unit
      example:
        chip_id: ABCDEF0123
        is_test: false
        scan_count: 47
        created_at: '2026-05-16T12:00:00.000Z'
        unit:
          id: 22222222-2222-2222-2222-222222222222
          external_id: unit-001
          name: Example Unit
          attributes:
            custom_attribute: value
          created_at: '2026-05-16T12:00:00.000Z'
          redirect_url: null
          collection:
            id: 8e1a7f50-90ab-4cde-8012-3456789abcde
            name: Example Collection
            external_id: collection-001
            contract:
              address: '0x1111111111111111111111111111111111111111'
              chain_id: 84532
              status: active
            token:
              status: active
              serial: 5
    ErrorResponse:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              anyOf:
                - $ref: '#/components/schemas/ErrorCode'
                - type: string
              description: >-
                Stable, namespaced error code. The `ErrorCode` catalogue lists
                every code defined today; handle an unrecognized value as a
                generic failure rather than throwing, since codes are added over
                time.
              example: chip.not_found
            message:
              type: string
              description: >-
                Human-readable description, for logs and debugging. Wording may
                change without notice - never parse or match against it.
              example: Chip not found
            request_id:
              type: string
              description: >-
                Identifier for this request, matching the `X-Request-Id`
                response header. Log it and include it in any support request.
              example: req_8e1a7f50-90ab-4cde-f012-3456789abcde
            doc_url:
              type: string
              description: Documentation page for this error code.
              example: https://docs.endstate.io/errors/chip-not-found
            details:
              $ref: '#/components/schemas/ValidationErrorDetails'
          required:
            - code
            - message
            - request_id
            - doc_url
      required:
        - error
      description: >-
        Every error response, regardless of endpoint or HTTP status, uses this
        envelope.
    CollectionMembership:
      type:
        - object
        - 'null'
      properties:
        id:
          type: string
          format: uuid
        name:
          type:
            - string
            - 'null'
        external_id:
          type:
            - string
            - 'null'
        contract:
          type: object
          properties:
            address:
              type: string
              description: Unique address identifying the collection.
              example: '0x1111111111111111111111111111111111111111'
            chain_id:
              type: integer
              example: 84532
            status:
              type: string
              enum:
                - deploying
                - active
                - failed
              description: >-
                Collection lifecycle status. `deploying` while the collection is
                being provisioned; `active` once it is ready to use.
              example: active
          required:
            - address
            - chain_id
            - status
        token:
          $ref: '#/components/schemas/UnitToken'
      required:
        - id
        - name
        - external_id
        - contract
        - token
      description: >-
        The unit's collection. Null only for units created before collections
        existed.
    ErrorCode:
      type: string
      enum:
        - validation.failed
        - auth.unauthorized
        - auth.forbidden
        - session_token.invalid_or_expired
        - session_token.wrong_chip
        - not_found.resource
        - rate_limit.exceeded
        - chip.not_found
        - chip.invalid_e_value
        - chip.already_scanned
        - quota.exceeded
        - chip.not_a_test_chip
        - unit.not_found
        - unit.already_exists
        - unit.not_minted
        - collection.not_found
        - collection.already_exists
        - collection.not_active
        - chip.already_paired
        - chip.bulk_mixed_collections
        - chip.bulk_pending
        - unit.issuance_pending
        - claim.owner_unknown
        - claim.already_to_recipient
        - claim.in_progress
        - claim.not_found
        - chip_replacement.locked
        - chip_replacement.in_progress
        - chip_replacement.not_found
        - transfer.owner_unknown
        - transfer.already_to_recipient
        - transfer.in_progress
        - transfer.not_found
        - idempotency.key_conflict
        - idempotency.in_progress
        - internal.error
      description: >-
        Stable, namespaced error code in `<resource>.<reason>` form. Branch on
        this rather than on `message` or the HTTP status. This is the catalogue
        as of this spec revision, not a closed set - see
        `ErrorResponse.error.code`.
      example: chip.not_found
    ValidationErrorDetails:
      type: object
      properties:
        formErrors:
          type: array
          items:
            type: string
          description: Issues that apply to the request as a whole rather than one field.
          example: []
        fieldErrors:
          type: object
          additionalProperties:
            type: array
            items:
              type: string
          description: Validation issues keyed by the field that failed.
          example:
            name:
              - Required
      required:
        - formErrors
        - fieldErrors
      description: Per-field validation detail. Present only on `validation.failed`.
    UnitToken:
      type: object
      properties:
        status:
          type: string
          enum:
            - pending
            - active
          description: >-
            Issuance state of this unit within the collection. `pending` until
            the unit is issued; `active` once issued. There is no failure
            status: a unit whose issuance cannot complete stays `pending` - if a
            unit remains `pending` well beyond a few minutes, stop polling and
            contact support.
          example: pending
        serial:
          type:
            - integer
            - 'null'
          description: >-
            Collection-scoped serial number. Assigned when the unit becomes
            `active`; null until then.
          example: 5
      required:
        - status
        - serial
  securitySchemes:
    ApiKeyBearer:
      type: http
      scheme: bearer
      bearerFormat: end_sk
      description: >-
        Use `Authorization: Bearer end_sk_*` for partner API keys (e.g.
        `end_sk_AbCd_example_api_key`).

````