> For clean Markdown of any page, append .md to the page URL. > For a complete documentation index, see https://partner.ninjatrader.com/llms.txt. > For AI client integration (Claude Code, Cursor, etc.), connect to the MCP server at https://partner.ninjatrader.com/_mcp/server. # Submit Applicant POST https://live.tradovateapi.com/v1/customerApplication/submitapplicant Content-Type: application/json ### Submit applicant details for a customer application. **Available to:** All authenticated users **Environments:** Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Submit the applicant's personal, financial, and regulatory details for a customer application. Call this after starting the application with [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application), using the returned application `id` as `customerApplicationId`. Provide at least one applicant object matching the application's legal status: - `individual` — for `Individual` and `IRA` applications - `jointApplicant` — for the second applicant on `Joint` applications - `corporate` — for entity applications (`Corporation`, `LLC`, `LLP`, `LP`, `PTR`, `Trust`) The request is rejected if all three applicant objects are empty. Only the primary applicant's login can submit or change applicant details. Set `dryRun` to save the applicant details without finalizing the submission — useful for persisting progress while the applicant is still filling out the application. A successful response returns the created applicant record ID (`individualApplicantId` or `corporateApplicantId`). The response can also include `duplicateMetadata` — if `duplicateFound` is `true`, the details matched an existing application or account, and the metadata references the conflicting `customerApplicationId` or `accountId`. **Business Rules** The submission is rejected when: - The applicant selects the `Hedger` margin type — only `Speculator` accounts are supported. - The applicant reports a previous bankruptcy filing (`debtorInBankruptcy`). - The applicant is under 18 years old, or `birthDate` is missing for an individual applicant. - The applicant's `country` does not match the user's country of residence (applies to applications in certain jurisdictions). **Common Failure Scenarios** - `customerApplicationId` does not reference an existing application. - All of `individual`, `jointApplicant`, and `corporate` are empty. - The caller is not the primary applicant on the application. - The caller belongs to a reliance-agreement organization and cannot sign on behalf of customers. **Error Messages** | `errorText` | Trigger | |-------------|---------| | `"Thank you for your interest in opening an account. Unfortunately, we do not support Hedgers. Please choose Speculator to continue your application."` | The applicant's `marginType` is `Hedger`. | | `"Thank you for your interest in opening an account. Unfortunately, we have a policy to not open accounts for clients that have had a previous Bankruptcy filing. If you have further questions, please contact our compliance department."` | The applicant reports `debtorInBankruptcy`. | | `"Please specify birth date"` | `individual` is provided without a parseable `birthDate`. | | `"Thank you for your interest in opening an account, however, the minimum age to open an account is 18."` | The applicant's `birthDate` is less than 18 years ago. | | `"Country must match your country of residence. Start a new application and select your correct country of residence."` | The individual applicant's `country` conflicts with the user's country of residence. | | `"Applicant info cannot be changed after signing by primary applicant"` | The caller's session is not the primary applicant's session. | | `"This operation should be performed by your organization"` | The caller's organization has a reliance agreement, and the caller cannot sign on behalf of customers. | **Next Steps** - Upload any required supporting documents with [`submitCustomerApplicationDocument`](/api/rest-api-endpoints/users/submit-customer-application-document). - Generate the agreement documents for signing with [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents). Reference: https://partner.ninjatrader.com/connect/api/rest-api-endpoints/users/submit-applicant ## OpenAPI Specification ```yaml openapi: 3.1.0 info: title: connect version: 1.0.0 paths: /customerApplication/submitapplicant: post: operationId: submit-applicant summary: Submit Applicant description: >- ### Submit applicant details for a customer application. **Available to:** All authenticated users **Environments:** Live **[Rate Limit](/overview/core-concepts/rate-limits):** No endpoint-specific limit Submit the applicant's personal, financial, and regulatory details for a customer application. Call this after starting the application with [`startCustomerApplication`](/api/rest-api-endpoints/users/start-customer-application), using the returned application `id` as `customerApplicationId`. Provide at least one applicant object matching the application's legal status: - `individual` — for `Individual` and `IRA` applications - `jointApplicant` — for the second applicant on `Joint` applications - `corporate` — for entity applications (`Corporation`, `LLC`, `LLP`, `LP`, `PTR`, `Trust`) The request is rejected if all three applicant objects are empty. Only the primary applicant's login can submit or change applicant details. Set `dryRun` to save the applicant details without finalizing the submission — useful for persisting progress while the applicant is still filling out the application. A successful response returns the created applicant record ID (`individualApplicantId` or `corporateApplicantId`). The response can also include `duplicateMetadata` — if `duplicateFound` is `true`, the details matched an existing application or account, and the metadata references the conflicting `customerApplicationId` or `accountId`. **Business Rules** The submission is rejected when: - The applicant selects the `Hedger` margin type — only `Speculator` accounts are supported. - The applicant reports a previous bankruptcy filing (`debtorInBankruptcy`). - The applicant is under 18 years old, or `birthDate` is missing for an individual applicant. - The applicant's `country` does not match the user's country of residence (applies to applications in certain jurisdictions). **Common Failure Scenarios** - `customerApplicationId` does not reference an existing application. - All of `individual`, `jointApplicant`, and `corporate` are empty. - The caller is not the primary applicant on the application. - The caller belongs to a reliance-agreement organization and cannot sign on behalf of customers. **Error Messages** | `errorText` | Trigger | |-------------|---------| | `"Thank you for your interest in opening an account. Unfortunately, we do not support Hedgers. Please choose Speculator to continue your application."` | The applicant's `marginType` is `Hedger`. | | `"Thank you for your interest in opening an account. Unfortunately, we have a policy to not open accounts for clients that have had a previous Bankruptcy filing. If you have further questions, please contact our compliance department."` | The applicant reports `debtorInBankruptcy`. | | `"Please specify birth date"` | `individual` is provided without a parseable `birthDate`. | | `"Thank you for your interest in opening an account, however, the minimum age to open an account is 18."` | The applicant's `birthDate` is less than 18 years ago. | | `"Country must match your country of residence. Start a new application and select your correct country of residence."` | The individual applicant's `country` conflicts with the user's country of residence. | | `"Applicant info cannot be changed after signing by primary applicant"` | The caller's session is not the primary applicant's session. | | `"This operation should be performed by your organization"` | The caller's organization has a reliance agreement, and the caller cannot sign on behalf of customers. | **Next Steps** - Upload any required supporting documents with [`submitCustomerApplicationDocument`](/api/rest-api-endpoints/users/submit-customer-application-document). - Generate the agreement documents for signing with [`prepareAgreementDocuments`](/api/rest-api-endpoints/users/prepare-agreement-documents). tags: - Users parameters: - name: Authorization in: header description: Bearer authentication required: true schema: type: string responses: '200': description: ApplicantResponse content: application/json: schema: $ref: '#/components/schemas/ApplicantResponse' requestBody: content: application/json: schema: $ref: '#/components/schemas/SubmitApplicant' servers: - url: https://live.tradovateapi.com/v1 description: https://live.tradovateapi.com/v1 components: schemas: IndividualApplicantAnnualIncome: type: string enum: - AnnualIncomeFrom200 - AnnualIncomeFrom25 - AnnualIncomeFrom50 - AnnualIncomeLess25 description: >- AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25 title: IndividualApplicantAnnualIncome IndividualApplicantNetWorth: type: string enum: - NetWorthFrom100 - NetWorthFrom1mln - NetWorthFrom250 - NetWorthFrom50 - NetWorthFrom500 - NetWorthLess50 description: >- NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50 title: IndividualApplicantNetWorth IndividualApplicantLiquidNetWorth: type: string enum: - LiquidNetWorthFrom15 - LiquidNetWorthFrom1mln - LiquidNetWorthFrom50 - LiquidNetWorthFrom500 - LiquidNetWorthLess15 description: >- LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15 title: IndividualApplicantLiquidNetWorth IndividualApplicantAnnualIncomeNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: IndividualApplicantAnnualIncomeNt IndividualApplicantNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: IndividualApplicantNetWorthNt IndividualApplicantLiquidNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: IndividualApplicantLiquidNetWorthNt IndividualApplicantResidence: type: string enum: - Other - Own - Rent description: Other, Own, Rent title: IndividualApplicantResidence IndividualApplicantRiskCapitalSource: type: string enum: - BusinessEquity - EmploymentIncome - Inheritance - NetIncome - OwnershipBusiness - Savings description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings title: IndividualApplicantRiskCapitalSource IndividualApplicantMarginType: type: string enum: - Hedger - Speculator description: Hedger, Speculator title: IndividualApplicantMarginType IndividualApplicantHedgeRepresentation: type: string enum: - BankruptcyTrustee - CustomerInstruction description: BankruptcyTrustee, CustomerInstruction title: IndividualApplicantHedgeRepresentation IndividualApplicantEmploymentStatus: type: string enum: - Employed - Retired - Student - Unemployed description: Employed, Retired, Student, Unemployed title: IndividualApplicantEmploymentStatus IndividualApplicantJointAccountType: type: string enum: - JointTenants - TenantsInCommon description: JointTenants, TenantsInCommon title: IndividualApplicantJointAccountType IndividualApplicant: type: object properties: id: type: integer format: int64 firstName: type: string lastName: type: string streetAddress1: type: string streetAddress2: type: string city: type: string state: type: string postCode: type: string country: type: string phone: type: string mailingIsDifferent: type: boolean mailingStreetAddress1: type: string mailingStreetAddress2: type: string mailingCity: type: string mailingState: type: string mailingPostCode: type: string mailingCountry: type: string secondaryPhone: type: string taxIdentifier: type: string usaCitizen: type: boolean foreignCountryOfResidence: type: string birthDate: type: string driverLicense: type: string driverLicenseState: type: string passport: type: string passportExpiry: type: string nationalId: type: string annualIncome: $ref: '#/components/schemas/IndividualApplicantAnnualIncome' description: >- AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25 netWorth: $ref: '#/components/schemas/IndividualApplicantNetWorth' description: >- NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50 liquidNetWorth: $ref: '#/components/schemas/IndividualApplicantLiquidNetWorth' description: >- LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15 annualIncomeNT: $ref: '#/components/schemas/IndividualApplicantAnnualIncomeNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 netWorthNT: $ref: '#/components/schemas/IndividualApplicantNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 liquidNetWorthNT: $ref: '#/components/schemas/IndividualApplicantLiquidNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 residence: $ref: '#/components/schemas/IndividualApplicantResidence' description: Other, Own, Rent depositAmount: type: number format: double riskCapitalSource: $ref: '#/components/schemas/IndividualApplicantRiskCapitalSource' description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings marginType: $ref: '#/components/schemas/IndividualApplicantMarginType' description: Hedger, Speculator hedgeRepresentation: $ref: '#/components/schemas/IndividualApplicantHedgeRepresentation' description: BankruptcyTrustee, CustomerInstruction retired: type: boolean employmentStatus: $ref: '#/components/schemas/IndividualApplicantEmploymentStatus' description: Employed, Retired, Student, Unemployed occupation: type: string employer: type: string jobTitle: type: string employerAddress: type: string employerCity: type: string employerState: type: string employerPostCode: type: string employerCountry: type: string employerPhone: type: string employerEmail: type: string formerOccupation: type: string formerEmployer: type: string formerJobTitle: type: string formerEmployerAddress: type: string formerEmployerCity: type: string formerEmployerState: type: string formerEmployerPostCode: type: string formerEmployerCountry: type: string formerEmployerPhone: type: string formerEmployerEmail: type: string professional: type: boolean interestInFuturesAccount: type: boolean brokerName: type: string brokerAccountSpec: type: string outsideFunds: type: boolean outsideFundsExplanation: type: string relatedToBroker: type: boolean relatedToBrokerExplanation: type: string othersSharePL: type: boolean othersSharePLExplanation: type: string othersAccountControl: type: boolean othersAccountControlDetails: type: string complaints: type: boolean complaintsExplanation: type: string pendingComplaints: type: boolean pendingComplaintsExplanation: type: string cftcMember: type: boolean cftcMemberDetails: type: string nfaMember: type: boolean nfaMemberExplanation: type: string brokerTransferFunds: type: boolean brokerTransferFundsExplanation: type: string riskOfLossCert: type: boolean leverageCert: type: boolean debitRiskCert: type: boolean addDepositCert: type: boolean claimOfTaxTreatyResident: type: boolean claimOfTaxTreatyTINCert: type: boolean claimOfTaxTreatyTIN: type: string claimOfTaxTreatyNonIndividual: type: boolean iraCustodian: type: string jointAccountType: $ref: '#/components/schemas/IndividualApplicantJointAccountType' description: JointTenants, TenantsInCommon jointInterestPercentage: type: integer debtorInBankruptcy: type: boolean debtorInBankruptcyDetails: type: string bankruptcyResolved: type: boolean bankruptcyResolvedDate: type: string otherFirms: type: boolean otherFirmsExplanation: type: string cftcRegistration: type: boolean cftcId: type: string othersInterest: type: boolean otherEntityInterestFirstName: type: string otherEntityInterestLastName: type: string otherEntityInterestName: type: string otherEntityInterestRelationship: type: string otherEntityInterestCountry: type: string otherEntityInterestAddress: type: string otherEntityInterestCity: type: string otherEntityInterestState: type: string otherEntityInterestPostCode: type: string nfaOrCftcAffiliation: type: boolean nfaId: type: string nfaOrCftcAffiliationExplanation: type: string otherEntityControl: type: boolean otherEntityControlFirstName: type: string otherEntityControlLastName: type: string otherEntityControlMiddleName: type: string otherEntityControlRelationship: type: string otherEntityControlCitizenship: type: string otherEntityControlTaxIdentifier: type: string otherEntityControlNationalId: type: string otherEntityControlCompensation: type: boolean otherEntityControlCompensationExplanation: type: string otherEntityControlManagersPhone: type: string otherEntityControlManagersEmail: type: string otherEntityControlAffiliation: type: boolean otherEntityControlAffiliatedWith: type: string otherEntityControlDateOfBirth: type: string otherEntityControlCountry: type: string otherEntityControlAddress: type: string otherEntityControlAddress2: type: string otherEntityControlCity: type: string otherEntityControlState: type: string otherEntityControlPostCode: type: string otherEntityControlPhone: type: string otherEntityControlPassport: type: string officialPosition: type: boolean tradingDecision: type: string otherInfo: type: string middleName: type: string hdyhau: type: string adviceComp: type: boolean poolSolicitation: type: boolean annualIncomeFree: type: string netWorthFree: type: string liquidNetWorthFree: type: string required: - firstName - lastName - streetAddress1 - city - country - phone - usaCitizen title: IndividualApplicant JointApplicantJointApplicantRelationship: type: string enum: - Other - Spouse description: Other, Spouse title: JointApplicantJointApplicantRelationship JointApplicantAnnualIncome: type: string enum: - AnnualIncomeFrom200 - AnnualIncomeFrom25 - AnnualIncomeFrom50 - AnnualIncomeLess25 description: >- AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25 title: JointApplicantAnnualIncome JointApplicantNetWorth: type: string enum: - NetWorthFrom100 - NetWorthFrom1mln - NetWorthFrom250 - NetWorthFrom50 - NetWorthFrom500 - NetWorthLess50 description: >- NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50 title: JointApplicantNetWorth JointApplicantLiquidNetWorth: type: string enum: - LiquidNetWorthFrom15 - LiquidNetWorthFrom1mln - LiquidNetWorthFrom50 - LiquidNetWorthFrom500 - LiquidNetWorthLess15 description: >- LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15 title: JointApplicantLiquidNetWorth JointApplicantAnnualIncomeNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: JointApplicantAnnualIncomeNt JointApplicantNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: JointApplicantNetWorthNt JointApplicantLiquidNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: JointApplicantLiquidNetWorthNt JointApplicantResidence: type: string enum: - Other - Own - Rent description: Other, Own, Rent title: JointApplicantResidence JointApplicantRiskCapitalSource: type: string enum: - BusinessEquity - EmploymentIncome - Inheritance - NetIncome - OwnershipBusiness - Savings description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings title: JointApplicantRiskCapitalSource JointApplicantMarginType: type: string enum: - Hedger - Speculator description: Hedger, Speculator title: JointApplicantMarginType JointApplicantHedgeRepresentation: type: string enum: - BankruptcyTrustee - CustomerInstruction description: BankruptcyTrustee, CustomerInstruction title: JointApplicantHedgeRepresentation JointApplicantEmploymentStatus: type: string enum: - Employed - Retired - Student - Unemployed description: Employed, Retired, Student, Unemployed title: JointApplicantEmploymentStatus JointApplicant: type: object properties: email: type: string jointApplicantRelationship: $ref: '#/components/schemas/JointApplicantJointApplicantRelationship' description: Other, Spouse id: type: integer format: int64 firstName: type: string lastName: type: string streetAddress1: type: string streetAddress2: type: string city: type: string state: type: string postCode: type: string country: type: string phone: type: string mailingIsDifferent: type: boolean mailingStreetAddress1: type: string mailingStreetAddress2: type: string mailingCity: type: string mailingState: type: string mailingPostCode: type: string mailingCountry: type: string secondaryPhone: type: string taxIdentifier: type: string usaCitizen: type: boolean foreignCountryOfResidence: type: string birthDate: type: string driverLicense: type: string driverLicenseState: type: string passport: type: string passportExpiry: type: string nationalId: type: string annualIncome: $ref: '#/components/schemas/JointApplicantAnnualIncome' description: >- AnnualIncomeFrom200, AnnualIncomeFrom25, AnnualIncomeFrom50, AnnualIncomeLess25 netWorth: $ref: '#/components/schemas/JointApplicantNetWorth' description: >- NetWorthFrom100, NetWorthFrom1mln, NetWorthFrom250, NetWorthFrom50, NetWorthFrom500, NetWorthLess50 liquidNetWorth: $ref: '#/components/schemas/JointApplicantLiquidNetWorth' description: >- LiquidNetWorthFrom15, LiquidNetWorthFrom1mln, LiquidNetWorthFrom50, LiquidNetWorthFrom500, LiquidNetWorthLess15 annualIncomeNT: $ref: '#/components/schemas/JointApplicantAnnualIncomeNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 netWorthNT: $ref: '#/components/schemas/JointApplicantNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 liquidNetWorthNT: $ref: '#/components/schemas/JointApplicantLiquidNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 residence: $ref: '#/components/schemas/JointApplicantResidence' description: Other, Own, Rent depositAmount: type: number format: double riskCapitalSource: $ref: '#/components/schemas/JointApplicantRiskCapitalSource' description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings marginType: $ref: '#/components/schemas/JointApplicantMarginType' description: Hedger, Speculator hedgeRepresentation: $ref: '#/components/schemas/JointApplicantHedgeRepresentation' description: BankruptcyTrustee, CustomerInstruction retired: type: boolean employmentStatus: $ref: '#/components/schemas/JointApplicantEmploymentStatus' description: Employed, Retired, Student, Unemployed occupation: type: string employer: type: string jobTitle: type: string employerAddress: type: string employerCity: type: string employerState: type: string employerPostCode: type: string employerCountry: type: string employerPhone: type: string employerEmail: type: string formerOccupation: type: string formerEmployer: type: string formerJobTitle: type: string formerEmployerAddress: type: string formerEmployerCity: type: string formerEmployerState: type: string formerEmployerPostCode: type: string formerEmployerCountry: type: string formerEmployerPhone: type: string formerEmployerEmail: type: string interestInFuturesAccount: type: boolean brokerName: type: string brokerAccountSpec: type: string outsideFunds: type: boolean outsideFundsExplanation: type: string relatedToBroker: type: boolean relatedToBrokerExplanation: type: string othersSharePL: type: boolean othersSharePLExplanation: type: string othersAccountControl: type: boolean othersAccountControlDetails: type: string complaints: type: boolean complaintsExplanation: type: string pendingComplaints: type: boolean pendingComplaintsExplanation: type: string cftcMember: type: boolean cftcMemberDetails: type: string nfaMember: type: boolean nfaMemberExplanation: type: string brokerTransferFunds: type: boolean brokerTransferFundsExplanation: type: string riskOfLossCert: type: boolean leverageCert: type: boolean debitRiskCert: type: boolean addDepositCert: type: boolean claimOfTaxTreatyResident: type: boolean claimOfTaxTreatyTINCert: type: boolean claimOfTaxTreatyTIN: type: string claimOfTaxTreatyNonIndividual: type: boolean iraCustodian: type: string debtorInBankruptcy: type: boolean debtorInBankruptcyDetails: type: string bankruptcyResolved: type: boolean bankruptcyResolvedDate: type: string otherFirms: type: boolean otherFirmsExplanation: type: string cftcRegistration: type: boolean cftcId: type: string othersInterest: type: boolean otherEntityInterestFirstName: type: string otherEntityInterestLastName: type: string otherEntityInterestName: type: string otherEntityInterestRelationship: type: string otherEntityInterestCountry: type: string otherEntityInterestAddress: type: string otherEntityInterestCity: type: string otherEntityInterestState: type: string otherEntityInterestPostCode: type: string nfaOrCftcAffiliation: type: boolean nfaId: type: string nfaOrCftcAffiliationExplanation: type: string otherEntityControl: type: boolean otherEntityControlFirstName: type: string otherEntityControlLastName: type: string otherEntityControlMiddleName: type: string otherEntityControlRelationship: type: string otherEntityControlCitizenship: type: string otherEntityControlTaxIdentifier: type: string otherEntityControlNationalId: type: string otherEntityControlCompensation: type: boolean otherEntityControlCompensationExplanation: type: string otherEntityControlManagersPhone: type: string otherEntityControlManagersEmail: type: string otherEntityControlAffiliation: type: boolean otherEntityControlAffiliatedWith: type: string otherEntityControlDateOfBirth: type: string otherEntityControlCountry: type: string otherEntityControlAddress: type: string otherEntityControlAddress2: type: string otherEntityControlCity: type: string otherEntityControlState: type: string otherEntityControlPostCode: type: string otherEntityControlPhone: type: string otherEntityControlPassport: type: string officialPosition: type: boolean tradingDecision: type: string otherInfo: type: string middleName: type: string hdyhau: type: string adviceComp: type: boolean poolSolicitation: type: boolean annualIncomeFree: type: string netWorthFree: type: string liquidNetWorthFree: type: string required: - email - firstName - lastName - streetAddress1 - city - country - phone - usaCitizen title: JointApplicant CorporateApplicantCorporationType: type: string enum: - C - None - P - S description: C, None, P, S title: CorporateApplicantCorporationType CorporateApplicantAnnualIncome: type: string enum: - CorporateAnnualIncomeFrom100 - CorporateAnnualIncomeFrom25 - CorporateAnnualIncomeFrom500 - CorporateAnnualIncomeLess25 description: >- CorporateAnnualIncomeFrom100, CorporateAnnualIncomeFrom25, CorporateAnnualIncomeFrom500, CorporateAnnualIncomeLess25 title: CorporateApplicantAnnualIncome CorporateApplicantNetWorth: type: string enum: - CorporateNetWorthFrom1mln - CorporateNetWorthFrom250 - CorporateNetWorthFrom50 - CorporateNetWorthLess50 description: >- CorporateNetWorthFrom1mln, CorporateNetWorthFrom250, CorporateNetWorthFrom50, CorporateNetWorthLess50 title: CorporateApplicantNetWorth CorporateApplicantMarginType: type: string enum: - Hedger - Speculator description: Hedger, Speculator title: CorporateApplicantMarginType CorporateApplicantHedgeRepresentation: type: string enum: - BankruptcyTrustee - CustomerInstruction description: BankruptcyTrustee, CustomerInstruction title: CorporateApplicantHedgeRepresentation CorporateApplicantAnnualIncomeNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: CorporateApplicantAnnualIncomeNt CorporateApplicantNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: CorporateApplicantNetWorthNt CorporateApplicantLiquidNetWorthNt: type: string enum: - From100 - From1000 - From120 - From1200 - From1400 - From150 - From1600 - From1800 - From200 - From2000 - From250 - From2500 - From300 - From3000 - From400 - From50 - From500 - From70 - From90 - Less25 - Less50 description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 title: CorporateApplicantLiquidNetWorthNt CorporateApplicantRiskCapitalSource: type: string enum: - BusinessEquity - EmploymentIncome - Inheritance - NetIncome - OwnershipBusiness - Savings description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings title: CorporateApplicantRiskCapitalSource CorporateApplicantPoolStatus: type: string enum: - Exempt - Registered description: Exempt, Registered title: CorporateApplicantPoolStatus CorporateApplicant: type: object properties: id: type: integer format: int64 name: type: string entityType: type: string firstName: type: string lastName: type: string streetAddress1: type: string streetAddress2: type: string city: type: string state: type: string postCode: type: string country: type: string phone: type: string mailingIsDifferent: type: boolean mailingStreetAddress1: type: string mailingStreetAddress2: type: string mailingCity: type: string mailingState: type: string mailingPostCode: type: string mailingCountry: type: string taxIdentifier: type: string openerPassportExpiry: type: string openerNationalId: type: string incorporationState: type: string incorporationCountry: type: string incorporationDate: type: string dba: type: string companyWebsite: type: string natureOfBusiness: type: string foreignInvestmentVehicle: type: boolean corporationType: $ref: '#/components/schemas/CorporateApplicantCorporationType' description: C, None, P, S managers: type: string stakeholders: type: string otherInfo: type: string annualIncome: $ref: '#/components/schemas/CorporateApplicantAnnualIncome' description: >- CorporateAnnualIncomeFrom100, CorporateAnnualIncomeFrom25, CorporateAnnualIncomeFrom500, CorporateAnnualIncomeLess25 netWorth: $ref: '#/components/schemas/CorporateApplicantNetWorth' description: >- CorporateNetWorthFrom1mln, CorporateNetWorthFrom250, CorporateNetWorthFrom50, CorporateNetWorthLess50 marginType: $ref: '#/components/schemas/CorporateApplicantMarginType' description: Hedger, Speculator hedgeRepresentation: $ref: '#/components/schemas/CorporateApplicantHedgeRepresentation' description: BankruptcyTrustee, CustomerInstruction professional: type: boolean riskOfLossCert: type: boolean leverageCert: type: boolean debitRiskCert: type: boolean addDepositCert: type: boolean othersInterest: type: boolean otherEntityControl: type: boolean debtorInBankruptcy: type: boolean annualIncomeNT: $ref: '#/components/schemas/CorporateApplicantAnnualIncomeNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 netWorthNT: $ref: '#/components/schemas/CorporateApplicantNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 liquidNetWorthNT: $ref: '#/components/schemas/CorporateApplicantLiquidNetWorthNt' description: >- From100, From1000, From120, From1200, From1400, From150, From1600, From1800, From200, From2000, From250, From2500, From300, From3000, From400, From50, From500, From70, From90, Less25, Less50 riskCapitalSource: $ref: '#/components/schemas/CorporateApplicantRiskCapitalSource' description: >- BusinessEquity, EmploymentIncome, Inheritance, NetIncome, OwnershipBusiness, Savings otherFirms: type: boolean otherFirmsExplanation: type: string annualIncomeFree: type: string netWorthFree: type: string liquidNetWorthFree: type: string cftcRegistration: type: boolean chapter11: type: boolean personalGuarantorPrimary: type: boolean personalGuarantorEmail: type: string personalGuarantorName: type: string registeredAgent: type: string agentAddress: type: string agentCity: type: string agentState: type: string agentZip: type: string agentCountry: type: string numberOfMembers: type: integer authorizedTraderFirstName: type: string authorizedTraderLastName: type: string authorizedTraderSSN: type: string authorizedTraderAddress: type: string authorizedTraderCity: type: string authorizedTraderState: type: string authorizedTraderZip: type: string authorizedTraderCountry: type: string authorizedMember: type: boolean depositAmount: type: number format: double bankName: type: string bankAccount: type: string bankAddress: type: string bankCity: type: string bankCountry: type: string bankState: type: string bankZip: type: string commodityPool: type: boolean poolStatus: $ref: '#/components/schemas/CorporateApplicantPoolStatus' description: Exempt, Registered offeringCircular: type: boolean financialInterest: type: boolean financialInterestExplanation: type: string companyDeposits: type: boolean exchangeMember: type: boolean nfaMember: type: boolean cftcMember: type: boolean cftcMemberDetails: type: string relatedToBroker: type: boolean relatedToBrokerExplanation: type: string othersSharePL: type: boolean othersSharePLExplanation: type: string pendingComplaints: type: boolean pendingComplaintsExplanation: type: string brokerTransferFunds: type: boolean brokerTransferFundsExplanation: type: string usaCorporation: type: boolean claimOfTaxTreatyResident: type: boolean claimOfTaxTreatyTINCert: type: boolean claimOfTaxTreatyTIN: type: string claimOfTaxTreatyNonIndividual: type: boolean openerFirstName: type: string openerLastName: type: string openerMiddleInitial: type: string openerMiddleName: type: string openerAddress: type: string openerAddress2: type: string openerCity: type: string openerState: type: string openerZip: type: string openerCountry: type: string openerPhone: type: string openerSecondaryPhone: type: string openerEmail: type: string openerUsaCitizen: type: boolean openerJobTitle: type: string openerBirthDate: type: string openerTaxIdentifier: type: string openerDriverLicense: type: string openerDriverLicenseState: type: string openerForeignCountryOfResidence: type: string openerPassport: type: string hdyhau: type: string required: - name - firstName - lastName - streetAddress1 - city - country - phone - incorporationCountry - natureOfBusiness title: CorporateApplicant SubmitApplicant: type: object properties: customerApplicationId: type: integer format: int64 individual: $ref: '#/components/schemas/IndividualApplicant' jointApplicant: $ref: '#/components/schemas/JointApplicant' corporate: $ref: '#/components/schemas/CorporateApplicant' dryRun: type: boolean ecbsvAuthorized: type: boolean required: - customerApplicationId title: SubmitApplicant DuplicateMetadata: type: object properties: duplicateFound: type: boolean customerApplicationId: type: integer format: int64 accountId: type: integer format: int64 required: - duplicateFound title: DuplicateMetadata ApplicantResponse: type: object properties: errorText: type: string description: Non-empty if the request failed individualApplicantId: type: integer format: int64 corporateApplicantId: type: integer format: int64 duplicateMetadata: $ref: '#/components/schemas/DuplicateMetadata' ecbsvAuthorized: type: boolean title: ApplicantResponse securitySchemes: bearer_access_token: type: http scheme: bearer ``` ## Examples **Request** ```json { "customerApplicationId": 1 } ``` **Response** ```json { "errorText": "string", "individualApplicantId": 1, "corporateApplicantId": 1, "duplicateMetadata": { "duplicateFound": true, "customerApplicationId": 1, "accountId": 1 }, "ecbsvAuthorized": true } ``` **SDK Code** ```python import requests url = "https://live.tradovateapi.com/v1/customerApplication/submitapplicant" payload = { "customerApplicationId": 1 } headers = { "Authorization": "Bearer ", "Content-Type": "application/json" } response = requests.post(url, json=payload, headers=headers) print(response.json()) ``` ```javascript const url = 'https://live.tradovateapi.com/v1/customerApplication/submitapplicant'; const options = { method: 'POST', headers: {Authorization: 'Bearer ', 'Content-Type': 'application/json'}, body: '{"customerApplicationId":1}' }; try { const response = await fetch(url, options); const data = await response.json(); console.log(data); } catch (error) { console.error(error); } ``` ```go package main import ( "fmt" "strings" "net/http" "io" ) func main() { url := "https://live.tradovateapi.com/v1/customerApplication/submitapplicant" payload := strings.NewReader("{\n \"customerApplicationId\": 1\n}") req, _ := http.NewRequest("POST", url, payload) req.Header.Add("Authorization", "Bearer ") req.Header.Add("Content-Type", "application/json") res, _ := http.DefaultClient.Do(req) defer res.Body.Close() body, _ := io.ReadAll(res.Body) fmt.Println(res) fmt.Println(string(body)) } ``` ```ruby require 'uri' require 'net/http' url = URI("https://live.tradovateapi.com/v1/customerApplication/submitapplicant") http = Net::HTTP.new(url.host, url.port) http.use_ssl = true request = Net::HTTP::Post.new(url) request["Authorization"] = 'Bearer ' request["Content-Type"] = 'application/json' request.body = "{\n \"customerApplicationId\": 1\n}" response = http.request(request) puts response.read_body ``` ```java import com.mashape.unirest.http.HttpResponse; import com.mashape.unirest.http.Unirest; HttpResponse response = Unirest.post("https://live.tradovateapi.com/v1/customerApplication/submitapplicant") .header("Authorization", "Bearer ") .header("Content-Type", "application/json") .body("{\n \"customerApplicationId\": 1\n}") .asString(); ``` ```php request('POST', 'https://live.tradovateapi.com/v1/customerApplication/submitapplicant', [ 'body' => '{ "customerApplicationId": 1 }', 'headers' => [ 'Authorization' => 'Bearer ', 'Content-Type' => 'application/json', ], ]); echo $response->getBody(); ``` ```csharp using RestSharp; var client = new RestClient("https://live.tradovateapi.com/v1/customerApplication/submitapplicant"); var request = new RestRequest(Method.POST); request.AddHeader("Authorization", "Bearer "); request.AddHeader("Content-Type", "application/json"); request.AddParameter("application/json", "{\n \"customerApplicationId\": 1\n}", ParameterType.RequestBody); IRestResponse response = client.Execute(request); ``` ```swift import Foundation let headers = [ "Authorization": "Bearer ", "Content-Type": "application/json" ] let parameters = ["customerApplicationId": 1] as [String : Any] let postData = JSONSerialization.data(withJSONObject: parameters, options: []) let request = NSMutableURLRequest(url: NSURL(string: "https://live.tradovateapi.com/v1/customerApplication/submitapplicant")! as URL, cachePolicy: .useProtocolCachePolicy, timeoutInterval: 10.0) request.httpMethod = "POST" request.allHTTPHeaderFields = headers request.httpBody = postData as Data let session = URLSession.shared let dataTask = session.dataTask(with: request as URLRequest, completionHandler: { (data, response, error) -> Void in if (error != nil) { print(error as Any) } else { let httpResponse = response as? HTTPURLResponse print(httpResponse) } }) dataTask.resume() ```