API Service Documentation

The external user ID, used to uniquely identify this user between the two systems (required)

The username of the customer (alphanumeric and dashes). This cannot be left blank if automatic user creation is desired.

Not required. If provided, the password must contain at least 7 characters and include at least one uppercase letter, one lower case letter, and one number

An optional/custom account type. If "User" (the default), this can be omitted.
@pair_existing String N 0 | If set to "1" THEN existing/conflicting usernames will be paired instead of returning an error if BOTH username and email address match

YYYY-MM-DD HH:MM:SS
A custom date of creation
(If omitted, assumes the current server date and time)

The new internal ID used by this system. It is not required that you store this value as we will store your external_id in association with this account.

The session keys passed to assume the newly logged-in session
session keys must be used promtply after generating them so this API should be called right before redirecting the user
see the returned 'dashboard_url' for an example of how to use the session key paramaters

The URL you may use to send this user to our dashboard page
@example commandline