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 PDF form into Folio repository for various document types linked to a Member. For uploading forms linked to an account see Submit Account Documents.


Request URL

Syntax POST /restapi/members/{loginid}/uploads
Example URL https://testapi.foliofn.com/restapi/members/bunny010/uploads

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
  • ACCREDITATION_DOCS
  • CIP_VERIFICATION
  • DEFAULT_DOC_TYPE
  • FINRA_MEMBER_FORM
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


POST http://testapi.foliofn.com/restapi/members/bunny010/uploads HTTP/1.1
Content-Type: application/json
{
    "documentData": "...document content encoded in Base64...",
    "documentType": "CIP_VERIFICATION"
}


Document Type

  • ACCREDITATION_DOCS
    • Documents submitted to support accreditation status for private placement eligibility.
  • CIP_VERIFICATION
    • Documents submitted to support CIP (Customer Identification Program) verification, note that these are only needed if member fails automated check.
  • DEFAULT_DOC_TYPE
    • Any other type of document being uploaded to Folio.
  • FINRA_MEMBER_FORM
    • 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
Location: http://testapi.foliofn.com/restapi/members/bunny010/uploads
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 cannot.be.null The documentType is null.
400 documentType cannot.be.empty The documentType is empty.
400 documentType invalid.value The documentType is invalid.
400 documentData cannot.be.null The documentData is null.
400 documentData cannot.be.empty 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.

Change Log

11/23/2017

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

07/08/2016

  1. Reordered Page Sections

12/11/2015

  1. New documentation.

Getting Started

REST APIs

Resources

Developer Home