Jèko
Service Providers

Create API key for merchant business (Service Provider API)

POST
/partner_api/service_providers/business_api_keys

Creates an API key for a merchant business that the service provider has onboarded. This allows the merchant to access the Partner API.

Prerequisites:

  • The service provider must have onboarded the merchant business (via /business_onboarding)
  • The service provider must have permission to create API keys for the merchant

Use Cases:

  • Generate API credentials for merchants after onboarding
  • Allow merchants to integrate with Jeko's Partner API
  • Manage API access for merchant businesses

Important Notes:

  • The authenticated business must be a service provider
  • The merchant business must exist and be linked to the service provider
  • The API key is returned only once during creation - store it securely
  • The API key is associated with the service provider member that created it

Authentication: Requires API key headers. The authenticated business must be a service provider.

Authorization

ApiKey ApiKeyId
X-API-KEY<token>

In: header

X-API-KEY-ID<token>

In: header

Request Body

application/json

TypeScript Definitions

Use the request body type in TypeScript.

Request schema for creating an API key for a merchant business

Response Body

application/json

application/json

application/json

application/json

application/json

application/json

application/json

curl -X POST "https://example.com/partner_api/service_providers/business_api_keys" \  -H "Content-Type: application/json" \  -d '{    "merchantBusinessId": "19d467bb-96e1-48c8-88c3-25dccb98467b",    "name": "string"  }'
{  "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",  "name": "string",  "businessId": "50092e54-cd12-4059-9828-e8c4ee9a3cf5",  "businessMemberId": "c14d7352-4b97-480a-b5a0-1e65378a78ec",  "createdAt": "2019-08-24T14:15:22Z",  "updatedAt": "2019-08-24T14:15:22Z",  "key": "string"}

List business activities (Service Provider API) GET

Returns the list of business activity categories and their activities. This endpoint is equivalent to `/static/activities` but filters out disabled categories and activities. **Use this endpoint to:** - Get valid activity categories and activities for business registration - Display activity options in your application - Validate activity information before creating businesses **Activity Information:** - Only enabled categories and activities are returned - Activities are grouped by category - Supports language selection via `Accept-Language` header (defaults to French) - Categories and activities are sorted alphabetically **Language Support:** - Send `Accept-Language: en` for English - Send `Accept-Language: fr` for French (default) **Authentication:** Requires API key headers. The authenticated business must be a service provider.

Onboard a new business (Service Provider API) POST

Onboards a new merchant business on behalf of a service provider. This endpoint creates a new user, business, and establishes the service provider relationship. **Use Cases:** - Service providers (like Payme) can onboard merchants through their own platform - Automates the business registration process - Establishes the service provider relationship automatically **What This Endpoint Does:** 1. Creates a new user account (if phone number doesn't exist) 2. Creates a new business with the provided information 3. Sets up the business configuration (enables API access) 4. Creates a service provider business member linking the service provider to the merchant 5. Sets referral code if provided **Important Notes:** - The authenticated business must be a service provider (checked via middleware) - Phone number must **not** already be associated with any existing user in Jeko. If a user with this phone number already exists (regardless of their onboarding status), the request fails with an error. - The service provider business is automatically linked to the merchant business - API access is automatically enabled for the new merchant business **Authentication:** Requires API key headers. The authenticated business must be a service provider.