Skip to navigation
REST API EndpointsRisks

Organization Admin Unlock Account

View as Markdown

Unlock a locked Live subaccount.

Available to: Organization administrators

Environments: Live

Rate Limit: No endpoint-specific limit

A partner unlock lets a trader attempt to resume by clearing an eligible lock on a subaccount in your own organization: a system risk lock (RestrictedRiskRestriction, from auto-liquidation or a drawdown or evaluation breach) or a partner lock (PartnerPayoutLock) your organization set. Use it for the cases the automatic requalification reset on trading-permission approval doesn’t cover.

You can pass an optional reason (up to 8,192 characters), stored with the unlock and prefixed with Partner unlock:.

A rejected request returns HTTP 200 with errorText set and no accountRiskStatus, not an error status. Check errorText to determine whether the unlock succeeded.

This endpoint doesn’t unlock the following locks: compliance, anti-money-laundering, treasury, W-8, account-closure, or a lock recorded only with the generic Other code.

NinjaTrader enables this feature per organization, so work with the NinjaTrader Support team to turn it on.

For the subaccount lifecycle, which locks you can manage, the effect on trading, and how this differs from Change Lock, see Partner Account Lock and Unlock.

Common Failure Scenarios

  • The account isn’t a subaccount in your organization, or the feature isn’t enabled for your organization. The request is denied.
  • The lock is a compliance, anti-money-laundering, treasury, W-8, or account-closure lock, or a lock recorded only with the generic Other code, which partners can’t clear.
  • The account has no active lock to clear.

Error Messages

A failed request returns one of these messages:

MessageResponseTrigger
"No active lock on this account."200 (in errorText)The account has no active lock to clear.
"Compliance lock - contact Tradovate"200 (in errorText)The lock is a compliance, anti-money-laundering, treasury, W-8, or account-closure lock, or any other lock recorded with a code a partner can’t clear.
"Access is denied"401The caller isn’t an organization administrator, the account isn’t a subaccount in the caller’s organization, or the feature isn’t enabled. An account in another organization can return HTTP 404.

Related Resources

Authentication

AuthorizationBearer

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

Request

This endpoint expects an object.
accountIdlongRequired
reasonstringOptional<=8192 characters

Response

AccountRiskStatusResponse
errorTextstringOptional<=8192 characters

Non-empty if the request failed

accountRiskStatusobjectOptional