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

Get a Corporate Firm

This request returns the information for a specific firm.

Request URL

Syntax GET /restapi/firms/{firmId}
Example URL https://api.uat.foliofn.com/restapi/firms/THISISFIRMID

Response Data Fields

Field Description
firmOid A unique ID for the member. This field is a long type numeric value generated by the Folio REST service when the member is initially created. This field will not change.
firmType “G” is the only valid corporate firm type.
Values of “L”, “S”, “C” and “P” are Institutional firm types that cannot be created or updated using this API.
firmTaxId The last 4 digits or the full text of the tax identification number or the social security number of the firm will be. (The actual case refers to the security configuration detail in the contract.)
firmTaxIdType The type of the tax ID used in firmTaxId field. of the tax identification number (TIN) or the social security number (SSN).
firmName Name of the entity.
firmTelephone1 The firm’s primary phone number.
firmTelephone2 The firm’s secondary phone number.
firmEmail1 The primary email address of the firm.
firmEmail2 The secondary email address of the firm.
finraAffiliated A binary indicator of whether the member is employed by or associated with a FINRA-registered company. “true” or “false”.
finraCompany The company the firm is affiliated with. Letters, digits, special characters, or spaces are allowed.
directorOrTenPercentShareholder A binary indicator of whether member is a director or 10% shareholder at a publicly-traded company. “true” or “false”.
directorOrTenPercentShareholderCompany

A comma separated string of exchange listed publicly traded security tickers.

Tickers specified here are set up as security level exclusions for accounts of the member.

primaryAddress The primary address of the firm. This must be a U.S. street address, no P.O. Boxes or non-U.S. addresses accepted. See Address Fields for the format of each address field
mailingAddress The mailing address of the firm. See Address Fields.
accredAllAccredInvestors

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Please answer the following questions to determine the Accredited Investor status for the entity that owns this account:

Any entity in which all of the equity owners are accredited investors?

accred5MAssetsTrust

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any trust, with total assets in excess of $5,000,000, not formed for the specific purpose of acquiring the securities offered, whose purchase is directed by a sophisticated person as described in 230.506(b)(2)(ii)?

accredBusinessDevelopmentCompany

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any private business development company as defined in section 202(a)(22) of the Investment Advisers Act of 1940?

accred5MAssetsOrganization

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any organization described in section 501(c)(3) of the Internal Revenue Code, corporation, Massachusetts or similar business trust, or partnership, not formed for the specific purpose of acquiring the securities offered, with total assets in excess of $5,000,000?

accred5MAssetsPlanAndEtc

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any bank as defined in section 3(a)(2) of the Act, or any savings and loan association or other institution as defined in section 3(a)(5)(A) of the Act whether acting in its individual or fiduciary capacity; any broker or dealer registered pursuant to section 15 of the Securities Exchange Act of 1934; any insurance company as defined in section 2(a)(13) of the Act; any investment company registered under the Investment Company Act of 1940 or a business development company as defined in section 2(a)(48) of that Act; any Small Business Investment Company licensed by the U.S. Small Business Administration under section 301(c) or (d) of the Small Business Investment Act of 1958; any plan established and maintained by a state, its political subdivisions, or any agency or instrumentality of a state or its political subdivisions, for the benefit of its employees, if such plan has total assets in excess of $5,000,000; any employee benefit plan within the meaning of the Employee Retirement Income Security Act of 1974 if the investment decision is made by a plan fiduciary, as defined in section 3(21) of such act, which is either a bank, savings and loan association, insurance company, or registered investment adviser, or if the employee benefit plan has total assets in excess of $5,000,000 or, if a self-directed plan, with investment decisions made solely by persons that are accredited investors?

qibInsuranceCompany

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Please answer the following questions to determine Qualified Institutional Buyer (QIB) status for this account:

Does the entity that owns this account own and invest, on a discretionary basis, at least $100 million in securities of issuers that are not affiliated with the entity and is the entity:

An insurance company?

qibInvestmentCompany

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

An investment company registered under the Investment Company Act of 1940?

qibSmallBusinessInvestmentCompany

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

A Small Business Investment Company under the Small Business Investment Act of 1958?

qibEmployeeBenefitPlan

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

An employee benefit plan established by a state, its political subdivisions, state agency, or falling under the Employee Retirement Income Security Act (ERISA) of 1974?

qibTrustFund

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

A trust fund whose trustee is a bank or trust company, and whose participants are exclusively plans established for the benefit of state employees or employee benefit plans, except those trust*s* that include IRAs or F.R. 10 plans as participants?

qibBusinessDevelopmentCompany

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

A business development company as defined in Section 202(a)(22) of the Investment Advisers Act of 1940?

qib501c3CharitableOrganization

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

A 501(c)(3) charitable organization, corporation (other than a bank or savings and loan association), partnership or Massachusetts or similar business trust?

qibInvestmentAdviser

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

An investment adviser registered under the Investment Advisers Act of 1940?

qibRegisteredDealer10M

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

If you answered Yes to one of the QIB questions above, select Continue below.

If none of the QIB questions above apply, please answer the following questions about the entity that owns this account:

