For AI agents: a documentation index is available at the root level at /llms.txt and /llms-full.txt. Append /llms.txt to any URL for a page-level index, or .md for the markdown version of any page.
Support Center
OverviewAPIResources
OverviewAPIResources
  • REST API Endpoints
    • GETGet Timestamp
    • GETO IDC User Info
      • GETCorporate Applicant Dependents
      • GETCorporate Applicant Item
      • GETCorporate Applicant Items
      • GETCorporate Applicant L Dependents
      • GETCustomer Application Check State Dependents
      • GETCustomer Application Check State Item
      • GETCustomer Application Check State Items
      • GETCustomer Application Check State L Dependents
      • GETCustomer Application Signing State Dependents
      • GETCustomer Application Signing State Item
      • GETCustomer Application Signing State Items
      • GETCustomer Application Signing State L Dependents
      • POSTDownload Sub Account Request Preview
      • POSTDownload User Document Preview
      • POSTGet Agreement Document
      • POSTGet Current Annual Review Info
      • POSTGet Localized Agreement Document
      • POSTGet User Signed Document
      • GETIndividual Applicant Dependents
      • GETIndividual Applicant Item
      • GETIndividual Applicant Items
      • GETIndividual Applicant L Dependents
      • GETJoint Applicant Dependents
      • GETJoint Applicant Item
      • GETJoint Applicant Items
      • GETJoint Applicant L Dependents
      • GETSub Account Check State Dependents
      • GETSub Account Check State Item
      • GETSub Account Check State Items
      • GETSub Account Check State L Dependents
      • POSTSubmit Annual Review
      • POSTUpdate Contact Info
      • POSTUpdate Contact Info Name
Support Center
LogoLogo
REST API EndpointsPersonal Info

Joint Applicant Dependents

