Skip to main content
POST
Sign a merchant up under an agency (send code, verify, create the store)

Headers

x-agency-signup-key
string

The agency's signup key, for a server-side call that has no browser Origin.

x-end-user-ip
string

The end user's address, accepted only together with a valid signup key.

Body

application/json
action
enum<string>
required
Available options:
send,
verify,
provision
email
string<email>
required
password
string

Required for send and provision

name
string
code
string

The six-digit code, for verify

store_name
string

Required for provision

store_code
string

Six letters or digits; derived from the store name when omitted

business_type
string
country
string
currency
string
phone
string
address
string
store_email
string<email>
plan
string

Plan or tier slug the merchant chose on the agency's page (provision)

period
enum<string>
Available options:
monthly,
annual
offer_code
string

An offer code the merchant entered (provision)

Response

The step succeeded

ok
boolean
verified
boolean

Present after verify

store
object

The created store, after provision

checkout_intent
object | null

The plan, period and offer code kept for the first checkout, after provision

session
object

A signed-in session for the new merchant, after provision