Create sub-account

Partner-only. Create a child account plus its primary user. The
response includes password_setup.url, a one-time link valid for
6 hours that the merchant uses to set their password and log in for
the first time. No email is sent by ShipScience — forward the link
yourself, or let the merchant use the Forgot Password flow after it
expires.

The response also includes webhook_url, a unique inbound webhook
URL for this sub-account. Configure your partner integration to POST
events for this sub-account to that URL — one URL maps to exactly
one ShipScience account, so no payload-level routing is required.
Sign each request with HMAC-SHA256 over the raw body using the
signing secret for this sub-account's webhook credential
every sub-account has its own auto-generated signing secret,
available from the ShipScience admin UI. Do not reuse a
master-account secret across sub-accounts.

If you receive 403 Forbidden, contact [email protected].

Recent Requests
Log in to see full request history
TimeStatusUser Agent
Retrieving recent requests…
LoadingLoading…
Body Params
account
object
required
primary_user
object
required
Responses

400

Malformed JSON request body. Real HTTP callers receive the standard error envelope ({ "error": { "message": "Malformed JSON request body." } }); the rswag-generated example may be empty because rswag's test path falls through to Rails' default 400 handler in test env. See spec/requests/api/v1/sub_accounts_spec.rb for the real-HTTP behavior.

Language
Credentials
Bearer
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json