GET
https://demo-d.tradovateapi.com/v1/jointApplicant/deps
GET
/v1/jointApplicant/deps
1const url = 'https://demo-d.tradovateapi.com/v1/jointApplicant/deps?masterid=1';
2const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3
4try {
5  const response = await fetch(url, options);
6  const data = await response.json();
7  console.log(data);
8} catch (error) {
9  console.error(error);
10}
200Retrieved
1[
2  {
3    "email": "string",
4    "firstName": "string",
5    "lastName": "string",
6    "streetAddress1": "string",
7    "city": "string",
8    "country": "string",
9    "phone": "string",
10    "usaCitizen": true,
11    "jointApplicantRelationship": "Other",
12    "id": 1,
13    "streetAddress2": "string",
14    "state": "string",
15    "postCode": "string",
16    "mailingIsDifferent": true,
17    "mailingStreetAddress1": "string",
18    "mailingStreetAddress2": "string",
19    "mailingCity": "string",
20    "mailingState": "string",
21    "mailingPostCode": "string",
22    "mailingCountry": "string",
23    "secondaryPhone": "string",
24    "taxIdentifier": "string",
25    "foreignCountryOfResidence": "string",
26    "birthDate": "string",
27    "driverLicense": "string",
28    "driverLicenseState": "string",
29    "passport": "string",
30    "passportExpiry": "string",
31    "nationalId": "string",
32    "annualIncome": "AnnualIncomeFrom200",
33    "netWorth": "NetWorthFrom100",
34    "liquidNetWorth": "LiquidNetWorthFrom15",
35    "annualIncomeNT": "From100",
36    "netWorthNT": "From100",
37    "liquidNetWorthNT": "From100",
38    "residence": "Other",
39    "depositAmount": 1.1,
40    "riskCapitalSource": "BusinessEquity",
41    "marginType": "Hedger",
42    "hedgeRepresentation": "BankruptcyTrustee",
43    "retired": true,
44    "employmentStatus": "Employed",
45    "occupation": "string",
46    "employer": "string",
47    "jobTitle": "string",
48    "employerAddress": "string",
49    "employerCity": "string",
50    "employerState": "string",
51    "employerPostCode": "string",
52    "employerCountry": "string",
53    "employerPhone": "string",
54    "employerEmail": "string",
55    "formerOccupation": "string",
56    "formerEmployer": "string",
57    "formerJobTitle": "string",
58    "formerEmployerAddress": "string",
59    "formerEmployerCity": "string",
60    "formerEmployerState": "string",
61    "formerEmployerPostCode": "string",
62    "formerEmployerCountry": "string",
63    "formerEmployerPhone": "string",
64    "formerEmployerEmail": "string",
65    "interestInFuturesAccount": true,
66    "brokerName": "string",
67    "brokerAccountSpec": "string",
68    "outsideFunds": true,
69    "outsideFundsExplanation": "string",
70    "relatedToBroker": true,
71    "relatedToBrokerExplanation": "string",
72    "othersSharePL": true,
73    "othersSharePLExplanation": "string",
74    "othersAccountControl": true,
75    "othersAccountControlDetails": "string",
76    "complaints": true,
77    "complaintsExplanation": "string",
78    "pendingComplaints": true,
79    "pendingComplaintsExplanation": "string",
80    "cftcMember": true,
81    "cftcMemberDetails": "string",
82    "nfaMember": true,
83    "nfaMemberExplanation": "string",
84    "brokerTransferFunds": true,
85    "brokerTransferFundsExplanation": "string",
86    "riskOfLossCert": true,
87    "leverageCert": true,
88    "debitRiskCert": true,
89    "addDepositCert": true,
90    "claimOfTaxTreatyResident": true,
91    "claimOfTaxTreatyTINCert": true,
92    "claimOfTaxTreatyTIN": "string",
93    "claimOfTaxTreatyNonIndividual": true,
94    "iraCustodian": "string",
95    "debtorInBankruptcy": true,
96    "debtorInBankruptcyDetails": "string",
97    "bankruptcyResolved": true,
98    "bankruptcyResolvedDate": "string",
99    "otherFirms": true,
100    "otherFirmsExplanation": "string",
101    "cftcRegistration": true,
102    "cftcId": "string",
103    "othersInterest": true,
104    "otherEntityInterestFirstName": "string",
105    "otherEntityInterestLastName": "string",
106    "otherEntityInterestName": "string",
107    "otherEntityInterestRelationship": "string",
108    "otherEntityInterestCountry": "string",
109    "otherEntityInterestAddress": "string",
110    "otherEntityInterestCity": "string",
111    "otherEntityInterestState": "string",
112    "otherEntityInterestPostCode": "string",
113    "nfaOrCftcAffiliation": true,
114    "nfaId": "string",
115    "nfaOrCftcAffiliationExplanation": "string",
116    "otherEntityControl": true,
117    "otherEntityControlFirstName": "string",
118    "otherEntityControlLastName": "string",
119    "otherEntityControlMiddleName": "string",
120    "otherEntityControlRelationship": "string",
121    "otherEntityControlCitizenship": "string",
122    "otherEntityControlTaxIdentifier": "string",
123    "otherEntityControlNationalId": "string",
124    "otherEntityControlCompensation": true,
125    "otherEntityControlCompensationExplanation": "string",
126    "otherEntityControlManagersPhone": "string",
127    "otherEntityControlManagersEmail": "string",
128    "otherEntityControlAffiliation": true,
129    "otherEntityControlAffiliatedWith": "string",
130    "otherEntityControlDateOfBirth": "string",
131    "otherEntityControlCountry": "string",
132    "otherEntityControlAddress": "string",
133    "otherEntityControlAddress2": "string",
134    "otherEntityControlCity": "string",
135    "otherEntityControlState": "string",
136    "otherEntityControlPostCode": "string",
137    "otherEntityControlPhone": "string",
138    "otherEntityControlPassport": "string",
139    "officialPosition": true,
140    "tradingDecision": "string",
141    "otherInfo": "string",
142    "middleName": "string",
143    "hdyhau": "string",
144    "adviceComp": true,
145    "poolSolicitation": true,
146    "annualIncomeFree": "string",
147    "netWorthFree": "string",
148    "liquidNetWorthFree": "string"
149  }
150]
Fetches all JointApplicant entities associated to CustomerApplication entity
Was this page helpful?
Previous

Joint Applicant Item

Next
Built with

Authentication

AuthorizationBearer

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

Query parameters

masteridlongRequired
CustomerApplication entity ID

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