BEEE API Reference

The public REST API is served under https://beeeproject.com/api and returns JSON. The machine-readable description is the OpenAPI spec.

Public endpoints

Method	Path	What it does
GET	/api/banks	List Nigerian bank codes
POST	/api/validate-partner	Validate a partner referral code and return the discounted amount
POST	/api/register	Create a registration
POST	/api/register-init-payment	Start a Paystack payment for a registration
POST	/api/verify-payment	Verify a payment and confirm a registration
GET	/api/user/check?email=	Check whether an email is already registered

Authenticated endpoints

Method	Path	What it does
POST	/api/auth/signup	Create an account and start a session
POST	/api/auth/login	Sign in and start a session
POST	/api/auth/logout	End the session
POST	/api/become-partner	Upgrade the signed-in user to a partner
POST	/api/partner/signup	Register as a partner
POST	/api/partner/settings	Update partner settings
POST	/api/partner/set-code	Set or change a partner code

Authentication and payment verification are described on the authentication and webhooks pages.