Skip to navigation
REST API EndpointsUsers

Start Customer Application

View as Markdown

Start a new customer application.

Available to: All authenticated users

Environments: Live

Rate Limit: 10 requests per hour, 30-second back-off, counts all requests

Start the account-opening workflow by creating a CustomerApplication for a user. This is the first call in the application flow — the returned application’s id is the customerApplicationId you pass to submitApplicant, prepareAgreementDocuments, signAgreementDocuments, and submitCustomerApplicationDocument.

Set accountType and legalStatus for the application. You can optionally set clearingHouseId to route the application to a specific clearing house; if omitted, the system assigns one. Applications started with legalStatus of GP are stored as PTR.

By default, the application is created for the calling user. To start an application on behalf of another user, set userId — this requires the caller to be an organization administrator with business-to-business account-opening (B2B AOP) permission in an organization that allows customer applications.

A successful request returns the created customerApplication entity with applicationStatus of PendingApplication. You can read it back at any time with customerApplicationItem or list a user’s applications with customerApplicationDependents.

Common Failure Scenarios

  • The request originates from a restricted country.
  • The user already has a saved application of the same account type.
  • The user’s organization does not allow customer applications.
  • userId is provided but the caller does not have B2B AOP permission.
  • The caller belongs to a reliance-agreement organization and cannot sign on behalf of customers.

Error Messages

errorTextTrigger
"We have noticed that your location does not match the Country of Residence; unfortunately, we cannot proceed with your application at this time"The request originates from a restricted country.
"An application of this type has already been created."The user already has a saved application with the requested account type.
"Access denied"The user’s organization does not allow customer applications.
"Must be a B2B AOP user"userId references another user, but the caller is not an organization administrator with B2B AOP permission.
"This operation should be performed by your organization"The caller’s organization has a reliance agreement, and the caller cannot sign on behalf of customers.

Next Steps

Authentication

AuthorizationBearer

Bearer authentication of the form Bearer <token>, where token is your auth token.

Request

This endpoint expects an object.
accountTypeenumRequired
Customer, Employee, Giveup, House, Omnibus, Wash
legalStatusenumRequired
Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
clearingHouseIdlongOptional
userIdlongOptional
bucketstringOptional<=64 characters

Response

CustomerApplicationResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

customerApplicationobjectOptional