Skip to main content
POST
https://api.useadam.io/v1/adam
/
register-business
Register business
curl --request POST \
  --url https://api.useadam.io/v1/adam/register-business \
  --header 'Content-Type: application/json' \
  --header 'X-API-Key: <api-key>' \
  --data '
{
  "email": "owner@example.com",
  "firstname": "Jane",
  "lastname": "Smith",
  "business_name": "Smith Enterprises",
  "password": "minimum-six-chars",
  "country": "US",
  "currency": "USD",
  "timezone": "America/New_York",
  "grant_access": "admin",
  "credit_from_referral_partner": false
}
'
{
  "status": "success",
  "message": "Business registered successfully.",
  "data": {
    "business_uuid": "550e8400-e29b-41d4-a716-446655440000",
    "name": "Smith Enterprises",
    "currency": "USD",
    "country": "US",
    "api_public_key": "tyms_pk_example",
    "api_secret_key": "tyms_sk_example"
  }
}
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 all routes except Register business, which expects your partner secret.

Body

application/json
​
email
string<email>
required
​
firstname
string
required
​
lastname
string
required
​
business_name
string
required
​
password
string
required
Minimum string length: 6
​
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, Adam 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