Documents #

The documents endpoint allows you to view and download any documents that fit the parameters passed. Types of documents generated from Alpaca can be Account Monthly Statements and Trade Confirmations.

The Document Object #

Sample Object #

{
  "id": "11d5a814-9a71-4161-82a5-18e8ee0bed17",
  "name": "",
  "type": "trade_confirmation",
  "sub_type": "",
  "date": "2022-02-16"
}

Attributes #

Attribute	Type	Notes
`id`	string/UUID	The UUID of the document
`name`	string	The title of the document (if applicable)
`type`	ENUM.DocumentType
`sub_type`	string	ENUM: either empty string `""`, `1099-Comp`, `1042-S`, or `480.6`
`date`	string/date	format: “2020-01-01”

ENUM.DocumentType #

Value	Description
`account_statement`	Document is an account statement
`trade_confirmation`	Document is a confirmation that a trade has completed
`tax_statement`	Document is a generated tax statement

For accounts with older documents the following legacy values might also be seen

Value
`tax_1099_b_details`
`tax_1099_b_form`
`tax_1099_div_details`
`tax_1099_div_form`
`tax_1099_int_details`
`tax_1099_int_form`
`tax_w8`

Uploading a Document #

POST /v1/accounts/{account_id}/documents/upload

Upload one or more (up to 10) documents to be attached to an account.

Documents are binary objects whose contents are encoded in base64. Each encoded content size is limited to 10MB if you use Alpaca for KYCaaS. If you perform your own KYC there are no document size limitations.

Request #

Sample Request #

[
  {
    "document_type": "cip_result",
    "content": "JVBERi0K",
    "mime_type": "application/pdf"
  },
  {
    "document_type": "identity_verification",
    "document_sub_type": "passport",
    "content": "/9j/Cg==",
    "mime_type": "image/jpeg"
  }
]

Path Parameters #

Attribute	Type	Required	Notes
`account_id`	string/UUID	Required	The id for the related Account

Parameters #

The main payload body is an array of data representing the documents to upload.

Note These are not the same as the Document object and it is not an error that the field names are different.

Attribute	Type	Required	Notes
`document_type`	ENUM.UploadDocumentType	Required
`document_sub_type`	ENUM.UploadDocumentSubType	Optional
`content`	string	Optional	A string containing Base64 encoded data to upload. This field is Required if `document_type` is anything other than `w8ben` or if it is `w8ben` and `content_type` is not specified.
`content_data`	W8BenDocumentUpload	Optional	This field is Required if `content` is not specified. It is also only available when `document_type` is `w8ben`
`mime_type`	string	Optional	This field is Required if `content` is specified. ENUM: `application/pdf`, `image/png`, or `image/jpeg`. If `document_type` is `w8ben` then `application/json` is also accepted

ENUM.UploadDocumentType #

Value	Notes
`identity_verification`
`address_verification`
`date_of_birth_verification`
`tax_id_verification`
`account_approval_letter`
`limited_trading_authorization`
`w8ben`
`w9`

ENUM.UploadDocumentSubType #

Value
`Account Application`
`Form W-8BEN`
`passport`

Response #

202 - Accepted

Error Codes #

400 - Bad Request

The body in the request is not valid

404 - Not Found

No account was for this account_id

W8BenDocumentUpload Type #

This type represents the fields needed to upload a W-8 BEN document via the Upload documents route

It has been separated out into its own section in favour of readability.

For more information on W8Ben and international accounts please see the section here on international accounts

Attributes #

Attribute	Type	Notes
`country_citizen`	string
`date`	string/Date	`YYYY-MM-DD` format
`date_of_birth`	string/Date	`YYYY-MM-DD` format
`full_name`	string
`ip_address`	string
`permanent_address_city_state`	string
`permanent_address_city_country`	string
`permanent_address_city_street`	string
`revision`	string
`signer_full_name`	string
`timestamp`	string/timestamp
`additional_conditions`	string/null
`capacity_acting`	string/null
`foreign_tax_id`	string/null
`income_type`	string/null
`mailing_address_city_state`	string/null
`mailing_address_country`	string/null
`mailing_address_street`	string/null
`paragraph_number`	string/null
`percent_rate_withholding`	number/null
`reference_number`	string/null
`residency`	string/null
`tax_id_ssn`	string/null
`ftin_not_required`	bool/null

