Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Get a Restriction

This request returns detail about an account restriction currently applied to a brokerage account.

Accounts will generally be restricted under Reason Code 020 until the user electronically signs the brokerage customer agreement on the Folio hosted web pages. If an introducing broker-dealer is configured to accept the customer agreement signature on its hosted pages then the accounts will be restricted under Reason Code 022, API Account Approval (not under Reason Code 020) until that firm lifts the restriction using the Remove Restriction API call, once they have captured the customer’s electronic signature of the brokerage customer agreement.

In addition, if a firm wishes to restrict an account at any time and for any reason, such as to review all new accounts prior to providing them full functionality, then it can restrict each account created under the firm using the Create a Restriction call and Reason Code 021, External. The firm can then lift that restriction at its discretion using the Remove Restriction API call.

In the API test environment restrictions under Reason Codes 020, 021 and 022 may be lifted with the Remove Restriction API call. Other restrictions, such as for FINRA membership, are not generally lifted in the test environment, and each have their own unique processes in production.

Request URL

Syntax GET /restapi/accounts/{accountnumber}restrictions/{accountrestrictionid}
Example URL https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/restrictions/77777777777777777

Response Data Fields

Field Description
accountNumber Account identifier.
accountRestrictionId The identifier of the restriction.
creationTs The restriction creation timestamp.
inceptionInfo Miscellaneous information added during the restriction creation.
reason See detail below.
type See detail below.

Reason Fields

Field Description
code A code used to identify the restriction reasons. 021 (External), 022 (API Account Approval) are available restrictions to API.
comments Reason description.
name “External” or “API Account Approval”.

Type Fields

Field Description
code Identifier of the restriction type. Current values include “CR” (account is completely restricted) and “SR” (sell only restriction).
description A more verbose description of the account restriction type.
title The title could be used to display on the page.

Response Example


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://testapi.foliofn.com/restapi/accounts/RA1234ABCD/restrictions/77777777777777777
Content-Type: application/json
Transfer-Encoding: chunked
Date: Sat, 05 Jul 2014 13:06:39 GMT
{
  "accountNumber" : "123123123123123",
  "accountRestrictionId" : "77777777777777777",
  "creationTs" : "2014-07-05T09:14:55.790-04:00",
  "inceptionInfo" : " ",
  "reason" : {
    "code" : "021",
    "comments" : "Externally Set Restriction used through the API",
    "name" : "External"
  },
  "type" : {
    "code" : "CR",
    "description" : "Account is completely restricted",
    "title" : "Complete Restriction"
  }
}

Getting Started

REST APIs

Resources

Developer Home