Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Update a Corporate Firm
Please contact the Goldman Sachs Advisor Solutions Integrations Team at gs-ria-integrations@gs.com to request the most recent documentation for Create, Update & Get a Member, Firm and Account, which has significant and required changes from the information below.
This request updates the information about a firm. The table below includes the fields that can be updated. Other fields that are defined in Create a Corporate Firm but not listed here cannot be updated by API.
Notes:
- This call only supports updates to corporate firms. Attempts to update Institutional firms will receive an UNSUPPORTED error along with the firmId specified.
- You must establish processes to ensure that all firm profile information, including but not limited to physical mailing address(es), email address, phone number(s), financial data, and all other firm information, is accurate and complete, and that you update the Folio system with all changes when they are received by your Firm. Folio cannot accept any client email address or phone number with the same domain name or phone number that is associated with your Firm, unless that account is owned by your Firm.
Request URL
| Syntax | PUT /resatpi/firms/{firmid} |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/firms/THISISFIRMID |
Response Data Fields
| Field | Description |
|---|---|
| primaryAddress |
The primary address of the member. 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. Use the name “Primary Address” on client applications. User text: (U.S. street addresses only; no P.O. Boxes)
|
| mailingAddress |
The mailing address of the member. See Address Fields. Use the name “Mailing Address” on client applications. User text: (P.O. Boxes allowed)
|
| firmTelephone1 |
The firm’s primary phone number. The length should be between 10 and 14 digits. User text: Enter numbers only. For extensions, add the extension number to the end (ex. 70324540001234).
|
| firmTelephone2 |
The firm’s secondary phone number. The length should be between 10 and 14 digits. User text: Enter numbers only. For extensions, add the extension number to the end (ex. 70324540001234).
|
| firmEmail1 |
The primary email address of the firm. This field must be a well-formed email address (i.e. example@example.com). We ask that you have the user enter this field twice and ensure that both entries match. User text: A valid email address is required.
|
| firmEmail2 | The secondary email address of the firm. If supplied, this field must be well-formed email address. (i.e. example@example.com) |
| finraAffiliated |
A binary indicator of whether the member is employed by or associated with a FINRA-registered company. “true” or “false”. User text: Are you, your spouse, or any other immediate family members, including parents, in-laws, and siblings that are dependents, employed by or associated with the securities industry (for example, investment advisor, sole proprietor, partner, officer, director, branch manager or broker at a broker-dealer firm or municipal securities dealer) or a financial regulatory agency, such as FINRA or the New York Stock Exchange? If yes, and if this entity requires that you obtain its approval for you to open this account, please select Yes below:
Additional text for use if “true”: FINRA Affiliation Please download, complete and send us the Compliance Officer Form to unrestrict the account. |
| finraCompany | The company the member is affiliated with. Letters, digits, special characters, or spaces are allowed. The length should be between 1 and 45. |
| directorOrTenPercentShareholder |
A binary indicator of whether member is a director or 10% shareholder at a publicly-traded company. “true” or “false”. User text: Are you or someone in your household or immediate family a 10% shareholder, policymaking officer or member of the board of directors of a publicly traded company?
Additional text for use if “true”: Enter trading symbols:
|
| directorOrTenPercentShareholderCompany |
A comma separated string of exchange listed publicly traded security tickers. Letters, digits, and dot are allowed (e.g., GOOG.C). Tickers specified here will be added to the security level exclusions for accounts of the member. |
| 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: 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: Please answer the following questions to determine Qualified Institutional Buyer (QIB) status for this account: 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?
|
Request Example
PUT /restapi/firms/THISISFIRMID HTTP/1.1
{
"firmEmail1" : "firm@email.com",
"firmId" : "THISISFIRMID"
},
"firmTelephone1" : "5675675678",
"firmTelephone2" : "6786786789",
"directorOrTenPercentShareholderCompany" : ["GOOG"],
"directorOrTenPercentShareholder" : true,
"streetAddress" : {
"line1" : "street address 1",
"city" : "city",
"state" : "VA",
"zipcode" : "12345",
"country" : "US"
},
"qib501c3CharitableOrganization" : false,
"qibTrustFund" : true
}
Response Example
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/THISISFIRMID
Link: <https://api.uat.foliofn.com/restapi/firms/THISISFIRMID>; rel="GET"; type="application/json"; title="getFirm"
Content-Type: text/html; charset=iso-8859-1
Content-Length: 0
Date: Wed, 19 Feb 2014 19:18:58 GMT
Change Log
09/02/2016
- Updated Notes Section