Retrieving Documents for One Account #

GET /v1/accounts/{account_id}/documents

This endpoint allows you to query all the documents that belong to a certain account. You can filter by date, or type of document.

Request #

Path Parameters #

Attribute	Type	Required	Notes
`account_id`	string/UUID	Required	The id for the related Account

Query Parameters #

Attribute	Type	Requirement	Notes
`start`	string/date	Optional	format: 2020-01-01
`end`	string/date	Optional	format: 2020-01-01
`type`	string	Optional	ENUM: `account_statement` or `trade_confirmation`

Response #

Returns an array of document models.

Error Codes #

401 - Not Authorized: Invalid Credentials

Downloading a Document #

GET /v1/accounts/{account_id}/documents/{document_id}/download

This endpoint allows you to download a document identified by the document_id passed as a path parameter. The returned document is in PDF format.

You can retrieve a JSON version of a monthly statement by passing in the header accept: application/json header.

Request #

Path Parameters #

Attribute	Type	Required	Notes
`account_id`	string/UUID	Required	The id for the related Account
`document_id`	string/UUID	Required	The id for the Document you wish to download

Response #

301 - Redirects to a presigned download link for the document PDF.

Errors #

404 - Document Not Found

Downloading the W8Ben #

GET /v1/accounts/{account_id}/documents/w8ben/{document_id}/download

This endpoint allows you to download a W8ben identified by the document_id passed as a path parameter. The returned document is in PDF format.

You can retrieve a JSON version of a monthly statement by passing in the header accept: application/json header.

Request #

Path Parameters #

Attribute	Type	Required	Notes
`account_id`	string/UUID	Required	The id for the related Account
`document_id`	string/UUID	Required	The id for the W8Ben you wish to download

Response #

301 - Redirects to a presigned download link for the document PDF.

Errors #

404 - Document Not Found

Retrieving a Document by ID #

GET /v1/accounts/{account_id}/documents/{document_id}

This endpoint allows you to call for a specific document and returns the document model.

Request #

Path Parameters #

Attribute	Type	Required	Notes
`account_id`	string/UUID	Required	The id for the related Account
`document_id`	string/UUID	Required	The id for the Document you wish to retrieve

Response #

Returns the document model.

Errors #

404 - Document Not Found

Disclosures

Brokerage services are provided by Alpaca Securities, member FINRA/SIPC, a wholly-owned subsidiary of AlpacaDB, Inc.

Technology and services are offered by AlpacaDB, Inc.

Brokerage services are provided to customers who can write automated investment code and self-direct their own investments. Alpaca brokerage services are only provided to customers who agree to electronically sign agreements and agree to receive messages, confirmations, and statements electronically. Is Alpaca right for me?

This is not an offer, solicitation of an offer, or advice to buy or sell securities or cryptocurrencies, or open a brokerage account or cryptocurrency account in any jurisdiction where Alpaca Securities or Alpaca Crypto respectively, are not registered or licensed, as applicable.

The Paper Trading API is offered by AlpacaDB, Inc. and does not require real money or permit a user to transact in real securities in the market. Providing use of the Paper Trading API is not an offer or solicitation to buy or sell securities, securities derivative or futures products of any kind, or any type of trading or investment advice, recommendation or strategy, given or in any manner endorsed by AlpacaDB, Inc. or any AlpacaDB, Inc. affiliate and the information made available through the Paper Trading API is not an offer or solicitation of any kind in any jurisdiction where AlpacaDB, Inc. or any AlpacaDB, Inc. affiliate (collectively, "Alpaca") is not authorized to do business.

