> ## 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 for `/v2`: exercises the full key → org → allowlist → rate-limit chain and echoes who you are. Still answers when the `/v2` shutter is closed — `status` is `maintenance` or `outage` then, and every other `/v2` route returns 503.



## OpenAPI

````yaml /v2/openapi.json get /ping
openapi: 3.1.0
info:
  title: Jenzy Hermes Multi-asset API
  version: 2.0.0
  description: >-
    Hold and pay out across the assets enabled for your organization. Every
    amount is an exact decimal string beside an `asset` field. Authenticate with
    the same `jz_live_…` API key as `/v1`.
servers:
  - url: https://api.jenzy.com/v2
    description: Production
security: []
paths:
  /ping:
    get:
      summary: Ping
      description: >-
        The auth tracer for `/v2`: exercises the full key → org → allowlist →
        rate-limit chain and echoes who you are. Still answers when the `/v2`
        shutter is closed — `status` is `maintenance` or `outage` then, and
        every other `/v2` route returns 503.
      parameters:
        - $ref: '#/components/parameters/HermesOrg'
      responses:
        '200':
          description: Your org, key prefix, and whether the rest of `/v2` is serving.
          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:
  parameters:
    HermesOrg:
      name: HERMES-ORG
      in: header
      required: false
      description: >-
        The id of one of your Child orgs. The call then acts on that Child org,
        not on your organization. If you do not send it, the call acts on your
        organization. An id that is not one of your Child orgs gives `404`.
      schema:
        type: string
        format: uuid
        example: 3f1c2a9e-8b7d-4e21-9a6f-0c5d4b3e2a10
  schemas:
    Ping:
      type: object
      properties:
        org:
          type: string
          example: Acme Remittances Ltd
        key_prefix:
          type: string
          example: jz_live_AbC123Xy
        status:
          type: string
          enum:
            - live
            - maintenance
            - outage
          description: >-
            Whether the rest of `/v2` is serving. `live` — open. `maintenance` /
            `outage` — the `/v2` shutter is closed and every other `/v2` route
            returns 503 (`service_maintenance` / `service_incident`). `/v1` has
            its own shutter and its own `GET /v1/ping`. The environment is the
            base URL, not this field.
          example: live
      required:
        - org
        - key_prefix
        - status
    ErrorEnvelope:
      type: object
      properties:
        error:
          type: object
          properties:
            code:
              type: string
              enum:
                - validation_error
                - unauthorized
                - forbidden
                - not_found
                - conflict
                - rate_limited
                - internal_error
                - unknown_institution
                - invalid_mobile_number
                - invalid_account_number
                - mobile_number_institution_mismatch
                - service_unavailable
                - sandbox_only
                - insufficient_funds
                - rail_disabled
                - amount_limit_exceeded
                - org_limit_exceeded
                - service_incident
                - service_maintenance
                - onboarding_incomplete
                - access_suspended
                - corridor_not_enabled
                - unsupported_pair
                - invalid_wallet_address
                - rate_unavailable
                - quote_expired
                - quote_used
                - limit_exceeded
                - amount_below_minimum
                - unsupported_asset
                - unsupported_network
                - unsupported_media_type
                - payload_too_large
                - client_ref_used
                - beneficiary_required
                - beneficiary_not_allowed
                - proof_not_expected
                - invalid_beneficiary
                - beneficiary_exists
                - beneficiary_not_active
                - invoice_required
                - prohibited_industry
              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_…`'

````

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