Skip to main content
POST
Register business
Call with your partner API key in X-API-Key. Do not use a business tyms_sk_ key. After success, use the returned api_secret_key for all other endpoints.

Authorizations

X-API-Key
string
header
default:your_tyms_sk_or_partner_key
required

Business secret tyms_sk_... for business-scoped routes. Partner secret for register-business and referred-business distributor routes.

Body

application/json
email
string<email>
required
firstname
string
required
lastname
string
required
business_name
string
required
password
string
required

Owner account password. Must be at least 8 characters and include a letter, a number, and a special character (e.g. !@#$%^&*).

Minimum string length: 8
Example:

"Secure1!"

country
string
default:US
currency
string
default:USD
timezone
string
default:America/New_York
industry
string
grant_access
enum<string>

admin returns api_public_key and api_secret_key in the response.

Available options:
admin,
viewer,
editor
credit_from_referral_partner
boolean
default:false

When true, Tyms credit usage for this business is charged to the referring partner's credit balance in the partner portal (the partner manages credit for the business). Optional; defaults to false.

Response

Business created; api_secret_key only when grant_access is admin

status
string
Example:

"success"

message
string
data
object