Skip to navigation
REST API EndpointsUsers

Customer Application Dependents

View as Markdown

List the customer applications for a user.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Returns every CustomerApplication associated with the user identified by the masterid query parameter. Use this to find a user’s applications and their current state — for example, to locate the customerApplicationId for the application-flow endpoints, or to check whether a user already has an application before starting a new one with startCustomerApplication.

Each returned application carries its userId, accountType, legalStatus, startDate, and applicationStatus (PendingApplication, ApprovedApplication, RejectedApplication, PendingReview, InReview, InComplianceReview, ReviewCompleted, EscalatedToAML, or InAMLReview), plus accountId, rejection details, clearingHouseId, autoApprovalType, duplicate, and archived when applicable. See customerApplicationItem for field details. A user with no applications returns an empty array.

To list applications for several users in one request, use customerApplicationLDependents.

Results are scoped to the entities the caller is permitted to see.

Common Failure Scenarios

  • The masterid parameter is missing.
  • The referenced user does not exist or is not visible to the calling user.
  • 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.

Query parameters

masteridlongRequired
User entity ID

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