Skip to navigation

Agreement Document Template List

View as Markdown

List all agreement document templates.

Available to: All authenticated users. Templates marked adminUseOnly are visible only to internal NinjaTrader administrators.

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Retrieve every agreement document template visible to your user. Agreement document templates define the customer agreement documents that are generated when a customer application is prepared for signing — during onboarding, agreement documents are created from the templates that match the application.

A template’s boolean flags control which applications it applies to:

  • Account type flags (individual, joint, IRA, trust, corporation, partnership, LLC): the template applies to applications with a matching legal status.
  • Condition flags (highRisk, hedging, personalGuarantor, professional, usaCustomer, usaJointCustomer, otherEntityControl): the template applies only when the application matches these conditions.
  • Scope references (clearingHouseId, organizationId, countryId): when set, the template applies only to that clearing house, organization, or country. When empty, the template isn’t restricted by that scope.

Template names are unique per clearing house.

Related Endpoints

Authentication

AuthorizationBearer

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

Response

AgreementDocumentTemplate
namestring<=64 characters
timestampdatetime
adminUseOnlyboolean
individualboolean
jointboolean
IRAboolean
IRA
trustboolean
LLCboolean
LLC
ACHboolean
ACH
externalRefstring<=8192 characters
highRiskboolean
hedgingboolean
personalGuarantorboolean
corporationboolean
partnershipboolean
idlongOptional
professionalbooleanOptional
usaCustomerbooleanOptional
usaJointCustomerbooleanOptional
optionalSignaturebooleanOptional
otherEntityControlbooleanOptional
genericSignWhitelistbooleanOptional
priorityintegerOptional
clearingHouseIdlongOptional
countryIdlongOptional
organizationIdlongOptional
templatePreviewWhitelistbooleanOptional
spotMarginOnboardingenumOptional
Excluded, Required
Allowed values:
futuresOnboardingenumOptional
Excluded, Required
Allowed values:
swapOnboardingenumOptional
Excluded, Required
Allowed values: