Ctrl+K

Signup Request

post/api/v1/user/signup

Request Body

password string required
The password chosen by the user
email string required
The email of the user
signupDomain string
The domain the user signed up on
signupInfo dictionary<string, string>
Additional information about the signup
string
utm_source string
utm_campaign string
app_referral string
The referral code used to sign up if any
source string
Min length: >= 1 characters
organizationId string
The organization ID the user is signing up under
Min length: >= 1 characters
templateId string
Min length: >= 1 characters
bitgoVaspId string
bitgoVaspId the user enterprise belongs to
Min length: >= 1 characters
creditorId string
Creditor identifier stored in enterprise sourceConfigs.metadata.creditorId when provided
Min length: >= 1 characters
signupOrigin string
The origin of the signup request, used to redirect back after email verification
Allowed value: retailmobileapp
acceptTOS boolean
Whether the user accepts the Terms of Service and Master Agreement

200 Response

user object required
username string required
The username of the newly created user

400 Response

name string
Error code
context object required
Properties that apply to a specific error name
error string required
Human-readable error message
requestId string required
Client request id