Agreement Document Template Suggest | NinjaTrader Partner API

[
  {
    "name": "string",
    "timestamp": "2024-01-15T09:30:00Z",
    "adminUseOnly": true,
    "individual": true,
    "joint": true,
    "IRA": true,
    "trust": true,
    "LLC": true,
    "ACH": true,
    "externalRef": "string",
    "highRisk": true,
    "hedging": true,
    "personalGuarantor": true,
    "corporation": true,
    "partnership": true,
    "id": 1,
    "professional": true,
    "usaCustomer": true,
    "usaJointCustomer": true,
    "optionalSignature": true,
    "otherEntityControl": true,
    "genericSignWhitelist": true,
    "priority": 1,
    "clearingHouseId": 1,
    "countryId": 1,
    "organizationId": 1,
    "templatePreviewWhitelist": true,
    "spotMarginOnboarding": "Excluded",
    "futuresOnboarding": "Excluded",
    "swapOnboarding": "Excluded"
  }
]

Search agreement document templates by text.

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 agreement document templates whose fields contain the text you pass in the t parameter, up to the maximum number of results you set with the l parameter. Agreement document templates define the customer agreement documents that are generated during application onboarding.

Use this endpoint when you don’t know a template’s exact name — for exact-name lookups, agreementDocumentTemplateFind is more precise.

Related Endpoints

Use agreementDocumentTemplateList to retrieve all visible templates without filtering.
Use agreementDocumentTemplateItems to fetch specific templates by ID.

Authentication

AuthorizationBearer

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

Query parameters

tstringRequired

Text

lintegerRequired

Max number of entities

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: