Onboard a new business (Service Provider API)

Server URLloading...

POST

/partner_api/service_providers/business_onboarding

Send

Authorization

Body

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.

Response Body

curl -X POST "https://example.com/partner_api/service_providers/business_onboarding" \  -H "Content-Type: application/json" \  -d '{    "owner": {      "phone": "string",      "firstName": "string",      "lastName": "string",      "sex": "M"    },    "business": {      "name": "string",      "category": "string"    }  }'

{  "business": {    "id": "497f6eca-6276-4993-bfeb-53cbbbba6f08",    "name": "string",    "reference": "string"  },  "serviceProviderMemberId": "9521dd7f-48f7-49ed-bc06-95594b46066b"}