HomeGuidesRecipesAPI ReferenceGraphQLChangelogDiscussionsv2023.08
HomeLog In
API Reference
These docs are for v2023.08. Click to read the latest docs for v2023.12.

Upload a Document to Existing Account

Upload a document 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.

Path Params
uuid
required

Account identifier.

Body Params
string
enum
required
  • identity_verification:
    identity verification document

  • address_verification:
    address verification document

  • date_of_birth_verification:
    date of birth verification document

  • tax_id_verification:
    tax ID verification document

  • account_approval_letter:
    407 approval letter

  • cip_result:
    initial CIP result

  • w8ben:
    W-8 BEN tax form

  • w9:
    W9 tax form

  • limited_trading_authorization:

string

The specific type of document, e.g. passport

string
required

Base64 string representing the document

content_data
object

W-8BEN documents model.

string

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

Responses
204

Success (No Content)

Language
Credentials
Basic
base64
:
URL
LoadingLoading…
Response
Click Try It! to start a request and see the response here! Or choose an example:
application/json

©2023. Prime Industries, Services, and Trinkets LLC. We are not responsible