Joint Applicant Dependents

GET

https://demo-d.tradovateapi.com/v1/jointApplicant/deps

GET

/v1/jointApplicant/deps

1 const url = 'https://demo-d.tradovateapi.com/v1/jointApplicant/deps?masterid=1';
2 const options = {method: 'GET', headers: {Authorization: 'Bearer <token>'}};
3 
4 try {
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

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

jointApplicantRelationshipenumOptional

Other, Spouse

idlongOptional

streetAddress2stringOptional<=61 characters

statestringOptional2-64 characters

postCodestringOptional4-11 characters

mailingIsDifferentbooleanOptional

mailingStreetAddress1stringOptional<=8192 characters

mailingStreetAddress2stringOptional<=8192 characters

mailingCitystringOptional<=64 characters

mailingStatestringOptional<=64 characters

mailingPostCodestringOptional<=64 characters

mailingCountrystringOptional<=2 characters

secondaryPhonestringOptional<=64 characters

taxIdentifierstringOptional<=64 characters

foreignCountryOfResidencestringOptional<=64 characters

birthDatestringOptional<=64 characters

driverLicensestringOptional<=64 characters

driverLicenseStatestringOptional<=64 characters

passportstringOptional<=64 characters

passportExpirystringOptional<=64 characters

nationalIdstringOptional<=64 characters

annualIncomeenumOptional

AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25

netWorthenumOptional

NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50

liquidNetWorthenumOptional

LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15

annualIncomeNTenumOptional

From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50

netWorthNTenumOptional

From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50

liquidNetWorthNTenumOptional

From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50

residenceenumOptional

Other, Own, Rent

depositAmountdoubleOptional>=0

riskCapitalSourceenumOptional

BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings

marginTypeenumOptional

Hedger, Speculator

hedgeRepresentationenumOptional

BankruptcyTrustee, CustomerInstruction

retiredbooleanOptional

employmentStatusenumOptional

Employed, Retired, Student, Unemployed

occupationstringOptional<=64 characters

employerstringOptional<=64 characters

jobTitlestringOptional<=64 characters

employerAddressstringOptional<=8192 characters

employerCitystringOptional<=64 characters

employerStatestringOptional<=64 characters

employerPostCodestringOptional<=64 characters

employerCountrystringOptional<=2 characters

employerPhonestringOptional<=64 characters

employerEmailstringOptional<=64 characters

formerOccupationstringOptional<=64 characters

formerEmployerstringOptional<=64 characters

formerJobTitlestringOptional<=64 characters

formerEmployerAddressstringOptional<=64 characters

formerEmployerCitystringOptional<=64 characters

formerEmployerStatestringOptional<=64 characters

formerEmployerPostCodestringOptional<=64 characters

formerEmployerCountrystringOptional<=2 characters

formerEmployerPhonestringOptional<=64 characters

formerEmployerEmailstringOptional<=64 characters

interestInFuturesAccountbooleanOptional

brokerNamestringOptional<=64 characters

brokerAccountSpecstringOptional<=64 characters

outsideFundsbooleanOptional

outsideFundsExplanationstringOptional<=8192 characters

relatedToBrokerbooleanOptional

relatedToBrokerExplanationstringOptional<=8192 characters

othersSharePLbooleanOptional

othersSharePLExplanationstringOptional<=8192 characters

othersAccountControlbooleanOptional

othersAccountControlDetailsstringOptional<=8192 characters

complaintsbooleanOptional

complaintsExplanationstringOptional<=8192 characters

pendingComplaintsbooleanOptional

pendingComplaintsExplanationstringOptional<=8192 characters

cftcMemberbooleanOptional

cftcMemberDetailsstringOptional<=8192 characters

nfaMemberbooleanOptional

nfaMemberExplanationstringOptional<=8192 characters

brokerTransferFundsbooleanOptional

brokerTransferFundsExplanationstringOptional<=8192 characters

riskOfLossCertbooleanOptional

leverageCertbooleanOptional

debitRiskCertbooleanOptional

addDepositCertbooleanOptional

claimOfTaxTreatyResidentbooleanOptional

claimOfTaxTreatyTINCertbooleanOptional

claimOfTaxTreatyTINstringOptional<=64 characters

claimOfTaxTreatyNonIndividualbooleanOptional

iraCustodianstringOptional<=64 characters

debtorInBankruptcybooleanOptional

debtorInBankruptcyDetailsstringOptional<=8192 characters

bankruptcyResolvedbooleanOptional

bankruptcyResolvedDatestringOptional<=64 characters

otherFirmsbooleanOptional

otherFirmsExplanationstringOptional<=8192 characters

cftcRegistrationbooleanOptional

cftcIdstringOptional<=8192 characters

othersInterestbooleanOptional

otherEntityInterestFirstNamestringOptional<=64 characters

otherEntityInterestLastNamestringOptional<=64 characters

otherEntityInterestNamestringOptional<=64 characters

otherEntityInterestRelationshipstringOptional<=64 characters

otherEntityInterestCountrystringOptional<=2 characters

otherEntityInterestAddressstringOptional<=64 characters

otherEntityInterestCitystringOptional<=64 characters

otherEntityInterestStatestringOptional<=64 characters

otherEntityInterestPostCodestringOptional<=64 characters

nfaOrCftcAffiliationbooleanOptional

nfaIdstringOptional<=64 characters

nfaOrCftcAffiliationExplanationstringOptional<=8192 characters

otherEntityControlbooleanOptional

otherEntityControlFirstNamestringOptional<=64 characters

otherEntityControlLastNamestringOptional<=64 characters

otherEntityControlMiddleNamestringOptional<=64 characters

otherEntityControlRelationshipstringOptional<=64 characters

otherEntityControlCitizenshipstringOptional<=64 characters

otherEntityControlTaxIdentifierstringOptional<=64 characters

otherEntityControlNationalIdstringOptional<=64 characters

otherEntityControlCompensationbooleanOptional

otherEntityControlCompensationExplanationstringOptional<=8192 characters

otherEntityControlManagersPhonestringOptional<=64 characters

otherEntityControlManagersEmailstringOptional<=64 characters

otherEntityControlAffiliationbooleanOptional

otherEntityControlAffiliatedWithstringOptional<=64 characters

otherEntityControlDateOfBirthstringOptional<=64 characters

otherEntityControlCountrystringOptional<=2 characters

otherEntityControlAddressstringOptional<=64 characters

otherEntityControlAddress2stringOptional<=64 characters

otherEntityControlCitystringOptional<=64 characters

otherEntityControlStatestringOptional<=64 characters

otherEntityControlPostCodestringOptional<=64 characters

otherEntityControlPhonestringOptional<=64 characters

otherEntityControlPassportstringOptional<=64 characters

officialPositionbooleanOptional

tradingDecisionstringOptional<=64 characters

otherInfostringOptional<=8192 characters

middleNamestringOptional<=64 characters

hdyhaustringOptional<=64 characters

adviceCompbooleanOptional

poolSolicitationbooleanOptional

annualIncomeFreestringOptional<=8192 characters

netWorthFreestringOptional<=8192 characters

liquidNetWorthFreestringOptional<=8192 characters