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

# Check your key

> Returns the application, environment and permissions behind the key you used. This is the first call to make: it confirms the key works and tells you what it may do.

Needs no scope: any valid key can call it.



## OpenAPI

````yaml /openapi/etims.json get /v1/me
openapi: 3.1.0
info:
  title: Sync2Books Compliance API (eTIMS)
  version: 1.0.0
  description: >-
    Register items, issue sales and credit notes, record stock and read supplier
    invoices for a Kenyan business, with every fiscal document signed by KRA
    eTIMS.


    Authenticate with an API key from the compliance dashboard, sent in the
    `x-api-key` header or as a bearer token. A `cmp_sk_test_...` key acts on
    sandbox businesses and a `cmp_sk_live_...` key on production ones; both use
    the same base URL.


    New here? Start with the [eTIMS quickstart](/etims-quickstart). The
    conventions every endpoint shares are in [Authentication & API
    keys](/etims-authentication), [Errors & Troubleshooting](/etims-errors),
    [Idempotency](/etims-idempotency) and [Rate limits](/etims-rate-limits).


    This is a separate product from the [Accounting API](/api-reference), with
    its own keys.
servers:
  - url: https://sync2books-compliance-api.apps.kintro.money
    description: >-
      Sync2Books Compliance API. The key you use decides whether a call reaches
      the KRA sandbox or production.
security:
  - ApiKeyAuth: []
  - BearerAuth: []
tags:
  - name: Identity
    description: Check what a key can do.
  - name: Businesses
    description: The businesses and branches a key can act for.
  - name: Items
    description: >-
      Create items and register them with KRA. An item must be registered before
      it can be sold.
  - name: Stock
    description: Record stock movements and report them to KRA.
  - name: Sales
    description: Issue sales, read them back and download KRA-signed receipts.
  - name: Credit notes
    description: Reverse an accepted sale in full.
  - name: Purchases
    description: Supplier invoices KRA holds against the business.
  - name: Lookups
    description: KRA code lists and item classifications.
paths:
  /v1/me:
    get:
      tags:
        - Identity
      summary: Check your key
      description: >-
        Returns the application, environment and permissions behind the key you
        used. This is the first call to make: it confirms the key works and
        tells you what it may do.


        Needs no scope: any valid key can call it.
      operationId: getMe
      responses:
        '200':
          description: What the key can do.
          headers:
            X-RateLimit-Limit:
              $ref: '#/components/headers/RateLimitLimit'
            X-RateLimit-Remaining:
              $ref: '#/components/headers/RateLimitRemaining'
            X-RateLimit-Reset:
              $ref: '#/components/headers/RateLimitReset'
          content:
            application/json:
              schema:
                type: object
                required:
                  - data
                properties:
                  data:
                    type: object
                    properties:
                      applicationId:
                        type: string
                      environment:
                        $ref: '#/components/schemas/Environment'
                      businessId:
                        type:
                          - string
                          - 'null'
                        description: >-
                          The business a business-bound key is limited to.
                          `null` for an organisation-wide key.
                      scope:
                        type: string
                        enum:
                          - business
                          - organization
                      scopes:
                        type: array
                        items:
                          type: string
                      rateLimitPerMin:
                        type: integer
                        description: Requests per minute your application may make.
              example:
                data:
                  applicationId: app_example_1
                  environment: SANDBOX
                  businessId: biz_example_1
                  scope: business
                  scopes:
                    - catalog:read
                    - catalog:write
                    - sales:read
                    - sales:write
                    - stock:write
                    - purchases:read
                    - lookups:read
                  rateLimitPerMin: 120
        '401':
          $ref: '#/components/responses/Unauthorized'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  headers:
    RateLimitLimit:
      description: Requests allowed per minute for your application.
      schema:
        type: integer
    RateLimitRemaining:
      description: Requests left in the current one-minute window.
      schema:
        type: integer
    RateLimitReset:
      description: >-
        Seconds until the current window resets. This is a number of seconds,
        not a Unix timestamp.
      schema:
        type: integer
  schemas:
    Environment:
      type: string
      enum:
        - SANDBOX
        - PRODUCTION
      description: >-
        `SANDBOX` is the KRA test environment. `PRODUCTION` files real tax
        documents.
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: object
          required:
            - code
            - message
          additionalProperties: true
          properties:
            code:
              type: string
              description: >-
                A stable, machine-readable code. Branch on this. See [Errors &
                Troubleshooting](/etims-errors) for the full list.
              examples:
                - invalid_request
                - kra_rejected
                - already_credited
            message:
              type: string
              description: >-
                A human-readable explanation. The wording can change; do not
                parse it.
          description: >-
            Some errors carry extra fields next to `code` and `message`, for
            example `sale`, `item`, `errors`, `creditNoteId` or `branches`.
  responses:
    Unauthorized:
      description: >-
        The key is missing, malformed, revoked, expired or belongs to a
        suspended application. The response never says which.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            invalid_api_key:
              summary: invalid_api_key
              value:
                error:
                  code: invalid_api_key
                  message: Invalid API key
    RateLimited:
      description: >-
        The application has used its requests for this minute. Wait
        `Retry-After` seconds.
      headers:
        X-RateLimit-Limit:
          $ref: '#/components/headers/RateLimitLimit'
        X-RateLimit-Remaining:
          $ref: '#/components/headers/RateLimitRemaining'
        X-RateLimit-Reset:
          $ref: '#/components/headers/RateLimitReset'
        Retry-After:
          description: Seconds to wait before trying again.
          schema:
            type: integer
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          examples:
            rate_limited:
              summary: rate_limited
              value:
                error:
                  code: rate_limited
                  message: >-
                    Rate limit of 120 requests per minute exceeded. Retry in
                    23s.
  securitySchemes:
    ApiKeyAuth:
      type: apiKey
      in: header
      name: x-api-key
      description: >-
        Your API key, for example `cmp_sk_test_xxxxxxxxxxxxxxxxxxxxxxxx`. Create
        one on the Integrations page of the compliance dashboard.
    BearerAuth:
      type: http
      scheme: bearer
      bearerFormat: cmp_sk_...
      description: >-
        The same key, sent as `Authorization: Bearer <key>`. Use this if your
        HTTP client makes custom headers awkward.

````

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