Start Customer Application
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
Response
Non-empty if the request failed
Bearer authentication of the form Bearer <token>, where token is your auth token.
Non-empty if the request failed
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
userId is provided but the caller does not have B2B AOP permission.Error Messages
Next Steps
submitApplicant.