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

Handle an Item for Attention

This request is to handle an item for attention such as signing a document, confirming contact address

Request URL

Syntax PUT /restapi/members/{loginid}/ifas/{id}
Example URL https://api.uat.foliofn.com/restapi/members/Mbr1234ABCD/ifas/473997

Request Data Fields

Field Required? Description
action yes Action type, "A" - agree, "R" - reject (for BV type only), "V" - view.
parameterMap see below Parameter name value pair.


Item for Attention Type and Request Conditionally Required Fields, Required/Optional Parameters

Item for Attention Type Description Required Field Required Parameter Name/Value Optional Parameter Name/Value
AA New Account Certification action ["V"|"A"] signatureMethod ["SIGNED_PDF"|"SIGNATURE_IMAGE"].
documentData if signatureMethod = "SIGNED_PDF", must be in PDF format.
documentFileName if signatureMethod = "SIGNED_PDF", must have "pdf" extension.
signatureData if signatureMethod = "SIGNATURE_IMAGE", base 64 encoded signature image file data.
signatureImageEncoding if signatureMethod = "SIGNATURE_IMAGE", ["PNG"|"GIF"|"JPG"|"SVG""].		 backupWithholdingType ["Yes"|"No"]
AN Affirmative Notice action ["V"|"A"]
BV Banklink Verification action ["V"|"A"|"R"]
CA Address Confirm action ["V"|"A"] emailAddress1,
homePhoneNumber,
workPhoneNumber,
homeAddress, see detail data fields information of Address.		 emailAddress2,
mailingAddress,
see detail data fields information of Address.
DU Document Upload action ["V"|"A"] documentData, must be in pdf format.
documentFileName, extention must be pdf.
IA Investment Policy Statement Agreement action ["V"|"A"] signatureMethod ["SIGNED_PDF"| "SIGNATURE_IMAGE""].
documentData if signatureMethod = "SIGNED_PDF", must be in PDF format.
documentFileName if signatureMethod = "SIGNED_PDF", must have "pdf" extension.
signatureData if signatureMethod = "SIGNATURE_IMAGE", base 64 encoded signature image file data.
signatureImageEncoding if signatureMethod = "SIGNATURE_IMAGE", ["PNG"|"GIF"|"JPG"|"SVG"].
MD Banklink Micro Deposit action ["V"|"A"] md1 -- micro deposit amount1,
md2 -- micro deposit amount2
NO Notice action ["V"]
SA Sign Agreement Document action ["V"|"A"] signatureMethod["SIGNED_PDF"| "SIGNATURE_IMAGE"].
documentData if signatureMethod = "SIGNED_PDF", must be in PDF format.
documentFileName if signatureMethod = "SIGNED_PDF", must have "pdf" extension.
signatureData if signatureMethod = "SIGNATURE_IMAGE", base 64 encoded signature image file data.
signatureImageEncoding if signatureMethod = "SIGNATURE_IMAGE", ["PNG"|"GIF"|"JPG"|"SVG"].


Handle Item for Attention Request Examples

IFA Type Notice (NO)
Example 
	
PUT /restapi/members/test123/ifas/501360 HTTP/1.1
Content-Type: application/json

{
  "action" : "V"
}

IFA Type Affirmative Notice (AN)
Example 
	
PUT /restapi/members/test123/ifas/503184 HTTP/1.1
Content-Type: application/json

{
  "action" : "A"
}

IFA Type Banklink Verification (BV)
Example 
	
PUT /restapi/members/test123/ifas/504102 HTTP/1.1
Content-Type: application/json

{
  "action" : "A"
}

IFA Type Banklink Micro Deposit (MD)
Example 
	
PUT /restapi/members/test123/ifas/504107 HTTP/1.1
Content-Type: application/json

{
  "action" : "A",
  "parameterMap" : {
    "md2" : "38.00000",
    "md1" : "6.00000"
  }
}

IFA Type New Account Certification (AA)
Example 
	
PUT /restapi/members/test123/ifas/503180 HTTP/1.1
Content-Type: application/json

{
  "action" : "A",
  "parameterMap" : {
    "memberCheck" : "false",
    "signatureMethod" : "SIGNATURE_IMAGE",
    "signatureData" :"iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwQAADsEBuJFr7QAAABp0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuMTAw9HKhAAACFElEQVQ4T2P4//8/RRirICkYQqCBZcli4ndaZBdx84hNEBXWeiwpavBRgF9hJw+PWAQHl4AQVBkEIBvwf748x6semQ03m2WeuuobfNdQ8PuvoxQKx4pS9v/FhLV3cnDx20C1oBrwvl926vMu2W8uerYoGpGxpoL/fykxk9ss7OwBYE0wA75Mkff6NFH2p7mG419sGpGxlmLQf3ERnSdCAkoiYANATv8+RfbTtBzrN9u3HPv/6eMXoDBucOvGw/+lhd3/JUT0KsEGfJ0qq/Btitw3Q33X/z4u+f9jQmv/J0U14sSJkQ3/48Pr/vPzyUwBG/Btkmzit8myr9eu2Qw2nRjw5cu3/4ICijMhLpgsK/99stxXZwun/+H+Ff9Tolv/p8d348QgF8QCXSkkqDwbbAAwAIW/TZH9OCfX4sPKpbv+f/jwGWwLLvDk8av/s2cu/w9MH/1gA0Dg6zRZv48T5X476Lr+A4W0uVbWfxv9kv+2BmVgbGNQ8t9ar/C/nnLUf23F4P/S4ibPlWSc9OEGgMDrPrn5D9oVvhqpuAKjK+y/mVY60JBSsAGWOvn/DVXjwOlAWszkORe3cDjQIkYUA0DR+bRLZtWlOvknGvLG30ApUV8l+r+Basx/XaXw/0rSTsCUqHmYjYM3CKoFNSXCwMV6aYtnXbJ7YXkBGN//QXmBl1cCmBf4RYCpkAmqFGIA+fg/AwCZ6BVJfDQT8QAAAABJRU5ErkJggg==",
    "signatureImageEncoding" : "PNG"
  }
}

IFA Type Sign Agreement Document (SA)
Example 
	
PUT /restapi/members/test123/ifas/503183 HTTP/1.1
Content-Type: application/json

{
  "action" : "A",
  "parameterMap" : {
    "signatureMethod" : "SIGNATURE_IMAGE",
    "signatureData" : "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwQAADsEBuJFr7QAAABp0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuMTAw9HKhAAACFElEQVQ4T2P4//8/RRirICkYQqCBZcli4ndaZBdx84hNEBXWeiwpavBRgF9hJw+PWAQHl4AQVBkEIBvwf748x6semQ03m2WeuuobfNdQ8PuvoxQKx4pS9v/FhLV3cnDx20C1oBrwvl926vMu2W8uerYoGpGxpoL/fykxk9ss7OwBYE0wA75Mkff6NFH2p7mG419sGpGxlmLQf3ERnSdCAkoiYANATv8+RfbTtBzrN9u3HPv/6eMXoDBucOvGw/+lhd3/JUT0KsEGfJ0qq/Btitw3Q33X/z4u+f9jQmv/J0U14sSJkQ3/48Pr/vPzyUwBG/Btkmzit8myr9eu2Qw2nRjw5cu3/4ICijMhLpgsK/99stxXZwun/+H+Ff9Tolv/p8d348QgF8QCXSkkqDwbbAAwAIW/TZH9OCfX4sPKpbv+f/jwGWwLLvDk8av/s2cu/w9MH/1gA0Dg6zRZv48T5X476Lr+A4W0uVbWfxv9kv+2BmVgbGNQ8t9ar/C/nnLUf23F4P/S4ibPlWSc9OEGgMDrPrn5D9oVvhqpuAKjK+y/mVY60JBSsAGWOvn/DVXjwOlAWszkORe3cDjQIkYUA0DR+bRLZtWlOvknGvLG30ApUV8l+r+Basx/XaXw/0rSTsCUqHmYjYM3CKoFNSXCwMV6aYtnXbJ7YXkBGN//QXmBl1cCmBf4RYCpkAmqFGIA+fg/AwCZ6BVJfDQT8QAAAABJRU5ErkJggg==",
  "signatureImageEncoding" : "PNG"
  }
}

IFA Type Document Upload (DU)
Example 
	
PUT /restapi/members/test123/ifas/502537 HTTP/1.1
Content-Type: application/json

{
  "action" : "A",
  "parameterMap" : {
    "documentData" : "JVBERi0xLjINJeLjz9MNCjMgMCBvYmo8PC9MZW5ndGggNDY+PnN0cmVhbQ0KMC41IDAuMjUgMCAwIGsNL0dTMSBncw03MiAwIC03MiA3MiByZQ0wIDAgbQ1mDWVuZHN0cmVhbQ1lbmRvYmoNNCAwIG9iajw8L1Byb2NTZXRbL1BERl0vRXh0R1N0YXRlPDwvR1MxIDUgMCBSPj4+Pg1lbmRvYmoNNSAwIG9iajw8L1R5cGUvRXh0R1N0YXRlL1NBIGZhbHNlL1NNIDAuMDIvT1AgZmFsc2U+Pg1lbmRvYmoNMSAwIG9iajw8L1R5cGUvUGFnZS9QYXJlbnQgNiAwIFIvUmVzb3VyY2VzIDQgMCBSL0NvbnRlbnRzIDMgMCBSPj4NZW5kb2JqDTYgMCBvYmo8PC9UeXBlL1BhZ2VzL0tpZHNbMSAwIFJdL0NvdW50IDEvTWVkaWFCb3hbMCAwIDcyIDcyXT4+DWVuZG9iag0yIDAgb2JqPDwvQ3JlYXRpb25EYXRlKEQ6MjAwNDExMjMwOTI0MjIrMDEnMDAnKS9Qcm9kdWNlcihBY3JvYmF0IERpc3RpbGxlciA2LjAuMSBmb3IgTWFjaW50b3NoKS9Nb2REYXRlKEQ6MjAwNDExMjMwOTI0MjIrMDEnMDAnKS9UaXRsZShwZGZMTV9CYWNrZ3JvdW5kX0JsdWVfTGlnaHRfbG9uZyk+Pg1lbmRvYmoNNyAwIG9iajw8L1R5cGUvTWV0YWRhdGEvU3VidHlwZS9YTUwvTGVuZ3RoIDI4MDU+PnN0cmVhbQ0KPD94cGFja2V0IGJlZ2luPSfvu78nIGlkPSdXNU0wTXBDZWhpSHpyZVN6TlRjemtjOWQnPz4KPHg6eG1wbWV0YSB4bWxuczp4PSdhZG9iZTpuczptZXRhLycgeDp4bXB0az0nWE1QIHRvb2xraXQgMi45LTksIGZyYW1ld29yayAxLjYnPgo8cmRmOlJERiB4bWxuczpyZGY9J2h0dHA6Ly93d3cudzMub3JnLzE5OTkvMDIvMjItcmRmLXN5bnRheC1ucyMnIHhtbG5zOmlYPSdodHRwOi8vbnMuYWRvYmUuY29tL2lYLzEuMC8nPgo8cmRmOkRlc2NyaXB0aW9uIHJkZjphYm91dD0nJyB4bWxuczpwZGY9J2h0dHA6Ly9ucy5hZG9iZS5jb20vcGRmLzEuMy8nIHBkZjpQcm9kdWNlcj0nQWNyb2JhdCBEaXN0aWxsZXIgNi4wLjEgZm9yIE1hY2ludG9zaCc+PC9yZGY6RGVzY3JpcHRpb24+CjxyZGY6RGVzY3JpcHRpb24gcmRmOmFib3V0PScnIHhtbG5zOnhhcD0naHR0cDovL25zLmFkb2JlLmNvbS94YXAvMS4wLycgeGFwOkNyZWF0ZURhdGU9JzIwMDQtMTEtMjNUMDk6MjQ6MjIrMDE6MDAnIHhhcDpNb2RpZnlEYXRlPScyMDA0LTExLTIzVDA5OjI0OjIyKzAxOjAwJz48L3JkZjpEZXNjcmlwdGlvbj4KPHJkZjpEZXNjcmlwdGlvbiByZGY6YWJvdXQ9JycgeG1sbnM6ZGM9J2h0dHA6Ly9wdXJsLm9yZy9kYy9lbGVtZW50cy8xLjEvJz48ZGM6dGl0bGU+PHJkZjpBbHQ+PHJkZjpsaSB4bWw6bGFuZz0neC1kZWZhdWx0Jz5wZGZMTV9CYWNrZ3JvdW5kX0JsdWVfTGlnaHRfbG9uZzwvcmRmOmxpPjwvcmRmOkFsdD48L2RjOnRpdGxlPjwvcmRmOkRlc2NyaXB0aW9uPgo8L3JkZjpSREY+CjwveDp4bXBtZXRhPgogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAKICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgIAogICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCiAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgICAgCjw/eHBhY2tldCBlbmQ9J3cnPz4KZW5kc3RyZWFtDWVuZG9iag04IDAgb2JqPDwvVHlwZS9DYXRhbG9nL1BhZ2VzIDYgMCBSL01ldGFkYXRhIDcgMCBSPj4NZW5kb2JqDXhyZWYNMCA5DTAwMDAwMDAwMDAgNjU1MzUgZiANMDAwMDAwMDIyNSAwMDAwMCBuIA0wMDAwMDAwMzY4IDAwMDAwIG4gDTAwMDAwMDAwMTYgMDAwMDAgbiANMDAwMDAwMDEwOCAwMDAwMCBuIA0wMDAwMDAwMTY1IDAwMDAwIG4gDTAwMDAwMDAyOTggMDAwMDAgbiANMDAwMDAwMDU0NiAwMDAwMCBuIA0wMDAwMDAzNDI1IDAwMDAwIG4gDXRyYWlsZXINPDwNL1NpemUgOQ0vUm9vdCA4IDAgUg0vSW5mbyAyIDAgUg0vSURbPGJlMGI5Y2Q0ZThhZWViNGNlMDI4NzVkMDMwNjVlZTljPjxiZTBiOWNkNGU4YWVlYjRjZTAyODc1ZDAzMDY1ZWU5Yz5dDT4+DXN0YXJ0eHJlZg0zNDg0DSUlRU9GDQ==",
  "documentFileName" : "abc.pdf"
  }
}

IFA Type Sign Investment Policy Statement (IA)
Example 
	
PUT /restapi/members/test123/ifas/503181 HTTP/1.1
Content-Type: application/json

Request == {
  "action" : "A",
  "parameterMap" : {
    "signatureMethod" : "SIGNATURE_IMAGE",
    "signatureData" : "iVBORw0KGgoAAAANSUhEUgAAABAAAAAQCAYAAAAf8/9hAAAABGdBTUEAALGPC/xhBQAAAAlwSFlzAAAOwQAADsEBuJFr7QAAABp0RVh0U29mdHdhcmUAUGFpbnQuTkVUIHYzLjUuMTAw9HKhAAACFElEQVQ4T2P4//8/RRirICkYQqCBZcli4ndaZBdx84hNEBXWeiwpavBRgF9hJw+PWAQHl4AQVBkEIBvwf748x6semQ03m2WeuuobfNdQ8PuvoxQKx4pS9v/FhLV3cnDx20C1oBrwvl926vMu2W8uerYoGpGxpoL/fykxk9ss7OwBYE0wA75Mkff6NFH2p7mG419sGpGxlmLQf3ERnSdCAkoiYANATv8+RfbTtBzrN9u3HPv/6eMXoDBucOvGw/+lhd3/JUT0KsEGfJ0qq/Btitw3Q33X/z4u+f9jQmv/J0U14sSJkQ3/48Pr/vPzyUwBG/Btkmzit8myr9eu2Qw2nRjw5cu3/4ICijMhLpgsK/99stxXZwun/+H+Ff9Tolv/p8d348QgF8QCXSkkqDwbbAAwAIW/TZH9OCfX4sPKpbv+f/jwGWwLLvDk8av/s2cu/w9MH/1gA0Dg6zRZv48T5X476Lr+A4W0uVbWfxv9kv+2BmVgbGNQ8t9ar/C/nnLUf23F4P/S4ibPlWSc9OEGgMDrPrn5D9oVvhqpuAKjK+y/mVY60JBSsAGWOvn/DVXjwOlAWszkORe3cDjQIkYUA0DR+bRLZtWlOvknGvLG30ApUV8l+r+Basx/XaXw/0rSTsCUqHmYjYM3CKoFNSXCwMV6aYtnXbJ7YXkBGN//QXmBl1cCmBf4RYCpkAmqFGIA+fg/AwCZ6BVJfDQT8QAAAABJRU5ErkJggg==",
  "signatureImageEncoding" : "PNG"
  }
}

IFA Type Confirm Contact Information (CA)
Example 
	
PUT /restapi/members/test123/ifas/193688 HTTP/1.1
Content-Type: application/json

{
  "action" : "A",
  "parameterMap" : {
    "homePhoneNumber" : "7030000000",
    "workPhoneNumber" : "7030000000",
    "emailAddress1" : "test@test.com",
    "homeAddress" : "{\"city\":\"McLean\",\"country\":\"US\",\"line1\":\"8180 Greensboro Dr.\",\"state\":\"VA\",\"zipcode\":\"22102\"}"
  }
}

Error Codes

Code Description
1001 Field cannot be null.
1003 Invalid field value.
9101 Invalid signature method.
9102 Missing signature data.
9103 Missing document data.
9104 Missing signature image encode.
9105 Invalid address field value.
9106 Invalid email address.
9107 Invalid phone number.
9108 Invalid uploaded document.
9109 Invalid status value.
9110 Invalid member Id.
9111 Invalid signature data.
9112 Invalid uploaded document file name.
9113 Invalid action value.
9114 Invalid IFA state transition.
9115 Missing uploaded document file name.
9116 Invalid signature image encode.
9117 Invalid microdeposit amount.

Change Log

11/24/2017

  1. Added new Error Code.

03/24/2017

  1. Updated Error Codes
  2. Updated allowed action type value for different item for attention type.
  3. Modified description for error code 9113 and 9114.

03/03/2017

  1. Updated Request Data Fields.
  2. Updated Item for Attention Type and Request Conditionally Required Fields, Required/Optional Parameters
  3. Updated Handle Item for Attention Request Examples
  4. Updated Error Codes

12/16/2016

  1. Modified API descriptions.
  2. Provide request examples for all IFA types.

12/02/2016

  1. Created page.

Getting Started

Quick Start Guide

REST APIs

Account Service
Alert Service
Corporate Actions Service
Deposit & Withdrawal Service
Download Service
Firm Service
Folio and Trade Service
Member Service
Model Service
Performance Service
Private Placement Service
Reporting Service
Securities Service
Transfer Service
Upload Service

Resources

Terms and Codes
Utils