Agreement Document Template Find | 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"
}

Retrieve an agreement document template by name.

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

Environments: Demo, Live

Rate Limit: No endpoint-specific limit

Fetch a single agreement document template using its name field (up to 64 characters). Agreement document templates define the customer agreement documents that are generated during application onboarding.

Template names are unique per clearing house, so a name lookup can help you locate a known template without knowing its entity ID.

Related Endpoints

Use agreementDocumentTemplateFinds to fetch several templates by name in one call.
Use agreementDocumentTemplateSuggest when you only know part of the name.
Use agreementDocumentTemplateItem to fetch a template by ID instead.

Authentication

AuthorizationBearer

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

Query parameters

namestringRequired

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: