Skip to main content
POST
Create account

Authorizations

x-api-key
string
header
required

Your SideShift Connect API key (sk_live_* or sk_test_*). Generate from Settings → Connect.

Body

application/json
email
string<email>
required

User's email address

Example:

"jane@example.com"

name
string

Display name (max 100 characters)

Example:

"Jane Creator"

externalId
string

Your platform's stable internal user ID. SideShift checks it within your integration before email lookup and returns the existing account when found. Do not send concurrent create requests for the same value.

Example:

"usr_123"

profileImageUrl
string<uri>

Profile image URL

enableFallbacks
boolean
default:true

When true (default), try provider +alias and SideShift-managed fallback emails on email collision, classified email validation/collision failures, or a payment-provider suspended-account response. Set to false to disable alternate-email provisioning.

passedInBalance
integer

Display-only balance in cents (does not add real funds)

Required range: x >= 0

Response

Account already exists — existing account returned

success
boolean
data
object