You should know that the use or granting of any third party access to your account information or place transactions in your account at your direction is solely at your risk. Alpaca does not warrant against loss of use or any direct, indirect or consequential damages or losses to you caused by your assent, expressed or implied, to a third party accessing your account or information, including access provided through any other third party apps, systems, or sites.

Market prices, data and other information available through Alpaca are not warranted as to completeness or accuracy and are subject to change without notice. System response and account access times may vary due to a variety of factors, including trading volumes, market conditions, system performance, and other factors. A more complete description of the impact these factors may have can be found in our risks of automated trading systems section.

All investments involve risk and the past performance of a security, or financial product does not guarantee future results or returns. Keep in mind that while diversification may help spread risk it does not assure a profit, or protect against loss, in a down market. There is always the potential of losing money when you invest in securities, or other financial products. Investors should consider their investment objectives and risks carefully before investing.

There are risks unique to automated trading algorithms that you should know about and plan for. You should setup a method or system of continuous monitoring or alerting to let you know if there is a mechanical failure, such as connectivity issues, power loss, a computer crash, or system quirk. You should also monitor for instances where your automated trading system experiences anomalies that could result in errant, missing, or duplicated orders. A more complete description of these and other risks can be found in our FAQ section.

Conditional orders may have increased risk as a result of their reliance on trigger processing, market data, and other internal and external systems. Such orders are not sent to the market until specified conditions are met. During that time, issues such as system outages with downstream technologies or third parties may occur. Conditional orders triggering near the market close may fail to execute that day. Furthermore, our executing partner may impose controls on conditional orders to limit erroneous trades triggering downstream orders. Alpaca Securities may not always be made aware of such changes to external controls immediately, which may lead to some conditional orders not being executed. As such, it is important to monitor conditional orders for reasonability. Conditional orders are “Not Held” orders whose execution instructions are on a best efforts basis upon being triggered. Furthermore, conditional orders may be subject to the increased risks of stop orders and market orders outlined above. Given the increased potential risk of using conditional orders, the client agrees that Alpaca Securities cannot be held responsible for losses, damages, or missed opportunity costs associated with market data problems, systems issues, and user error, among other factors. By using conditional orders the client understands and accepts the risks outlined above. Alpaca Securities encourages leveraging the use of Paper accounts to become more comfortable with the intricacies associated with these orders.

ETFs can entail risks similar to direct stock ownership, including market, sector, or industry risks. Some ETFs may involve international risk, currency risk, commodity risk, and interest rate risk. Trading prices may not reflect the net asset value of the underlying securities.

All accounts are opened as limited purpose margin accounts. You should know that margin trading involves interest charges and risks, including the potential to lose more than deposited or the need to deposit additional collateral in a falling market. Before using margin, customers must determine whether this type of trading strategy is right for them given their specific investment objectives, experience, risk tolerance, and financial situation. For more information please see Alpaca's Margin Disclosure Statement and Margin Agreement. These disclosures contain information on Alpaca Securities's lending policies, interest charges, and the risks associated with margin accounts.

Commission-Free trading means that there are no commission charges for Alpaca Securities self-directed individual brokerage accounts that trade U.S. listed securities through an API. Relevant regulatory fees may apply.

Commission free trading is available for Alpaca's retail customers. Alpaca reserves the right to charge additional fees if it is determined that orders flow is non-retail in nature.

Cryptocurrency is highly speculative in nature, involves a high degree of risks, such as volatile market price swings, market manipulation, flash crashes, and cybersecurity risks. Cryptocurrency is not regulated or is lightly regulated in most countries. Cryptocurrency trading can lead to large, immediate and permanent loss of financial value. You should have appropriate knowledge and experience before engaging in cryptocurrency trading. For additional information please click here.

Cryptocurrency services are made available by Alpaca Crypto, a FinCEN registered money services business (NMLS # 2160858), and a wholly-owned subsidiary of AlpacaDB, Inc. Alpaca Crypto is not a member of SIPC or FINRA. Cryptocurrencies are not stocks and your cryptocurrency investments are not protected by either FDIC or SIPC. Please see the Disclosure Library for more information.