Skip to navigation
REST API EndpointsUsers

Customer Application Items

View as Markdown

Fetch multiple customer applications by ID.

Available to: All authenticated users

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Returns the CustomerApplication entities identified by the ids query parameter (a comma-separated list of entity IDs). This is the batch form of customerApplicationItem — use it to check several applications in one request instead of one call per ID.

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.

To list applications by user instead of by application ID, use customerApplicationDependents or customerApplicationLDependents.

Results are scoped to the entities the caller is permitted to see; IDs the caller cannot access are not returned.

Common Failure Scenarios

  • The ids parameter is missing or contains values that are not valid entity IDs.
  • 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

idslist of longsRequired

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