<link href="//netdna.bootstrapcdn.com/bootstrap/3.0.0/css/bootstrap.min.css" rel="stylesheet" id="bootstrap-css">
<script src="//netdna.bootstrapcdn.com/bootstrap/3.0.0/js/bootstrap.min.js"></script>
<script src="//code.jquery.com/jquery-1.11.1.min.js"></script>
<!------ Include the above in your HEAD tag ---------->
<!doctype html>
<html lang="en">
<head>
<meta charset="utf-8">
<meta name="viewport" content="width=device-width, initial-scale=1">
<script>
jQuery(document).ready(function($){
$(document).ready(function() {
var $tabContent = $(".tab-pane"),
$tabs = $("ul.nav.nav-tabs li"),
tabId;
$tabContent.hide();
$("ul.nav.nav-tabs li:first").addClass("active").show();
$tabContent.first().show();
$tabs.click(function() {
var $this = $(this);
$tabs.removeClass("active");
$this.addClass("active");
$tabContent.hide();
var activeTab = $this.find("a").attr("href");
$(activeTab).fadeIn();
//return false;
});
// Grab the ID of the .tab-content that the hash is referring to
tabId = $(window.location.hash).closest('.tab-pane').attr('id');
// Find the anchor element to "click", and click it
$tabs.find('a[href=#' + tabId + ']').click();
})
$('#link a').not('.nav.nav-tabs li a').on('click', function(evt) {
evt.preventDefault();
var whereTo = $(this).attr('goto');
$tabs = $("ul.nav.nav-tabs li");
$tabs.find('a[href=#' + whereTo + ']').trigger('click');
//alert(attr('name'));
//alert( $('#'+whereTo+' a').offset().top );
$('html, body').animate({
scrollTop: $('#'+whereTo+' a').offset().top
},4000);
});
$(function() {
$('a.refresh').live("click", function() {
location.reload();
});
});
});</script>
<script>
/* $(document).ready(function(){
$('#Providers').dataTable({ paging: false});
});*/
</script>
</script>
<script>
function myFunction() {
var input, filter, table, tr, td, i;
input = document.getElementById("myInput");
filter = input.value.toUpperCase();
table = document.getElementById("Providers");
tr = table.getElementsByTagName("tr");
for (i = 0; i < tr.length; i++) {
td = tr[i].getElementsByTagName("td")[0];
td1 = tr[i].getElementsByTagName("td")[1];
td2 = tr[i].getElementsByTagName("td")[2];
td3 = tr[i].getElementsByTagName("td")[3];
if (td) {
if ((td.innerHTML.toUpperCase().indexOf(filter) > -1)|| (td1.innerHTML.toUpperCase().indexOf(filter) > -1) || (td2.innerHTML.toUpperCase().indexOf(filter) > -1) || (td3.innerHTML.toUpperCase().indexOf(filter) > -1)) {
tr[i].style.display = "";
} else {
tr[i].style.display = "none";
}
}
}
}
</script>
<style>
table {
width: 100%;
}
td {
border: 1px solid black;
th: bgcolor="#B8B6B5"
}
th,tr {
color: black;
border: 1px solid black;
}
</style>
<style type="text/css">
.help-tip{
position: relative;
top: -18px;
left: 85px;
text-align: center;
background-color: #BCDBEA;
border-radius: 100%;
width: 15px;
height: 15px;
font-size: 14px;
line-height: 26px;
cursor: default;
}
.help-tip:before{
position: relative;
top:-5px;
left:-1px;
content:'i';
font-weight: bold;
color:#fff;
font-size: 12px;
}
.help-tip:hover p{
display:block;
transform-origin: 50% 50%;
-webkit-animation: fadeIn 0.3s ease-in-out;
animation: fadeIn 0.3s ease-in-out;
}
.help-tip p{
display: none;
text-align: left;
background-color: #F0F8FF;
padding: 10px;
width: 300px;
position: relative;
border-radius: 3px;
box-shadow: 1px 1px 1px rgba(0, 0, 0, 0.2);
right: -4px;
color: #777777;
font-size: 14px;
line-height: 1.4;
}
.help-tip p:before{
position: fixed;
content: '';
width:0;
height: 0;
border:1px solid transparent;
border-bottom-color:#1E2021;
right:2px;
top:-12px;
}
.help-tip p:after{
width:50%;
height:10px;
content:'';
position: relative;
top:-40px;
left:0;
}
@-webkit-keyframes fadeIn {
0% {
opacity:0;
transform: scale(0.6);
}
100% {
opacity:100%;
transform: scale(1);
}
}
table {
width: 100%;
}
td {
border: 1px solid black;
th: bgcolor="#B8B6B5"
}
th {
background-color: #E5E7E9;
color: black;
border: 1px solid black;
}
#myInput {
padding:5px;
background-image: url('/css/searchicon.png');
background-position: 10px 10px;
background-repeat: no-repeat;
width: 30%;
font-size: 15px;
padding: 8px 15px 8px 20px;
-webkit-border-radius: 14px;
-moz-border-radius: 8px;
border: 1px solid #ddd;
margin-bottom: 12px;
float: right;
}
</style>
</head>
<body>
<h2>Data Model</h2>
<p>The Envestnet | Yodlee Data Model explains the details of the entities that are provided in the response of Yodlee APIs. This helps you define the entities to read the payload returned by our services. Here you can view the supported list of attributes, their data types and the valid set of values for an attribute.
</p>
<div class="tabs">
<ul class="nav nav-tabs">
<li class="active"><a data-toggle="tab" href="#Entities">Entities</a></li>
<li><a data-toggle="tab" href="#Enums">Enums</a></li>
</ul>
<div class="tab-content">
<div class="tab-pane active" id="Entities">
<font size ="5">Entity: provider </font> <align = "right"><input type="text" id="myInput" onkeyup="myFunction()" placeholder="Search in Provider" title="Search in provder" onkeyup="myFunction()">
<table table class="table table-striped" id="Providers" >
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td >id </td>
<td >long</td>
<td >Unique identifier for the provider site.<br>(e.g. FI sites, biller sites, lender sites, etc.).</td>
<td >GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">name </td>
<td width="124">string</td>
<td width="320">The name of a provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">loginURL </td>
<td width="124">string</td>
<td width="320">The login URL of the provider's site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">baseURL </td>
<td width="124">string</td>
<td width="320">The base URL of the provider's site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">favicon </td>
<td width="124">string</td>
<td>Favicon link of the provider.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">logo</td>
<td width="124">string</td>
<td>The logo link of the provider institution. The link will return logo in the PNG format.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">status</td>
<td width="124">string</td>
<td width="320">Determines if the provider is supported for the cobrand, provide site is in the beta stage, etc. <br /><div id="link"> <strong>Valid Values:</strong><a href="#Provider_Status" goto="Enums"> Provider Status</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">containerNames</td>
<td width="124">string</td>
<td width="320">The containerNames attribute name is a dynamic value that is rendered depending on the containers supported for the site and enabled for the customer.<br /><div id="link"> <strong>Valid Values:</strong><a href="#container" goto="Enums"> Container</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">mfaType</td>
<td width="124">string</td>
<td width="320">Determines the type of multifactor authentication required to log in to the provider site.<br /> <div id="link"><strong>Valid Values: </strong><a href="#Provider_MFA_Type" goto="Enums">Provider MFA Type</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">help </td>
<td width="124">string</td>
<td width="320">Help text to guide the user to choose the correct provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180"><a href="#loginForm">loginForm</a></td>
<td width="124">entity</td>
<td width="320">This entity represents the structure of login or MFA form that is displayed to the user in the provider site. For performance reasons, this field is returned only when a single provider is requested in the request.</td>
<td width="257">GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">oAuthSite </td>
<td width="124">string/ boolean</td>
<td width="320">Determines if the provider supports OAuth based aggregation. Such sites can only be refreshed with permissions and tokens provided by the provider.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">lastModified </td>
<td width="124">dateTime</td>
<td width="320">Determines when the provider information was updated by Yodlee. If the customer caches the data, the cache is recommended to be refreshed based on this field.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">loginHelp</td>
<td width="124">string</td>
<td width="320">Help content to guide the user during the account addition process.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">primaryLanguageISOCode </td>
<td width="124">string</td>
<td width="320">The primary language of the site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">authType</td>
<td width="124"> </td>
<td width="320">The authentication type enabled in the provider site. <br /> <div id="link"><strong>Valid Values:</strong><a href="#Provider_Authentication_Type" goto="Enums"> Provider Authentication Type</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">languageISOCode </td>
<td width="124">string</td>
<td width="320">The language in which the provider details are provided. Example, Site supports two languages English and French. English being the primary language, the provider response will be provided in French depending on the user locale. The language follows the two letter ISO code.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">isAutoRefreshEnabled </td>
<td width="124">boolean</td>
<td width="320">Indicates if a provider site is auto refreshed.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180">numberOfTransactionDays </td>
<td width="124">integer</td>
<td width="320">Indicates the total number of days for which transactions can be fetched from a particular provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180"><a href = "#containerAttributes">containerAttributes</a></td>
<td width="124">entity</td>
<td width="320">Attributes that are supported for a site at container level. E.g. Card container supporting 90 days of transaction and bank container supporting 180 days of transactions in a provider site. </td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180"><a href = "#capability">capability</a></td>
<td width="124">entity[]</td>
<td width="320">The capabilities that are offered for a provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td width="180"><a href = "#additionalDataset">additionalDataSet</a></td>
<td width="124">entity[]</td>
<td width="320">Availability of additional data attributes like routing number, full account number, etc, in provider site apart from basic information like accounts, transaction, etc.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td>isAddedByUser</td>
<td width="124">boolean</td>
<td width="320">Indicates that the site has been added by the user atleast once.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
</tbody>
</table>
<div id = "capability"><font size ="5">Entity: capability</font></div><br>
<table table class="table table-striped" id="capability">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>name </td>
<td width="124">string</td>
<td width="322">The name of the capability supported through the provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td>container</td>
<td width="124">string[]</td>
<td width="322">The containers that are supported for the capability.<br /> <div id="link"><strong>Valid Values:</strong><a href = "#container" goto="Enums"> Container</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers.</td>
</tr>
</tbody>
</table>
<div id = "additionalDataset"><font size ="5">Entity: additionalDataset</font></div><br>
<table table class="table table-striped" id="additionalDataset">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>name </td>
<td width="124">string</td>
<td width="320">The name of the additional dataset supported in the provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td><a href= "#attribute">attribute</a></td>
<td width="124">entity[]</td>
<td width="320">The attributes that belong to the dataset.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
</tbody>
</table>
<div id = "attribute"><font size ="5">Entity: attribute</font></div><br>
<table table class="table table-striped" id="attribute">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>name</td>
<td>string</td>
<td width="320">Attributes that are supported for a dataset.<br /> <div id="link"> <strong>Valid Values:</strong><a href = "#Additional_Dataset_Attributes" goto="Enums"> Additional Dataset Attributes</a<</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
<tr>
<td>container</td>
<td>string</td>
<td width="320">Containers for which the attributes are supported.<br /><div id="link"> <strong>Valid Values:</strong><a href = "#container" goto="Enums"> Container</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
</tbody>
</table>
<div id "containerAttributes"><font size ="5">Entity: containerAttributes</font></div><br>
<table table class="table table-striped" id="containerAttributes">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td width="180"><a href = "#containerNames">containerNames</a></td>
<td width="124">entity</td>
<td width="320">The containerName is a dynamic value that is rendered depending on the containers supported for the site.<br /> <div id="link"><strong>Valid Values:</strong><a href = "#container" goto="Enums"> Container</a></div></td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
</tbody>
</table>
<div = id "containerNames"><font size ="5">Entity: containerNames</font></div><br>
<table table class="table table-striped" id="containerNames">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tr>
<td>numberOfTransactionDays</td>
<td>integer</td>
<td width="320">The number of days for which the transactions are available in the provider site.</td>
<td width="257">GET providers/{providerId}<br /> GET providers</td>
</tr>
</tbody>
</table>
<div = id "loginForm"><font size ="5">Entity: loginForm</font></div><br>
<table table class="table table-striped" id="loginForm">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>long</td>
<td width="320">The identifier of the login form.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET provider/{ProviderId}</td>
</tr>
<tr>
<td>forgetPasswordURL</td>
<td>string</td>
<td width="320">The forget password URL of the provider site.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET provider/{ProviderId}</td>
</tr>
<tr>
<td>formType</td>
<td>string</td>
<td width="320">The type of the forms on which the user information is required.<br /> <div id="link"><strong>Valid Values:</strong> <a href = "#Login_Form_Types" goto="Enums" >Login Form Types</a></div></td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET provider/{ProviderId}</td>
</tr>
<tr>
<td>help </td>
<td>string</td>
<td width="320">The help that can be displayed to the customer in the login form.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET provider/{ProviderId}</td>
</tr>
<tr>
<td><a href ="#row">row</a></td>
<td>entity[]</td>
<td width="320">This indicates one row in the form. The row will have one label. But it may have single or multiple fields.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET provider/{ProviderId}</td>
</tr>
<tr>
<td>mfaInfoTitle</td>
<td>string</td>
<td width="320">The title for the mfa information demanded from the user.This is the title displayed in the provider site.This field is applicable for mfa form types only. </td>
<td>GET providerAccounts/{providerAccountId}</td>
</tr>
<tr>
<td>mfaInfoText</td>
<td>string</td>
<td width="320">The text displayed in the provider site while requesting the mfa information from the user. This field is applicable for mfa form types only. </td>
<td>GET providerAccounts/{providerAccountId}</td>
</tr>
<tr>
<td>mfaTimeout</td>
<td>long</td>
<td width="320">The time out before which the user is expected to provide mfa information. This field is applicable for mfa form types only. This would be an useful information that could be displayed to the users. </td>
<td>GET providerAccounts/{providerAccountId}</td>
</tr>
</tbody>
</table>
<div = id "row"><font size ="5">Entity: row</font></div><br>
<table table class="table table-striped" id="row">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>id</td>
<td>long</td>
<td>Unique identifier of the row.</td>
<td width="289">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td>form</td>
<td>string</td>
<td>Form denotes the set of the fields that are related. </td>
<td width="289">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td>label</td>
<td>string</td>
<td width="320">The label text displayed for a row in the form.</td>
<td width="289">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td>fieldRowChoice</td>
<td>string</td>
<td width="320">Fields that belong to a particular choice are clubbed using this field. <br>
<strong>Recommendations: </strong>
All the field row choices label to be grouped and displayed as options to the customer. On choosing a particular choice field, we recommend displaying the fields relevant to them. First field choice could be selected by default.
</td>
<td width="289">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td><a href="#field">field</a></td>
<td>entity []</td>
<td width="320">Details of fields that belong to the row.</td>
<td width="289">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
</tbody>
</table>
<div = id "row"><font size ="5">Entity: field</font></div><br>
<table table class="table table-striped" id="field">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td width="180">id</td>
<td width="124">long</td>
<td width="320">Identifier for the field.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">name</td>
<td width="124">string</td>
<td width="320">Name for the field.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">value</td>
<td width="124">string</td>
<td width="320">Value expected from the user for the field. This will be blank and is expected to be filled and send back while submitting the login or MFA information.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180"><a href="#option">option</a></td>
<td width="124">entity []</td>
<td width="320">Provides the different values that are available for the user to choose. This field is applicable for dropdown or radio field types.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">valueEditable</td>
<td width="124">boolean</td>
<td width="320">Indicates whether the field is editable or not.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">isOptional</td>
<td width="124">boolean</td>
<td width="320">Indicates if a field is an optional field or a mandatory field.</td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">type</td>
<td width="124">string</td>
<td width="320">This indicates the display type of the field. E.g. text box, image, etc. <br /><div id="link"> <strong>Valid Values:</strong> <a href = "#fieldType" goto="Enums">Field Types</a></div></td>
<td width="257">GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td width="180">maxLength</td>
<td >integer</td>
<td >The maximum length of the login form field.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td >prefix</td>
<td >string</td>
<td >The prefix string that has to be displayed before the field value.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td >suffix</td>
<td>string</td>
<td >The suffix string that has to be displayed next to the field value.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td ><a href="#validation">validation</a></td>
<td >entity []</td>
<td ">The validation to be performed on a field.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
</tbody>
</table>
<div = id "row"><font size ="5">Entity: option</font></div><br>
<table table class="table table-striped" id="option">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td ">displayText</td>
<td >string</td>
<td >The text that is displayed to the user for that option in the provider site.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td >isSelected</td>
<td >boolean</td>
<td >The option that is selected by default in the provider site.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td >optionValue</td>
<td >string</td>
<td >The value that is associated with the option.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
</tbody>
</table>
<div = id "validation"><font size ="5">Entity: validation</font></div><br>
<table table class="table table-striped" id="validation">
<thead>
<tr>
<th width="25%"><strong>Attribute Name</strong></th>
<th width="10%"><strong>Type</strong></th>
<th width="35%"><strong>Description</strong></th>
<th width="30%"><strong>Endpoints</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>regExp</td>
<td>string</td>
<td>The regular expression provided for a field. This helps customers validating the value entered by the users.</td>
<td >GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
<tr>
<td>errorMsg</td>
<td>string</td>
<td>The error message to be thrown, if the value is not matching the regular expression.</td>
<td>GET providerAccounts/{providerAccountId}<br /> GET providers/{providerId}</td>
</tr>
</tbody>
</table>
</div>
<div class="tab-pane" id="Enums">
<a name ="Provider_Status"></a><div id = "Provider_Status"><font size ="3">Provider Status</font></div><br>
<table table class="table table-striped" id="Provider_Status">
<thead>
<tr>
<th width="30%"><strong>Status</strong></th>
<th width="70%"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>Supported</td>
<td>Indicates that the provider site is enabled for the customer.</td>
</tr>
<tr>
<td>Beta</td>
<td>Indicates that the provider site is in the beta state.</td>
</tr>
</tbody>
</table>
<a name ="Login_Form_Types"></a><div id = "Login_Form_Types"><font size ="3">Login Form Types</form></div><br>
<table table class="table table-striped" id="Login_Form_Types">
<thead>
<tr>
<th width="30%;"><strong>Form Type</strong></th>
<th width="70%;"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>login </td>
<td>The primary login form displayed in the provider site.</td>
</tr>
<tr>
<td>questionAndAnswer</td>
<td>The form requesting answers for the secret questions from the user during login.</td>
</tr>
<tr>
<td>token</td>
<td>The form requesting additional token information from the user during login.</td>
</tr>
<tr>
<td>image</td>
<td>The loginform that displays CAPTCHA for an user to enter the text during login.</td>
</tr>
</tbody>
</table>
<a name ="Provider_Authentication_Type"></a><div id = "Provider_Authentication_Type"><font size ="3">Provider Authentication Type</font></div><br>
<table table class="table table-striped" id="Provider_Authentication_Type">
<thead>
<tr>
<th width="30%;"><strong>AuthType</strong></th>
<th width="70%;"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>OAUTH </td>
<td>The site that supports open authentication.</td>
</tr>
<tr>
<td>CREDENTIALS </td>
<td>The authentication system of the site expects only credentials like userId, password, customer id, etc.</td>
</tr>
<tr>
<td>MFA CREDENTIALS</td>
<td>Multifactor authentication is implemented in the provider site.</td>
</tr>
</tbody>
</table>
<a name ="Provider_MFA_Type"></a><div id "Provider_MFA_Type"><font size ="3">Provider MFA Type</font></div><br>
<table table class="table table-striped" id="Provider_MFA_Type">
<thead>
<tr>
<th width="30%;"><strong>MFA Type</strong></th>
<th width="70%;"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>IMAGE</td>
<td>Image based authentication e.g. CAPTCHA.</td>
</tr>
<tr>
<td>MULTI LEVEL</td>
<td>Combination of token, image or security question & answers.</td>
</tr>
<tr>
<td>SECURITY QUESTION</td>
<td>Security question and answer based authentication.</td>
</tr>
<tr>
<td>TOKEN ID</td>
<td>OTP or device generating token for authentication.</td>
</tr>
</tbody>
</table>
<a name ="Additional_Dataset_Attributes"></a><div id = "Additional_Dataset_Attributes"><font size ="3">Additional Dataset Attributes</font></div><br>
<table table class="table table-striped" id="Additional_Dataset_Attributes">
<thead>
<tr>
<th width="30%;"><strong>Name</strong></th>
<th width="70%;"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>FULL ACCT NUMBER</td>
<td>Indicates that the site supports retrieving full account number.</td>
</tr>
<tr>
<td>BANK TRANSFER CODE</td>
<td>Indicates that the site supports retrieving routing number.</td>
</tr>
<tr>
<td>HOLDER NAME</td>
<td>Indicates that the site supports retrieving holder name.</td>
</tr>
</tbody>
</table>
<a name ="container"></a><div id = "container"><font size ="3">Container</font></div><br>
<table table class="table table-striped" id="container">
<thead>
<tr>
<th width="30%;"><strong>Container</strong></th>
<th width="70%;"><strong>Applicable for Aggregated/Manual Accounts </strong></th>
</tr>
</thead>
<tbody>
<tr>
<td >bank </td>
<td >both</td>
</tr>
<tr>
<td >creditCard</td>
<td >both</td>
</tr>
<tr>
<td >investment</td>
<td >both</td>
</tr>
<tr>
<td >insurance</td>
<td >both</td>
</tr>
<tr>
<td >loan</td>
<td >both</td>
</tr>
<tr>
<td >otherAssets</td>
<td >manual</td>
</tr>
<tr>
<td >otherLiabilities</td>
<td >manual</td>
</tr>
<tr>
<td >realEstate</td>
<td >manual</td>
</tr>
<tr>
<td >reward</td>
<td >both</td>
</tr>
<tr>
<td >bill</td>
<td >both</td>
</tr>
</tbody>
</table>
<a name ="fieldType"></a><div id = "fieldType"><font size ="3">Field Type</font></div><br>
<table table class="table table-striped" id="fieldType">
<thead>
<tr>
<th width="30%;"><strong>Type</strong></th>
<th width="70%;"><strong>Description</strong></th>
</tr>
</thead>
<tbody>
<tr>
<td>text</td>
<td>Field to be displayed as text box and the value has to be accepted in a clear text when the user enters the value.</td>
</tr>
<tr>
<td>password</td>
<td>Field to be displayed as text box and the value has to be accepted in a masked form when the user enters the value.</td>
</tr>
<tr>
<td>option</td>
<td>Field values to be displayed in a drop down.</td>
</tr>
<tr>
<td>checkbox</td>
<td>Field values to be displayed as check boxes.</td>
</tr>
<tr>
<td>radio</td>
<td>Field values to be displayed as radio buttons.</td>
</tr>
<tr>
<td>image</td>
<td>Field values to be displayed as image.</td>
</tr>
</tbody>
</table>
</div>
</div>
</div>
