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

Owner Verify a Bank Link

This request completes the owner verification of previously created Bank Link.


Request URL

Syntax POST /restapi/accounts/{accountnumber}/verify/{banklinkoid}/ownerverification
Example URL https://api.uat.foliofn.com/restapi/accounts/RA1234567C05/verify/1801439852949494402/ownerverification

Request Data Fields

Field Type Description Required Value
loginId String A unique ID for the member which has been generated when the member is initially created. Yes
clientAgreement Boolean Accept or Reject the specified bank link.
If Bank Link is rejected, signature information is not required.
Default value is “true” which mean Bank Link accepted.
No.
  • true (default value)
  • false
signatureImageEncoding String The type of encoding use for the signature data. Only if Bank Link is accepted (i.e. clientAgreement = “true”).
  • SVG (preferred)
  • GIF
  • JPG
  • PNG
signatureData String Signature information encoded in Base 64. Only if Bank Link is accepted (i.e. clientAgreement = “true”).

Request Example


POST http://api.uat.foliofn.com/restapi/accounts/RD8652100H/verify/3746994891973549674/ownerverification HTTP/1.1
Content-Type: application/json
{
    "loginId" : "adfadsfadsfas",
    "clientAgreement" : "true",
    "signatureImageEncoding" : "SVG",
    "signatureData" : "?image content encoded in Base64?"
}


Response Example


HTTP/1.1 200 OK
Date: XXX
Location: http://api.uat.foliofn.com/restapi/accounts/RD8652100H/verify/3746994891973549674/ownerverification
Content-Length: 0


Error Codes

HTTP Code Status Field Code Description
403 The specified user is not allowed to use this request.
400 loginId cannot.be.null The loginId is null.
400 loginId loginId.not.found The loginId is unknown.
400 bankLinkOid cannot.be.null The bankLinkOid is null.
400 bankLinkOid allows.only.digits The bankLinkOid is not a number.
400 bankLinkOid invalid.value The bankLinkOid specified on the URL is different from the one specified on the body request.
400 bankLinkOid banklink.not.found The bankLinkOid is unknown.
400 banklinkOid banklink.missing.or.wrong.state The specified bank link is not active (deleted or expired).
400 banklinkOid banklink.not.owned.by.account The specified bank link does not belong to the specified account.
400 banklinkOid banklink.wrong.status.for.cancel The specified bank link cannot be deleted (open transaction). Only if clientAgreement is false.
400 banklinkOid banklink.ownerverification.status.cannot.be.null The specified bank link has no verification status.
400 banklinkOid banklink.ownerverification.status.invalid The specified bank link has invalid owner verification status.
400 signatureImageEncoding cannot.be.null The signatureImageEncoding is null.
400 signatureImageEncoding cannot.be.empty The signatureImageEncoding is empty.
400 signatureImageEncoding invalid.value The signatureImageEncoding has invalid value: GIF, JPG, PNG or SVG.
400 signatureData cannot.be.null The signatureData is null.
400 signatureData cannot.be.empty The signatureData is empty.
400 signatureData invalid.value The signatureData is not correctly encoded.

Change Log

07/08/2016

  1. Updated Error Codes

06/24/2016

  1. Updated right side menu

03/11/2016

  1. Add more details about the “clientAgreement” behavior.

11/13/2015

  1. New documentation.

Getting Started

REST APIs

Resources

Developer Home