Submit Customer Application Document
Upload a document for a customer application.
Available to: All authenticated users
Environments: Live
Rate Limit: 750 requests per hour, 30-second back-off, counts all requests
Use this endpoint to upload a document for a customer application or compliance workflow. The process field determines which workflow the document belongs to, and the documentType field specifies the type of document being submitted.
By default, the document is uploaded for the calling user. To upload on behalf of another user, set userId. When process is SubAccountRequest, this requires the caller to be an organization administrator; for all other processes, it requires an organization administrator with business-to-business account-opening (B2B AOP) permission.
A successful request returns a documentId. Store this value for reference in subsequent API calls.
Uploading Documents Before a Subaccount Request
Organization administrators can use this endpoint to upload documents before submitting a subaccount request. Set process to SubAccountRequest and set userId to the CTA user ID of the trader the subaccount is for.
Upload each document separately by calling this endpoint three times (once per document type).
After collecting all three documentId values, pass them to createPartnerSubAccountRequest as pOAFormDocId, governmentDocId, and addressDocId.
base64data Format
Documents are submitted inline as base64 data URIs. The base64data field must be a data URI with a supported MIME type prefix. The maximum field length is 8,388,608 characters (approximately 6 MB).
Supported MIME types:
application/pdftext/plainimage/<file type>(for example,image/pngorimage/jpeg)
Process Types
Document Types
This endpoint supports 86 document types. Use the documentType field to specify the type of document you are uploading.
Identity Documents
Address Verification
Income and Financial
Trading and Authorization
Tax and Regulatory
Business and Corporate
Compliance and AML
Email and Identity Verification
eSign Documents
Other
Common Failure Scenarios
filenameis fewer than five or more than 64 charactersbase64dataexceeds the maximum allowed size (~6 MB)userIdis provided but is not greater than zerocustomerApplicationIdis provided but is not greater than zerouserIdbelongs to another user, but the caller lacks the required permission: organization administrator forSubAccountRequestuploads, or B2B AOP permission for all other processes- Invalid
processvalue - Invalid
documentTypevalue base64datais missing the data URI prefix or uses an unsupported MIME type
Next Steps
For the subaccount use case, after uploading all three documents, pass the returned documentId values to createPartnerSubAccountRequest as pOAFormDocId, governmentDocId, and addressDocId.
For the customer application use case, upload documents against the application started with startCustomerApplication, then continue the flow with prepareAgreementDocuments.
Authentication
Bearer authentication of the form Bearer <token>, where token is your auth token.
Request
AML_FPV, Bankruptcy, Compliance, Identity, NFA, SubAccountRequest, Watchlist
Response
Non-empty if the request failed