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

Submit a Customer Signature

This request completes the signing of the Customer Agreement.

Customer Agreement is linked to the member / account Item For Attention (IFA):

  • If a Customer Agreement’s IFA exist, this call resolves it as agreed once the signature / document is uploaded,
  • If no IFA exist, the signature / document is still uploaded.

Request URL

Syntax POST /restapi/accounts/{accountnumber}/customeragreement
Example URL https://testapi.foliofn.com/restapi/accounts/RD75953005/customeragreement

Request Data Fields

Field Required Description Type Value
loginId Yes A unique ID for the member which has been generated when the member is initially created. String
signatureData Yes Signature information encoded in Base 64. String
signatureImageEncoding Only when signatureMethod = “SIGNATURE_IMAGE” The type of encoding use to for the signature data. String
  • SVG (preferred)
  • GIF
  • JPG
  • PNG
signatureMethod Yes The method for signing the Customer Agreement. String
  • SIGNED_PDF
  • SIGNATURE_IMAGE
w9Withhold No W-9 option. Boolean
  • True
  • False

Signature Data for SIGNATURE_IMAGE

This fields carry on the image data encoded in Base64. More, the encoded data can be prefixed by a special tag, based on the type of the image (case insensitive):

  • GIF: “data:image/gif;base64,”
  • JPG: “data:image/jpg:base64,”
  • PNG: “data:image/png:base64,”

This prefix is automatically ignored when image data is decoded.

Request example for type=“SIGNATURE_IMAGE”


POST restapi/accounts/RD75953005/customeragreement HTTP/1.1
Content-Type: application/json

{
  "loginId" : "testuser01",
  "signatureImageEncoding" : "SVG",
  "signatureData" : "...image content encoded in Base64...",
  "signatureMethod" : "SIGNATURE_IMAGE"
  "w9Withhold" : "false"
}

Request example for type=“SIGNED_PDF”


POST restapi/accounts/RD75953005/customeragreement HTTP/1.1
Content-Type: application/json

{
  "loginId" : "testuser01",
  "signatureData" : "...pdf content encoded in Base64...",
  "signatureMethod" : "SIGNED_PDF",
  "w9Withhold" : "true"
}

Response Example


HTTP/1.1 200 OK
Date: Thu, 20 Aug 2015 18:08:56 GMT
Location: restapi/accounts/MD5332900O/customeragreement
Content-Length: 0



HTTP/1.1 400 Bad Request
Date: XXX
Transfer-Encoding: chunked
Content-Type: application/json

[{"type":"SYNTAX","field":"loginid","message":"Unrecognized field \"loginid\". Please check with the document."}]



HTTP/1.1 400 Bad Request
Date: XXX
Transfer-Encoding: chunked
Content-Type: application/json

[{"type":"VALIDATION_FIELD","field":"signatureMethod","errorCode":"null.signature.method"}]}]




Change Log

05/25/2017

  1. Fixed typo in Request Data Fields.

05/20/2016

  1. Add missing comma on PNG signature data prefix.

04/22/2016

  1. Add Item for Attention information.

Getting Started

REST APIs

Resources

Developer Home