Kobble
  1. API Fundamentals
Kobble
  • Introduction
  • API Fundamentals
    • Idempotency
    • Rate Limits
    • Healthcheck
      GET
  • Authorization
    • Authorization
    • Get access token
      POST
  • Beneficiaries
    • List all beneficiaries
      GET
    • Get beneficiary by ID
      GET
    • Create beneficiary
      POST
    • Update beneficiary
      PUT
    • Create Payid beneficiary
      POST
  • Cards
    • Cards API
    • Card Creation Flow — Developer Guide & Onboarding
    • Get all cards
      GET
    • Create a new card
      POST
    • Get card by ID
      GET
    • Update card status
      PATCH
    • Replace or renew card
      POST
    • Generate card secret
      POST
  • Card Programs
    • Card Programs API
    • Get all programs
      GET
    • Create a new program
      POST
    • Get program by ID
      GET
  • Clients
    • Clients API
    • Get all clients
      GET
    • Get client by ID
      GET
    • Create a new client
      POST
    • Update client status
      PATCH
  • Endusers
    • Endusers API
    • Usage of Metadata on Endusers
    • Get all endusers
    • Create a new enduser
    • Get enduser by ID
  • Transactions
    • Transactions API
    • Get all transactions
    • Create a transaction
    • Get transaction by ID
    • Create manual credit transaction
    • Create manual debit transaction
  • Wallets
    • Wallets API
    • Get all wallets
    • Create a new wallet
    • Get wallet by ID
    • Update wallet
  • Relays
    • Relays API
    • Create subscription
  • Webhooks
    • Webhooks API
    • Webhook Signature Verification
    • Get all webhooks
    • Create a webhook
    • Delete a webhook
  • Schemas
    • Schemas
      • Webhook
      • Relay
      • Client
      • Beneficiary
      • Card
      • CardCreateInputDto
      • CardStatusUpdateDto
      • CardRenewReplaceInputDto
      • Program
      • MetadataKobbleDebit1
      • ProgramCreateInputDto
      • Person
      • Company
      • Enduser
      • Enduser Create Person Input
      • Enduser Create Company Input
      • Metadata
      • Enduser Create Input DTO
      • Transaction
      • TransactionCreateManualCreditInputDto
      • TransactionCreateInputDto
      • Wallet
      • WalletCreateInputDto
      • WalletUpdateInputDto
  1. API Fundamentals

Healthcheck

GET
/customers/v1/health
The Kobble API provides a health check endpoint at GET /customers/v1/health for monitoring system availability. Use this endpoint for availability monitoring instead of querying business endpoints.

Usage Notes#

No authentication required: This endpoint is publicly accessible
Status values:
Overall status:
UP (all operational)
DEGRADED (some degraded but functional)
DOWN (complete outage)
Service status: UP, DOWN, DEGRADED, or UNKNOWN (timeout/unreachable)
Service details: When status is DEGRADED, check the services object to identify which specific services are affected

Best Practices#

1.
Respect the caching behavior - polling more frequently than every 30 seconds won't provide fresher data
2.
When status is DEGRADED, review the services object to understand which operations might be impacted

Request

None

Request Code Samples

Shell
JavaScript
Java
Swift
Go
PHP
Python
HTTP
C
C#
Objective-C
Ruby
OCaml
Dart
R
Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request GET '/customers/v1/health'

Responses

🟢200Success
application/json
Body

Example
{
    "status": "UP",
    "services": {
        "Transactions": "UP",
        "Wallets": "UP",
        "Clients": "UP",
        "Cards": "UP",
        "Endusers": "UP",
        "Card Transactions": "UP",
        "Webhooks": "UP",
        "Rules": "UP"
    },
    "checked_at": "2024-12-04T10:30:00.000Z"
}
Modified at 2025-12-18 08:43:21
Previous
Rate Limits
Next
Authorization
Built with