Create user

This endpoint allows requests to create a new user. It uses the provided username, email, password, and confirm_password values to create an account. The system will create a trust account by default for the user.

Body Params
string

No spaces allowed

string
string
string
string
required
string
required
string

This is set to the Users email for compliance purposes.

string
enum

The type of account that will be created. Default account created is Trust

string
string
date
boolean

This is uses all receive the email to proceed with onboarding .Set it to false if you will fully on board the user.

string
enum

The payment source that will be used to bill the account.

Allowed:
string
string
string
string
string
string

Mailing address for the account being created

string
string
string
string
string
enum
Allowed:
string

Drivers license registered state

string
string
string
enum

Required if the account_type is Inherited or Inherited Roth. If account_type is Inherited Roth then rollover_from_account_type is limited to Roth and 401k Roth.

string

Only applicable if account type is Inherited or Inherited Roth

string

Only applicable if account type is Inherited or Inherited Roth

date

Only applicable if account type is Inherited or Inherited Roth

date

Only applicable if account type is Inherited or Inherited Roth

string

Required if the account type is Inherited or Inherited Roth

string

Required if the account type is Inherited or Inherited Roth

boolean

Required if the account type is Inherited or Inherited Roth

string
enum

Only applicable if the account type is Inherited or Inherited Roth. Required if hasMadePaymentElection=true. Ignored if hasMadePaymentElection=false

Allowed:
date

Only applicable if the account type is Inherited or Inherited Roth. Ignored if hasMadePaymentElection=false. Required if previousPaymentElection=life_expectancy

boolean

Designates whether the user can sign in to their account in the user portal (false for managed accounts)

Response

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