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

# Ping

> The auth tracer: exercises the full key → org → allowlist → rate-limit chain and echoes who you are. The first call to make when wiring up a key.



## OpenAPI

````yaml /openapi.json get /ping
openapi: 3.1.0
info:
  title: Jenzy Hermes Client API
  version: 1.0.0
  description: >-
    Draw down your prefunded MWK balance as payouts to Malawian banks and mobile
    money. Authenticate with your `jz_live_…` API key as a bearer token.
servers:
  - url: https://api.jenzy.com/v1
    description: Production
security: []
paths:
  /ping:
    get:
      summary: Ping
      description: >-
        The auth tracer: exercises the full key → org → allowlist → rate-limit
        chain and echoes who you are. The first call to make when wiring up a
        key.
      responses:
        '200':
          description: Your org, key mode, and key prefix.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/Ping'
        '401':
          description: Missing, malformed, or revoked API key.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '403':
          description: Organization suspended, or request IP not on the allowlist.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
        '429':
          description: Rate limit exceeded — honor `Retry-After`.
          content:
            application/json:
              schema:
                $ref: '#/components/schemas/ErrorEnvelope'
      security:
        - ApiKeyAuth: []
components:
  schemas:
    Ping:
      type: object
      properties:
        org:
          type: string
          example: Acme Remittances Ltd
        mode:
          type: string
          enum:
            - live
            - test
        key_prefix:
          type: string
          example: jz_live_AbC123Xy
      required:
        - org
        - mode
        - key_prefix
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - unknown_bank
                - unknown_operator
                - invalid_mobile_number
                - invalid_account_number
                - service_unavailable
                - insufficient_funds
                - rail_disabled
                - amount_limit_exceeded
                - org_limit_exceeded
              description: >-
                Stable identifier a client may branch on — never renamed or
                removed.
            message:
              type: string
          required:
            - code
            - message
      required:
        - error
  securitySchemes:
    ApiKeyAuth:
      type: http
      scheme: bearer
      description: 'Your Jenzy API key: `Authorization: Bearer jz_live_…`'

````