Kobble
Clients
Copy Page
Kobble
Introduction
Authorization
Authorization
Get access token
POST
Beneficiaries
List all beneficiaries
GET
Get beneficiary by ID
GET
Create beneficiary
POST
Update beneficiary
PUT
Cards
Cards API
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
Get all endusers
GET
Create a new enduser
POST
Get enduser by ID
GET
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
Get all webhooks
Create a webhook
Delete a webhook
Clients
Copy Page
Clients API
Kobble Client API
#
Introduction
#
The Kobble Client API enables the management of clients within the Kobble platform. Developers can use this API to create, retrieve, and update client data efficiently and securely.
Overview
#
Provides endpoints for client creation, retrieval, and status updates.
Supports secure and scalable integration for managing client resources.
Built for seamless interaction with financial and business applications.
Key Features
#
RESTful API with well-defined client management operations.
Authentication with secure bearer tokens.
Flexible data structure for handling metadata.
Why Choose the Client API?
#
Streamlines client onboarding and management processes.
Designed to scale with business needs.
Offers extensive documentation for easy integration.
Base URLs
#
Use the appropriate base URL depending on the environment:
Development
:
https://dev.apikobble.net/
Staging
:
https://stage.apikobble.net/
Ensure you prepend the base URL to each endpoint while making requests.
API Endpoints
#
Retrieve all clients.
Create a new client.
Retrieve details of a specific client by its unique identifier.
Update the status of a specific client (ACTIVE or INACTIVE).
Authentication
#
All requests to the Client API require an access token. Include the access token in the headers of each request:
To generate an access token, please refer to
Authorization
.
Error Handling
#
The API returns standard HTTP status codes for responses. Use the status code to determine the result of your request.
Previous
Get program by ID
Next
Get all clients