Skip to navigation

Customer Application Create

View as Markdown

Create a customer application entity.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Insert a CustomerApplication entity record directly. This is the generic entity-create operation — it writes the record but does not run the account-opening workflow. To open an account, start the application flow with startCustomerApplication instead, which creates the application together with its workflow state and is the entry point for submitApplicant, prepareAgreementDocuments, and signAgreementDocuments.

The request body is the entity itself. Required fields:

  • userId — the user the application belongs to
  • accountType — Customer, Employee, Giveup, House, Omnibus, or Wash
  • legalStatus — Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, or Trust
  • startDate
  • applicationStatus — PendingApplication, ApprovedApplication, RejectedApplication, PendingReview, InReview, InComplianceReview, ReviewCompleted, EscalatedToAML, or InAMLReview
  • archived

Optional fields include accountId, clearingHouseId, rejectReason, rejectDate, additionalNotes, autoApprovalType, and duplicate. When rejectReason is OtherRejectReason, additionalNotes must be non-empty.

A successful request returns the created entity, including its assigned id.

Common Failure Scenarios

  • A required field is missing.
  • rejectReason is OtherRejectReason without additionalNotes.
  • The caller does not have write access to the referenced user’s applications.
  • The access token is missing or invalid (returns HTTP 401).

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
userIdlongRequired
accountTypeenumRequired
Customer, Employee, Giveup, House, Omnibus, Wash
legalStatusenumRequired
Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
startDatedatetimeRequired
applicationStatusenumRequired
ApprovedApplication, EscalatedToAML, InAMLReview, InComplianceReview, InReview, PendingApplication, PendingReview, RejectedApplication, ReviewCompleted
archivedbooleanRequired
idlongOptional
rejectReasonenumOptional
AMLWatchlist, AutoDenied, CIPCannotVerifyIdentity, ComplianceRejectionHighRisk, DuplicateApplication, IncompleteApplication, OtherRejectReason, PreviousBankruptcy
additionalNotesstringOptional<=8192 characters
accountIdlongOptional
rejectDatedatetimeOptional
clearingHouseIdlongOptional
autoApprovalTypeenumOptional
AutoApproved, PreApproved
Allowed values:
duplicatebooleanOptional
spotMarginEnabledbooleanOptional
futuresDisabledbooleanOptional
swapEnabledbooleanOptional
accountNamestringOptional
riskCategoryIdlongOptional
autoLiqProfileIdlongOptional
marginAccountTypeenumOptional
Hedger, Speculator
Allowed values:
restrictedbooleanOptional
closedbooleanOptional
timestampdatetimeOptional
activebooleanOptional

Response

CustomerApplication
userIdlong
accountTypeenum
Customer, Employee, Giveup, House, Omnibus, Wash
legalStatusenum
Corporation, GP, IRA, Individual, Joint, LLC, LLP, LP, PTR, Trust
startDatedatetime
applicationStatusenum
ApprovedApplication, EscalatedToAML, InAMLReview, InComplianceReview, InReview, PendingApplication, PendingReview, RejectedApplication, ReviewCompleted
archivedboolean
idlongOptional
rejectReasonenumOptional
AMLWatchlist, AutoDenied, CIPCannotVerifyIdentity, ComplianceRejectionHighRisk, DuplicateApplication, IncompleteApplication, OtherRejectReason, PreviousBankruptcy
additionalNotesstringOptional<=8192 characters
accountIdlongOptional
rejectDatedatetimeOptional
clearingHouseIdlongOptional
autoApprovalTypeenumOptional
AutoApproved, PreApproved
Allowed values:
duplicatebooleanOptional
spotMarginEnabledbooleanOptional
futuresDisabledbooleanOptional
swapEnabledbooleanOptional
accountNamestringOptional
riskCategoryIdlongOptional
autoLiqProfileIdlongOptional
marginAccountTypeenumOptional
Hedger, Speculator
Allowed values:
restrictedbooleanOptional
closedbooleanOptional
timestampdatetimeOptional
activebooleanOptional