POST
Register a New Business

Body

application/json

Request to register a new business.

name
string
required

Response

Business created; API key returned ONCE

Response returned once at creation. The plaintext api_key is shown exactly ONCE and cannot be retrieved later.

api_key
string
required

Plaintext API key — store it now; it cannot be retrieved again.

api_key_prefix
string
required
created_at
string<date-time>
required
id
string<uuid>
required
name
string
required
status
enum<string>
required

Whether a business may authenticate and transact.

Pending is the state a self-onboarded business is created in and stays in until an operator approves it. It exists so a half-finished application has somewhere to live: the alternative — creating the business only on approval — means an applicant who closes the tab has nothing to come back to.

Only Active authenticates. Pending and Rejected are both refused by [AuthenticatedBusiness], and the distinction between them is for the operator reading the list, not for the API.

Available options:
PENDING,
ACTIVE,
DISABLED,
REJECTED