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 IRA_DIST TOD_DESIGNATION_FORM SPL_IRA_EMPLYE SPL_IRA_EMPLYR QRP_SETUP INTERNAL_TRANSFER TRUSTEE_CERTIFICATION
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

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.
IRA_DIST
- IRA Distribution Form, used when distribution cannot be processed online.
TOD_DESIGNATION_FORM
- Transfer on Death Form, used to designate beneficiaries on applicable taxable account types.
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

QRP_SETUP

Qualified Retirement Plan Setup form, used to fully establish a QRP Account

INTERNAL_TRANSFER

Internal Account Transfer form, used to transfer cash/securities between Folio accounts when eligible

TRUSTEE_CERTIFICATION

Trustee Certification form, used to verify trustees when necessary

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.