Depending on applicable regulations or business limitations, specific API requests may not be available for your use.
Get Contra Firms
This request allows retrieving a list of Brokerage firms for initiating a transfer.
Request URL
| Syntax | GET /restapi/utils/contrafirms?acateligible={char} |
|---|---|
| Example URL | https://api.uat.foliofn.com/restapi/utils/contrafirms?acateligible=Y |
Query Parameters
| Name | Required? | Values | Description |
|---|---|---|---|
| acateligible | No | Y/N | An optional indicator to specify if firm participates in the ACAT program. If not provided, both ACAT eligible and Non-ACAT eligible firms will be returned. "Y" for only ACAT eligible firms, "N" for only Non-ACAT eligible firms. |
Response Data Fields
The response is a list of the object which defines the following fields (see response example).
| Field | Type | Description |
|---|---|---|
| dtcNumber | String | The DTC number associated to the firm. |
| name | String | The name of the firm. |
| phoneNumber | String | The phone number of firm. |
| primaryAddress | String | The primary address of the firm. |
Request Example
POST http://api.uat.foliofn.com/restapi/utils/contrafirms HTTP/1.1
Content-Type: application/json
{}
Response Example
HTTP/1.1 200 OK
Date: XXX
Location: http://api.uat.foliofn.com/restapi/utils/contrafirms
Content-Type: application/json
[{
"dtcNumber" : "235",
"name" : "American Capital Partners, LLC"
"phoneNumber" : "1234567890"
"primaryAddress" : {
"city" : "city",
"line1" : "firm address 1",
"line2" : "firm address 2",
"state" : "VA",
"zipcode" : "12345"
} , {
"dtcNumber" : "216",
"name" : "American Express"
"phoneNumber" : "1234567890"
"primaryAddress" : {
"city" : "city",
"line1" : "firm address 1",
"line2" : "firm address 2",
"state" : "VA",
"zipcode" : "12345"
} , {
...
} , {
"dtcNumber" : "0065",
"name" : "Zions Direct, Inc."
"phoneNumber" : "1234567890"
"primaryAddress" : {
"city" : "city",
"line1" : "firm address 1",
"line2" : "firm address 2",
"state" : "VA",
"zipcode" : "12345"
}]
Notes
This list includes firms that do participate in ACATS (Automated Customer Account Transfer Service), as well as firms that do not. If a firm returns a DTC number of '0000', then based on our experiences they do not participate in ACATS. If you would like to initiate a transfer to one of these firms, you will need to upload an Account Transfer Request form through Upload Transfer Documents or Upload Account Documents. These transfers will be processed as Non-ACATS transfers, and typically take 3-6 weeks.
Change Log
05/12/2017
- Added new query parameter
03/03/2017
- Added Notes Section
12/09/2016
- Removed columns from response field table
11/26/2016
- Added new fields
11/20/2016
- New documentation