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

Upload Account Documents

This request allows uploading a PDF form into Folio repository for various document types linked to an Account. For uploading forms linked to a member see Submit Member Documents.

Request URL

Syntax POST /restapi/accounts/{accountnumber}/uploads
Example URL https://api.uat.foliofn.com/restapi/accounts/RD86589001/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
  • ACCOUNT_TRANSFER
  • BANKLINK_OV
  • BENE_IRA_FORM
  • ENTITY_QUESTIONNAIRE
  • ESTATE_DOCS
  • INTERNAL_TRANSFER
  • INHERITED_IRA_CERT
  • IRA_DEATH_CERTIFICATE
  • IRA_DIST
  • MARGIN_AUTH
  • QRP_SETUP
  • ROLLOVER_CERT
  • SPL_IRA_EMPLYE
  • SPL_IRA_EMPLYR
  • TOD_DESIGNATION_FORM
  • TRUST_EVIDENCE
  • TRUSTEE_CERTIFICATION
  • W9
reference String The reference ID uses to upload the document. No If not specified, use the accountnumber specified on the URL.
referenceType String The type of reference. No If not specified, use ACCOUNT.
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://api.uat.foliofn.com/restapi/accounts/RD86589001/uploads HTTP/1.1
Content-Type: application/json
{
    "documentData": "...document content encoded in Base64...",
    "documentType": "ACCOUNT_TRANSFER"
}

Document Type

Document Type Description
ACCOUNT_TRANSFER Account Transfer Form, used to initiate account transfers from other financial institutions
BANKLINK_OV EFT Authorization Form, used by owner to verify an existing Bank Link.
BENE_IRA_FORM Beneficiary IRA Form, required to fully establish a Beneficiary IRA account.
ENTITY_QUESTIONNAIRE Entity Client Onboarding Supplemental Questionnaire used to provide additional required information when opening a new legal entity account.
INTERNAL_TRANSFER Internal Account Transfer form, used to transfer cash/securities between Folio accounts when eligible.
IRA_DIST IRA Distribution Form, used when distribution cannot be processed online.
MARGIN_AUTH Margin Authorization form to enable margin borrowing on an account.
QRP_SETUP Qualified Retirement Plan Setup form, used to fully establish a QRP Account
SPL_IRA_EMPLYE SIMPLE IRA Employee Certification form, used to fully establish a SIMPLE IRA Account.
SPL_IRA_EMPLYR SIMPLE IRA Employer Certification form, used to fully establish a SIMPLE IRA Account
TOD_DESIGNATION_FORM Transfer on Death Form, used to designate beneficiaries on applicable taxable account types.
TRUSTEE_CERTIFICATION Trustee Certification form, used to verify trustees when necessary.
TRUST_EVIDENCE Trust Evidence form used to certify the legal evidence of existence of a trust.
W9 W9 form is used to update the name on an account that is associated with a Taxpayer Identification Number (TIN) after a marriage or divorce, or to request a correction to the TIN on an account.

Response Example


HTTP/1.1 200 OK
Date: XXX
Location: http://api.uat.foliofn.com/restapi/accounts/RD86589001/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 ACCOUNT_DOCUMENT with document {documentType}: expected MEMBER_DOCUMENT Incompatible document type for referenceType ACCOUNT.
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

12/07/2023

  1. Added new document types that can be uploaded via this end point.

03/12/2020

  1. Remove extra spaces, especially at the bottom

05/11/2018

  1. Added new error code
  2. Updated valid documentTypes

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