|

Create an Alpaca account

post/users/{fp_id}/integrations/alpaca/account
External ID
Forwards a request to open an account at Alpaca for the provided user.

Request

Path parameters

fp_id·

string

Body

account_type·

optional string

Allowed values:

trading
custodial
donor_advised
agreements·

optional array of objects

agreement·

string

Allowed values:

customer_agreement
crypto_agreement
account_agreement
margin_agreement
options_agreement
custodial_customer_agreement
ip_address·

string

revision·

optional string

signed_at·

string

string (timestamp)
api_key·

string

API Key to use with alpaca
api_secret·

string

API Secret to use with alpaca
disclosures·

optional object

It is your responsibility as the service provider to denote if the account owner falls under each category defined by FINRA rules. We recommend asking these questions at any point of the onboarding process of each account owner in the form of Y/N and Radio Buttons.

context·

optional array of objects

Information relevant to the user’s disclosure selection should be sent through this object.
employer_address·

optional string

employer_name·

optional string

employment_position·

optional string

employment_sector·

optional string

employment_status·

optional string

Allowed values:

UNEMPLOYED
EMPLOYED
STUDENT
RETIRED
immediate_family_exposed·

boolean

If your user’s immediate family member (sibling, husband/wife, child, parent) is either politically exposed or holds a control position.

is_affiliated_exchange_or_finra·

boolean

is_control_person·

boolean

Whether user holds a controlling position in a publicly traded company, member of the board of directors or has policy making abilities in a publicly traded company.

is_politically_exposed·

boolean

enabled_assets·

optional array of strings

Allowed values:

us_equity
crypto
hostname·

string

Alpaca Hostname to use (i.e. sandbox or production, like: broker-api.sandbox.alpaca.markets)

trusted_contact·

optional object

This model input is optional. However, the client should make reasonable effort to obtain the trusted contact information. See more details in FINRA Notice 17-11

city·

optional string

country·

optional string

email_address·

optional string

In addition, only one of the following is required:
family_name·

string

given_name·

string

phone_number·

optional string

postal_code·

optional string

state·

optional string

street_address·

optional string

Response

alpaca_response·

object

status_code·

integer

HTTP status code from Alpaca response
POST /users/{fp_id}/integrations/alpaca/account
1curl -X POST https://api.onefootprint.com/users/{fp_id}/integrations/alpaca/account \
2  -u sk_test_xxxxx: \
3  -d '{
4    "account_type": "trading",
5    "agreements": [
6      {
7        "agreement": "customer_agreement",
8        "ip_address": "192.168.1.1",
9        "revision": "Lorem ipsum dolor",
10        "signed_at": "2022-01-04T12:00-07:00"
11      },
12      {
13        "agreement": "customer_agreement",
14        "ip_address": "192.168.1.1",
15        "revision": "Lorem ipsum dolor",
16        "signed_at": "2022-01-04T12:00-07:00"
17      }
18    ],
19    "api_key": "Lorem ipsum dolor",
20    "api_secret": "Lorem ipsum dolor",
21    "disclosures": {
22      "context": [
23        {
24          "company_city": "Lorem ipsum dolor",
25          "company_compliance_email": "Lorem ipsum dolor",
26          "company_country": "Lorem ipsum dolor",
27          "company_name": "Lorem ipsum dolor",
28          "company_state": "Lorem ipsum dolor",
29          "company_street_address": [
30            "Lorem ipsum dolor",
31            "Lorem ipsum dolor"
32          ],
33          "context_type": "CONTROLLED_FIRM",
34          "family_name": "Lorem ipsum dolor",
35          "given_name": "Lorem ipsum dolor"
36        },
37        {
38          "company_city": "Lorem ipsum dolor",
39          "company_compliance_email": "Lorem ipsum dolor",
40          "company_country": "Lorem ipsum dolor",
41          "company_name": "Lorem ipsum dolor",
42          "company_state": "Lorem ipsum dolor",
43          "company_street_address": [
44            "Lorem ipsum dolor",
45            "Lorem ipsum dolor"
46          ],
47          "context_type": "CONTROLLED_FIRM",
48          "family_name": "Lorem ipsum dolor",
49          "given_name": "Lorem ipsum dolor"
50        }
51      ],
52      "employer_address": "Lorem ipsum dolor",
53      "employer_name": "Lorem ipsum dolor",
54      "employment_position": "Lorem ipsum dolor",
55      "employment_sector": "Lorem ipsum dolor",
56      "employment_status": "UNEMPLOYED",
57      "immediate_family_exposed": true,
58      "is_affiliated_exchange_or_finra": true,
59      "is_control_person": true,
60      "is_politically_exposed": true
61    },
62    "enabled_assets": [
63      "us_equity",
64      "crypto"
65    ],
66    "hostname": "Lorem ipsum dolor",
67    "trusted_contact": {
68      "city": "Lorem ipsum dolor",
69      "country": "Lorem ipsum dolor",
70      "email_address": "Lorem ipsum dolor",
71      "family_name": "Lorem ipsum dolor",
72      "given_name": "Lorem ipsum dolor",
73      "phone_number": "Lorem ipsum dolor",
74      "postal_code": "Lorem ipsum dolor",
75      "state": "Lorem ipsum dolor",
76      "street_address": "Lorem ipsum dolor"
77    }
78  }'
Response example
{
  "alpaca_response": {},
  "status_code": 200
}