REST API EndpointsPersonal Info

Joint Applicant Items

Fetches multiple JointApplicant entities of id field

Authentication

AuthorizationBearer

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

Query parameters

idslist of longsRequired

Response

JointApplicant
emailstring<=64 characters
firstNamestring<=64 characters
lastNamestring1-64 characters
streetAddress1string3-61 characters
citystring2-35 characters
countrystring=2 characters
phonestring<=21 characters
usaCitizenboolean
jointApplicantRelationshipenum or null
Other, Spouse
Allowed values:
idlong or null
streetAddress2string or null<=61 characters
statestring or null2-64 characters
postCodestring or null4-11 characters
mailingIsDifferentboolean or null
mailingStreetAddress1string or null<=8192 characters
mailingStreetAddress2string or null<=8192 characters
mailingCitystring or null<=64 characters
mailingStatestring or null<=64 characters
mailingPostCodestring or null<=64 characters
mailingCountrystring or null<=2 characters
secondaryPhonestring or null<=64 characters
taxIdentifierstring or null<=64 characters
foreignCountryOfResidencestring or null<=64 characters
birthDatestring or null<=64 characters
driverLicensestring or null<=64 characters
driverLicenseStatestring or null<=64 characters
passportstring or null<=64 characters
passportExpirystring or null<=64 characters
nationalIdstring or null<=64 characters
annualIncomeenum or null
AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25
Allowed values:
netWorthenum or null
NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50
liquidNetWorthenum or null
LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15
Allowed values:
annualIncomeNTenum or null
From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50
netWorthNTenum or null
From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50
liquidNetWorthNTenum or null
From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50
residenceenum or null
Other, Own, Rent
Allowed values:
depositAmountdouble or null>=0
riskCapitalSourceenum or null
BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings
marginTypeenum or null
Hedger, Speculator
Allowed values:
hedgeRepresentationenum or null
BankruptcyTrustee, CustomerInstruction
Allowed values:
retiredboolean or null
employmentStatusenum or null
Employed, Retired, Student, Unemployed
Allowed values:
occupationstring or null<=64 characters
employerstring or null<=64 characters
jobTitlestring or null<=64 characters
employerAddressstring or null<=8192 characters
employerCitystring or null<=64 characters
employerStatestring or null<=64 characters
employerPostCodestring or null<=64 characters
employerCountrystring or null<=2 characters
employerPhonestring or null<=64 characters
employerEmailstring or null<=64 characters
formerOccupationstring or null<=64 characters
formerEmployerstring or null<=64 characters
formerJobTitlestring or null<=64 characters
formerEmployerAddressstring or null<=64 characters
formerEmployerCitystring or null<=64 characters
formerEmployerStatestring or null<=64 characters
formerEmployerPostCodestring or null<=64 characters
formerEmployerCountrystring or null<=2 characters
formerEmployerPhonestring or null<=64 characters
formerEmployerEmailstring or null<=64 characters
interestInFuturesAccountboolean or null
brokerNamestring or null<=64 characters
brokerAccountSpecstring or null<=64 characters
outsideFundsboolean or null
outsideFundsExplanationstring or null<=8192 characters
relatedToBrokerboolean or null
relatedToBrokerExplanationstring or null<=8192 characters
othersSharePLboolean or null
othersSharePLExplanationstring or null<=8192 characters
othersAccountControlboolean or null
othersAccountControlDetailsstring or null<=8192 characters
complaintsboolean or null
complaintsExplanationstring or null<=8192 characters
pendingComplaintsboolean or null
pendingComplaintsExplanationstring or null<=8192 characters
cftcMemberboolean or null
cftcMemberDetailsstring or null<=8192 characters
nfaMemberboolean or null
nfaMemberExplanationstring or null<=8192 characters
brokerTransferFundsboolean or null
brokerTransferFundsExplanationstring or null<=8192 characters
riskOfLossCertboolean or null
leverageCertboolean or null
debitRiskCertboolean or null
addDepositCertboolean or null
claimOfTaxTreatyResidentboolean or null
claimOfTaxTreatyTINCertboolean or null
claimOfTaxTreatyTINstring or null<=64 characters
claimOfTaxTreatyNonIndividualboolean or null
iraCustodianstring or null<=64 characters
debtorInBankruptcyboolean or null
debtorInBankruptcyDetailsstring or null<=8192 characters
bankruptcyResolvedboolean or null
bankruptcyResolvedDatestring or null<=64 characters
otherFirmsboolean or null
otherFirmsExplanationstring or null<=8192 characters
cftcRegistrationboolean or null
cftcIdstring or null<=8192 characters
othersInterestboolean or null
otherEntityInterestFirstNamestring or null<=64 characters
otherEntityInterestLastNamestring or null<=64 characters
otherEntityInterestNamestring or null<=64 characters
otherEntityInterestRelationshipstring or null<=64 characters
otherEntityInterestCountrystring or null<=2 characters
otherEntityInterestAddressstring or null<=64 characters
otherEntityInterestCitystring or null<=64 characters
otherEntityInterestStatestring or null<=64 characters
otherEntityInterestPostCodestring or null<=64 characters
nfaOrCftcAffiliationboolean or null
nfaIdstring or null<=64 characters
nfaOrCftcAffiliationExplanationstring or null<=8192 characters
otherEntityControlboolean or null
otherEntityControlFirstNamestring or null<=64 characters
otherEntityControlLastNamestring or null<=64 characters
otherEntityControlMiddleNamestring or null<=64 characters
otherEntityControlRelationshipstring or null<=64 characters
otherEntityControlCitizenshipstring or null<=64 characters
otherEntityControlTaxIdentifierstring or null<=64 characters
otherEntityControlNationalIdstring or null<=64 characters
otherEntityControlCompensationboolean or null
otherEntityControlCompensationExplanationstring or null<=8192 characters
otherEntityControlManagersPhonestring or null<=64 characters
otherEntityControlManagersEmailstring or null<=64 characters
otherEntityControlAffiliationboolean or null
otherEntityControlAffiliatedWithstring or null<=64 characters
otherEntityControlDateOfBirthstring or null<=64 characters
otherEntityControlCountrystring or null<=2 characters
otherEntityControlAddressstring or null<=64 characters
otherEntityControlAddress2string or null<=64 characters
otherEntityControlCitystring or null<=64 characters
otherEntityControlStatestring or null<=64 characters
otherEntityControlPostCodestring or null<=64 characters
otherEntityControlPhonestring or null<=64 characters
otherEntityControlPassportstring or null<=64 characters
officialPositionboolean or null
tradingDecisionstring or null<=64 characters
otherInfostring or null<=8192 characters
middleNamestring or null<=64 characters
hdyhaustring or null<=64 characters
adviceCompboolean or null
poolSolicitationboolean or null
annualIncomeFreestring or null<=8192 characters
netWorthFreestring or null<=8192 characters
liquidNetWorthFreestring or null<=8192 characters