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

# Credit balance and prices

> Scope `credits:read`.



## OpenAPI

````yaml /sentinel/openapi.yaml get /v1/credits
openapi: 3.1.0
info:
  title: Sentinel API
  version: 1.0.0
  summary: >-
    KYC, KYB, AML screening, document (IDP) checks and transaction monitoring
    for Kenya and East Africa.
  description: |
    The Sentinel API by Deeptrack lets your systems run identity, business and
    AML checks without opening the dashboard.

    **Authentication.** Send your API key as a bearer token:
    `Authorization: Bearer gt_live_…` (or `gt_test_…`). Create keys in
    Sentinel under **Developer → API Keys**. Each key has scopes; a key
    without the scope a route needs gets `403`.

    **Test mode.** Test keys (`gt_test_`) return a sandbox result at once
    (`status: completed`, `verdict: pass`, `sandbox: true`), are never
    charged, and store none of the names, numbers or images you send.

    **Asynchronous checks.** `POST /v1/verify/*` answers `202` with an `id`.
    The result arrives by webhook (`sentinel.scan.complete`) or with
    `GET /v1/verify/{id}`.

    **Errors.** Every error is JSON with an `error` message; validation
    errors add `details`, describing what each field takes.

    **Rate limits.** Per key, by plan (Trial 10/min, Starter 60, Growth 200,
    Business 500, Enterprise 1,000), plus an organization-wide cap. A limited
    request gets `429` with `Retry-After` in seconds.

    **Pagination.** List endpoints take `limit` (1–100) and `before`; pass
    the previous answer's `nextCursor` as `before` to get the next page.
    `nextCursor` is `null` on the last page.

    Guides with curl, Node and Python examples are in the Sentinel manual,
    chapters C1 to C9.
  contact:
    name: Deeptrack
    email: tech@deeptrack.io
    url: https://deeptrack.io
  x-changelog: See the manual, chapter C9 (API reference, OpenAPI and Postman).
servers:
  - url: https://robust-parakeet-542.convex.site
    description: >-
      Sentinel production API. Shown on the API Keys page; it may move to an
      api.* address, which will be announced in C9.
security:
  - bearerAuth: []
tags:
  - name: KYC
    description: Identity checks (document, liveness, face match, IPRS and AML).
  - name: KYB
    description: Business checks (registration, address, directors and owners).
  - name: Documents
    description: >-
      IDP document checks (identity documents, proof of address, KRA PIN
      certificates).
  - name: AML
    description: Sanctions, PEP and watch-list screening, and ongoing monitoring.
  - name: Transactions
    description: Transaction monitoring (Business and Enterprise plans, and the trial).
  - name: Capture links
    description: Links a customer opens on their phone to capture their ID and a selfie.
  - name: Results
    description: Read checks and their results.
  - name: Credits
    description: Credit balance, prices and usage.
paths:
  /v1/credits:
    get:
      tags:
        - Credits
      summary: Credit balance and prices
      description: Scope `credits:read`.
      operationId: getCredits
      responses:
        '200':
          description: Balance, plan and price list.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/CreditSummary'
        '401':
          $ref: '#/components/responses/Unauthorized'
        '403':
          $ref: '#/components/responses/Forbidden'
        '429':
          $ref: '#/components/responses/RateLimited'
components:
  schemas:
    CreditSummary:
      type: object
      properties:
        balance:
          type: number
          description: Credits.
        currency:
          type: string
          enum:
            - USD
            - KES
        creditPrice:
          type: number
          description: Price of one credit in your currency.
        planBonus:
          type: number
          description: >-
            Annual-prepayment bonus on your plan, as a fraction (KES plans: 0.1
            = 10% more credits); 0 for USD.
        balanceValue:
          type: number
          description: What the balance is worth on your plan.
        plan:
          type: string
          enum:
            - trial
            - starter
            - growth
            - business
            - enterprise
        prices:
          type: array
          items:
            type: object
            properties:
              service:
                type: string
              credits:
                type: number
              amount:
                type: number
    Error:
      type: object
      required:
        - error
      properties:
        error:
          type: string
        details:
          type: object
          additionalProperties: true
  responses:
    Unauthorized:
      description: Missing, malformed, unknown or revoked API key.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Invalid API key
    Forbidden:
      description: >-
        The key lacks the scope, the IP address isn't allowed, the plan doesn't
        include the feature, or the account isn't active.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: >-
              This API key can't call POST /v1/verify/aml. Give it the
              "verify:aml" scope or use another key.
    RateLimited:
      description: Too many requests. Wait `Retry-After` seconds.
      headers:
        Retry-After:
          schema:
            type: integer
          description: Seconds to wait.
      content:
        application/json:
          schema:
            $ref: '#/components/schemas/Error'
          example:
            error: Rate limit exceeded
  securitySchemes:
    bearerAuth:
      type: http
      scheme: bearer
      description: 'Your API key: gt_live_… or gt_test_…'

````

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