Caricash Nova Platform
Home
Home
  1. Clients
  • Default module
    • Clients
      • PBAC for Customer Authentication
      • Create Clients
        POST
    • Internal
      • Accounts, Transactioins and Ledger Implementatioin
      • Ensure real-time balance guarantees
      • Web App Scaffold
      • Database Migrations Guide
      • Microservices
      • Service Implementation
      • TO-DO
      • Authentication & Authorization
    • Customers
      • Onboarding
  • Release Schedule
    • Agency Operations
      • Agent APIs Specs
        • auth
          • POST /v1/agent/auth/login
          • POST /v1/agent/auth/logout
          • POST /v1/agent/auth/refresh
          • POST /v1/agent/auth/device-bind
          • POST /v1/agent/auth/otp/request
          • POST /v1/agent/auth/otp/verify
        • agent
          • GET /v1/agent/me
          • PATCH /v1/agent/me
          • GET /v1/agent/outlet
          • GET /v1/agent/capabilities
        • kyc
          • POST /v1/kyc/customers
          • POST /v1/kyc/customers/{customer_id}/upgrade
          • POST /v1/kyc/customers/{customer_id}/rekcy
          • GET /v1/kyc/customers/{customer_id}/status
        • transactions
          • POST /v1/txns/cashin
          • POST /v1/txns/cashout
          • POST /v1/txns/p2p/assist
          • GET /v1/txns/{txn_id}
          • POST /v1/txns/{txn_id}/reverse
        • wallets
          • GET /v1/wallets/{wallet_id}/balance
          • GET /v1/wallets/{wallet_id}/transactions
        • float
          • GET /v1/float
          • POST /v1/float/topup
          • POST /v1/float/redeem
          • GET /v1/float/instructions/{instruction_id}
        • commissions
          • GET /v1/agents/{agent_id}/commissions
          • POST /v1/agents/{agent_id}/commissions/payouts/preview
          • POST /v1/agents/{agent_id}/commissions/payouts/accept
        • disputes
          • POST /v1/disputes
          • GET /v1/disputes/{case_id}
          • POST /v1/disputes/{case_id}/attachments
        • reports
          • GET /v1/reports/eod
          • POST /v1/reports/eod/close
          • GET /v1/reports/txns
          • GET /v1/reports/float
        • content
          • GET /v1/announcements
        • training
          • GET /v1/training/courses
          • POST /v1/training/quizzes/{quiz_id}/submit
        • ussd
          • POST /v1/ussd/session
          • POST /v1/ussd/agent/menu
        • ops
          • GET /v1/health
      • Agent Scope
        • Agent Scope
    • Customer Operations
      • Customer Scope
        • Customer & Merchant Scope
    • Schemas
      • Agent Ops APIs
  • Nova Core Banking Service API
    • core
      • Create account
      • Get account
      • Get balances
      • Create posting (double-entry)
      • Reverse posting
      • Check limits
      • Generate statement
    • Schemas
      • Schemas
        • Amount
        • Account
        • BalanceSet
        • PostingEntry
        • Posting
        • Hold
        • LimitCheckResponse
        • SavingsProduct
        • OverdraftLine
        • StatementRequest
        • Error
Home
Home
  1. Clients

Create Clients

Developing
POST
/clients
Last modified:2025-07-12 09:13:22
Maintainer:Not configured

Request

Body Params application/json

Examples

Responses

🟢200Success
application/json
Body

Request Request Example
Shell
JavaScript
Java
Swift
curl --location --request POST 'https://api-dev.caricash.com/api/v1/clients' \
--header 'Content-Type: application/json' \
--data-raw '{
  "name": "Test 121",
  "description": "Confidential client for main web frontend",
  "redirectUris": [
    "https://myapp.com/callback"
  ],
  "postLogoutRedirectUris": [
    "https://myapp.com/logout"
  ],
  "grantTypes": [
    "authorization_code",
    "refresh_token"
  ],
  "scopes": [
    "openid",
    "profile",
    "email"
  ],
  "pkceRequired": false,
  "tokenAlgorithm": "HS256",
  "tokenIssuer": "https://myapp.com",
  "tokenAudience": "https://myapp.com",
  "logoUri": "https://myapp.com/logo.png",
  "contactEmail": "support@myapp.com",
  "metadata": {
    "env": "production"
  }
}'
Response Response Example
{
  "success": true,
  "timestamp": "2025-07-12T08:49:13.224Z",
  "correlationId": "db26b5f5-d3c7-4a12-850b-ef1182f22081",
  "resource": "clients",
  "data": {
    "id": "d71ef4ea-4dbb-4210-81d6-024fad663ea5",
    "name": "Test 121",
    "description": "Confidential client for main web frontend",
    "clientCode": "d_7ed5y6w5a42u",
    "type": "public",
    "status": "active",
    "redirectUris": [
      "https://myapp.com/callback"
    ],
    "postLogoutRedirectUris": [
      "https://myapp.com/logout"
    ],
    "grantTypes": [
      "authorization_code",
      "refresh_token"
    ],
    "scopes": [
      "openid",
      "profile",
      "email"
    ],
    "pkceRequired": false,
    "tokenAlgorithm": "HS256",
    "tokenIssuer": "https://myapp.com",
    "tokenAudience": "https://myapp.com",
    "logoUri": "https://myapp.com/logo.png",
    "contactEmail": "support@myapp.com",
    "secretExpiresAt": null,
    "metadata": {
      "env": "production"
    },
    "createdAt": "2025-07-12T08:49:13.143Z",
    "updatedAt": "2025-07-12T08:49:13.143Z"
  },
  "meta": {
    "action": "createClient"
  }
}
Modified at 2025-07-12 09:13:22
Previous
PBAC for Customer Authentication
Next
Accounts, Transactioins and Ledger Implementatioin
Built with