Depending on applicable regulations or business limitations, specific API requests may not be available for your use.

Upload Member Documents

This request allows uploading a document form into Folio repository for various document types linked to a Member. For uploading forms linked to an account see Submit Account Documents. The document must be in PDF format with an exception for Customer Identification Program verification document which accepts documents in JPG, PNG, and PDF formats.

Request URL

Syntax POST /restapi/members/{loginid}/uploads
Example URL

Request Data Fields

Field Type Description Required Value
documentData String Document data encoded in Base64. Yes
documentType String The type of document to upload. Yes
reference String The reference ID uses to upload the document. No If not specified, use the loginid specified on the URL.
referenceType String The type of reference. No If not specified, use MEMBER.
comments String Notes or handling instructions for the document. No Limit of 300 characters, requests with greater than 300 characters will be truncated.

Request Example

Content-Type: application/json
    "documentData": "...document content encoded in Base64...",
    "documentType": "CIP_VERIFICATION"

Document Type

    • Documents submitted to support accreditation status for private placement eligibility.
    • Documents submitted to support CIP (Customer Identification Program) verification, note that these are only needed if member fails automated check.
    • FINRA Member Approval Form, used by account owners if you are employed by a FINRA member firm.

Response Example

HTTP/1.1 200 OK
Date: XXX
Content-Length: 0

Error Codes

HTTP Code Status Field Code Message Description
403 The specified user is not allowed to use this request.
400 reference invalid.value The reference specified on the URL is different from the one specified on the body request.
400 referenceType invalid.value The referenceType is invalid.
400 documentType The documentType is null.
400 documentType The documentType is empty.
400 documentType invalid.value The documentType is invalid.
400 documentData The documentData is null.
400 documentData The documentData is empty.
400 documentData invalid.value The documentData is not correctly encoded.
400 documentUploadService.uploadDocument java.lang.IllegalArgumentException Incompatible category MEMBER_DOCUMENT with document {documentType}: expected ACCOUNT_DOCUMENT Incompatible document type for referenceType MEMBER.
400 documentUploadService.uploadDocument java.lang.IllegalArgumentException Document type is not supported: {documentType} The specified documentType is not supported.
400 documentType   invalid.content.type The document is not in a valid format.

Change Log


  1. Remove extra spaces, especially at the bottom


  1. Added new error code
  2. Updated valid documentTypes
  3. Updates on acceptable formats for documents


  1. Added new field (comments) in Request Data Fields section


  1. Reordered Page Sections


  1. New documentation.

Getting Started