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"}