A registered dealer acting for its own account of the accounts of other QIBs that in aggregate owns and invests, on a discretionary basis, at least $10 million in securities of issuers not affiliated with the dealer?

qibRegisteredDealerRiskless

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

A registered dealer acting in a riskless principal transaction on behalf of a QIB?

qibInvestmentCompany100M

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

An investment company registering under the Investment Company Act of 1940 acting for its own account or for the accounts of other QIBs, and that is part of a family of investment companies which own in the aggregate at least $100 million in securities of issuers not affiliated with the investment company or the family of companies?

qibEntity

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any entity, all equity owners of which are QIBs, acting for its own account or the account of other QIBs?

qibBank

A binary (“true” or “false”) indicator of whether the entity is accredited for private placements based on the User text question:

Any bank or savings and loan association, or like institution, acting for its own account or the accounts of other QIBs, that in the aggregate owns and invests, on a discretionary basis, at least $100 million in securities of issuers not affiliated with it, and has an audited net worth of at least $25 million in its latest annual financial statements as of a date not more than 16 months preceding the date of sale under Rule 144A?

Institutional Firm Specific Response Data Fields

Field Description
billingLevel The indicator of whether a billing plan is associated with a member or an account.
“A” for account-level billing,
“M” for member-level billing.
isBranch The indicator of whether the institutional firm is a branch of another firm. (true/false)
isBrokerDealer The indicator of whether the institutional firm is a broker dealer. (true/false)
isRegisteredInvestmentAdvisor The indicator of whether the institutional firm is a registered investment advisory firm. (true/false)
dollarTradeThreshold When the dollar amount of a trade in an individual security in a model or allocation sync order is less than the dollar trade threshold, the order for that one security will generally not be generated, unless the order is to sell all of the security position. (0.01 to 100.00) Learn More

Corporate Firm Specific Response Data Fields

Field Description
firmRep The username of the member who is already created on the platform and is going to be assigned as the firm representative for this one corporate firm, and its one corporate account.

Response Example

Institutional Firm


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/firms/INSTITUTIONALFIRMID
Link: <https://api.uat.foliofn.com/restapi/firms/INSTITUTIONALFIRMID/billingplans>; rel="GET"; type="application/json"; title="getBillingPlans"
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 14 Jul 2014 19:14:23 GMT
{
  "billingLevel" : "M",
  "isBranch" : false,
  "isBrokerDealer" : false,
  "dollarTradeThreshold" : "1",
  "firmEmail1" : "institutional@email.com",
  "firmEmail2" : "institutional@email.com",
  "firmId" : "INSTITUTIONALFIRMID",
  "firmName" : "Sample Firm",
  "firmOid" : "1233243535513212431",
  "firmTaxId" : "XXXXX2311",
  "firmTaxIdType" : "TIN",
  "firmTelephone1" : "7032454000",
  "firmTelephone2" : "7032454800",
  "firmType" : "S",
  "finraAffiliated" : false,
  "partnerCode" : "PARTNERCODE",
  "isRegisteredInvestmentAdvisor" : true,
  "directorOrTenPercentShareholder" : false
}

Corporate Firm


HTTP/1.1 200 OK
X-Powered-By: Servlet/2.5
Server: Sun GlassFish Enterprise Server v2.1.1
Location: https://api.uat.foliofn.com/restapi/firms/NEWCORPORATEFIRMID
Link: <https://api.uat.foliofn.com/restapi/firms/NEWCORPORATEFIRMID>; rel="PUT"; type="application/json"; title="updateFirm"
Content-Type: application/json
Transfer-Encoding: chunked
Date: Mon, 14 Jul 2014 19:17:23 GMT
{
  "accred5MAssetsOrganization" : true,
  "accred5MAssetsPlanAndEtc" : false,
  "accred5MAssetsTrust" : true,
  "accredAllAccredInvestors" : false,
  "accredBusinessDevelopmentCompany" : false,
  "firmEmail1" : "corporatefirm@email.com",
  "firmId" : "NEWCORPORATEFIRMID",
  "firmName" : "New Corporate Firm",
  "firmOid" : "1232342343453451231",
  "firmRep" : "firmRepId",
  "firmTaxId" : "XXXXX1111",
  "firmTaxIdType" : "SSN",
  "firmTelephone1" : "5675675678",
  "firmTelephone2" : "6786786789",
  "firmType" : "G",
  "finraAffiliated" : false,
  "partnerCode" : "PARTNERCODE",
  "directorOrTenPercentShareholder" : false
  "qib501c3CharitableOrganization" : false,
  "qibBank" : false,
  "qibBusinessDevelopmentCompany" : false,
  "qibEmployeeBenefitPlan" : false,
  "qibEntity" : false,
  "qibInsuranceCompany" : false,
  "qibInvestmentAdviser" : false,
  "qibInvestmentCompany" : false,
  "qibInvestmentCompany100M" : true,
  "qibRegisteredDealer10M" : false,
  "qibRegisteredDealerRiskless" : false,
  "qibSmallBusinessInvestmentCompany" : false,
  "qibTrustFund" : false,
}

Getting Started

REST APIs

Resources

Developer Home