Sign in

v1

latestOpenAPI 3.0.02026-07-26166415635.8 KB
Documents

Upload Owner Documents for an Existing Account

Upload documents for the primary account owner of 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.

As a convenience, documents of type w8ben may be uploaded as a JSON object using the content_data request property. The Alpaca system will then generate a formatted W-8 BEN document for subsequent downloads.

Note that these owner documents are distinct from the account documents generated by Alpaca, such as tax statements and trade confirmations.

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

Request body

contentstring base64 required

The base64 string encoding of the document contents. This property is required unless content_data is provided.

document_sub_typestring

The specific type of document, e.g. passport. This is a free-form property.

document_type'account_approval_letter' | 'address_verification' | 'cip_result' | 'company_formation' | 'date_of_birth_verification' | 'entity_operating_document' | 'entity_registration' | 'hio_declaration_form' | 'identity_verification' | 'limited_trading_authorization' | 'pep_declaration_form' | 'tax_id_verification' | 'w8ben' | 'w9' required

The type of the owner document

mime_typestring

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

Example request

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

Response

Success (No Content)