New Account (Create)
Create a new StoneX brokerage account.
This endpoint has two steps;
Step 1: Stage (Submit = False)
This step allows user to submit partial account opening data to be stored by StoneX before the account is submitted.
During this step no business validation will be run against the data provided.
Updating Staged Data
When adding additional data to a staged onboarding request, you will need to provide identifiers for each entity within an array. This allows the API to update the existing entity.
If you wish to add a new entity, send the data block without an identifier.
During staging, the attribute with the value field "*" must be sent to remove a value from the key-value pair.
Onboarding Identifiers
While staging an array for an associated party or TOD beneficiary, the user must provide an onboardingCustomerID. onboardingCustomerID is a user-generated ID.
When a data block within an array is submitted, the API will generate a customerID.
You can retrieve these ID's from the get-account resource.
Step 2: Submit (Submit = True)
Once all the onboarding data for the account has been provided, submit the request with the query parameter Submit = True.
The * on the new account will clear the field. If the new account is executed with Submit=True, first the field will get cleared, and then validations will execute over the data submitted.
The data will be validated upon submission.
When you pass the validation you get the Status = Open at the get-account endpoint and your account creation with StoneX is successful.
See more about Asynchronous Requests