Sample API Requests and Responses
Provider Accounts
Sample Input:
Json
{
"loginForm": {
"row": [{
"field": [{
"id": 65499,
"value": "ysl"
}]
},
{
"field": [{
"id": 65500,
"value": "ysl"
}]
}
]
}
}
Json
{
"loginForm": {
"row": [{
"field": [{
"id": 12,
"value": "DAPI16441"
}]
},
{
"field": [{
"id": 13,
"value": "Site417"
}]
}
]
},
"dataset": [{
"name": "BASIC_AGG_DATA",
"attribute": [{
"name": "ACCOUNT_DETAILS",
"container": ["bank"]
}]
},
{
"name": "ACCT_PROFILE",
"attribute": [{
"name": "FULL_ACCT_NUMBER",
"container": ["bank"]
}]
}
],
"preferences":{
"isDataExtractsEnabled":true,
"isAutoRefreshEnabled":true
}
}
Json
{
"loginForm": {
"row": [{
"field": [{
"id": 12,
"value": "DAPI16441"
}]
},
{
"field": [{
"id": 13,
"value": "Site417"
}]
}
]
},
"datasetName": ["BASIC_AGG_DATA","ACCT_PROFILE"]
}
Json
{
"consentId":10005000,
"field":[
{
"id":"authorizationCode",
"value":"78beb342-e998-4e3a-bd7a-4eb9aa270e7b"
},
{
"id":"idToken",
"value":"dfdsf88sdfd"
}
],
"preferences":{
"isAutoRefreshEnabled":true,
"isDataExtractsEnabled":true,
"linkedProviderAccountId":1234567
}
}
Json
{
"consentId":"{{consentId}}",
"field":[
{
"id":"authResponse",
"value":"{\"code\":\"628f8f7a-00f4-4688-a2ed-17e3a91b18ee\"}"
}
]
}
Json
{
"providerAccount": [{
"id": 10968905,
"aggregationSource": "USER",
"status": "LOGIN_IN_PROGRESS",
"requestId": "aForA9hDJ1jM00vsVzQc4I/e1xo=",
"dataset": [{
"name": "ACCT_PROFILE",
"updateEligibility": "DISALLOW_UPDATE"
},
{
"name": "BASIC_AGG_DATA",
"updateEligibility": "DISALLOW_UPDATE"
}
]
}]
}
Sample Input:
Json
{
"loginForm": {
"row": [{
"field": [{
"id": 12,
"value": "DZD2383"
}]
},
{
"field": [{
"id": 13,
"value": "REZ8983"
}]
}
]
},
"dataset": [{
"name": "BASIC_AGG_DATA",
"attribute": [{
"name": "ACCOUNT_DETAILS",
"container": ["bank"]
}]
},
{
"name": "ACCT_PROFILE",
"attribute": [{
"name": "FULL_ACCT_NUMBER",
"container": ["bank"]
}]
},
{
"name": "DOCUMENT",
"attribute": [{
"name": "TAX",
"container": [
"bank"
]
}]
}
],
"preferences":{
"isDataExtractsEnabled":true,
"isAutoRefreshEnabled":true
}
}
Json
{
"loginForm": {
"row": [{
"field": [{
"id": 12,
"value": "DZD2383"
}]
},
{
"field": [{
"id": 13,
"value": "REZ8983"
}]
}
]
},
"datasetName": ["BASIC_AGG_DATA","ACCT_PROFILE"]
}
Json
{
"consentId": "10003800",
"field": [
{
"id": "authorizationCode",
"value": "c8495f72-8e91-48e8-873f-6df1cc42d512"
}
]
}
Json
{
"consentId":"{{consentId}}",
"field":[
{
"id":"authResponse",
"value":"{\"code\":\"628f8f7a-00f4-4688-a2ed-17e3a91b18ee\"}"
}
]
}
Sample Responses:
Json
{
"providerAccount":[
{
"id":10968905,
"aggregationSource":"USER",
"providerId":5,
"isManual":false,
"createdDate":"2017-09-07",
"status":"LOGIN_IN_PROGRESS",
"requestId":"g2yE1F0LsdCg0P4Hmq7FVT3PdLY=",
"dataset":[
{
"name":"ACCT_PROFILE",
"updateEligibility":"DISALLOW_UPDATE",
"lastUpdated":"2017-09-07T06:19:18Z",
"lastUpdateAttempt":"2017-09-07T06:19:18Z"
},
{
"name":"BASIC_AGG_DATA",
"updateEligibility":"DISALLOW_UPDATE",
"lastUpdated":"2017-09-07T06:19:18Z",
"lastUpdateAttempt":"2017-09-07T06:19:18Z"
},
{
"name":"DOCUMENT",
"updateEligibility":"DISALLOW_UPDATE"
}
]
}
]
}
Json
{
"providerAccount":[
{
"id":11427004,
"aggregationSource":"USER",
"providerId":29823,
"isManual":false,
"createdDate":"2020-08-10T09:04:56Z",
"status":"MIGRATION_IN_PROGRESS",
"oauthMigrationStatus":"IN_PROGRESS",
"requestId":"Vn26pAe+AKU0RaWDJ9jUKvYYc3Y=",
"dataset":[
{
"name":"BASIC_AGG_DATA",
"additionalStatus":"MIGRATION_IN_PROGRESS",
"updateEligibility":"DISALLOW_REFRESH",
"lastUpdated":"2020-08-10T09:05:25Z",
"lastUpdateAttempt":"2020-08-10T09:05:25Z"
}
]
}
]
}
Accounts
Sample Input:
GET /accounts/associatedAccounts/{providerAccountId}
Sample Response:
Json
{
"account":[
{
"CONTAINER":"creditCard",
"lastUpdated":"2020-07-31T06:59:29Z",
"id":12720550,
"accountName":"Dag Credit Card",
"accountNumber":"xxxx9806",
"providerName":"USOBTest2",
"accountType":"CREDIT",
"providerId":"29816",
"providerAccountId":11413351,
"minimumAmountDue":{
"amount":355.00,
"currency":"USD"
},
"runningBalance":{
"amount":20022.86,
"currency":"USD"
},
"balance":{
"amount":20022.86,
"currency":"USD"
},
"amountDue":{
"amount":17741.30,
"currency":"USD"
}
},
{
"CONTAINER":"bank",
"lastUpdated":"2020-08-09T00:21:37Z",
"id":12720546,
"accountName":"TESTDATA",
"accountNumber":"xxxx3xxx",
"providerName":"USOBTest1",
"accountType":"CHECKING",
"providerId":"29817",
"providerAccountId":11413350,
"availableBalance":{
"amount":54.78,
"currency":"USD"
},
"balance":{
"amount":44.78,
"currency":"USD"
},
"currentBalance":{
"amount":44.78,
"currency":"USD"
}
}
]
}
Sample Input:
PUT /accounts/migrateAccounts/{providerAccountId}
Sample Response:
Json
{
"providerAccountId":11413350, // Primary provider Account ID
"providerId":29823
}
Institutions
Sample Input:
name: FI Bank
Sample Response:
Json
{
"institution":[
{
"PRIORITY":"SEARCH",
"id":3518,
"name":"First Bank(MO)",
"loginUrl": "https://www.fisite.com/",
"baseUrl": "https://www.fisite.com/",
"favicon": "https://yodlee.vo.llnwd.net/v1/FAVICON/FAV_5.PNG",
"logo": "https://yodlee.vo.llnwd.net/v1/LOGO/LOGO_5_1_2.SVG",
"languageISOCode":"EN",
"primaryLanguageISOCode":"EN",
"countryISOCode":"US",
"lastModified":"2019-03-29T08:03:00Z",
"isAddedByUser":"false",
"providerId":[
3518,
3587
]
}
]
}
Consents
Sample Input:
Json
{
"providerId": 24016,
"applicationName": "IQBankApp",
"dataset": [{
"name": "ACCT_PROFILE",
"attribute": [{
"name": "FULL_ACCT_NUMBER",
"container": ["bank",
"loan",
"investment"]
},
{
"name": "BANK_TRANSFER_CODE",
"container": ["bank",
"loan",
"investment"]
},
{
"name": "HOLDER_NAME",
"container": ["bank",
"creditCard",
"loan",
"investment"]
}]
}]
}
Sample Response:
Json
{
"consent":{
"consentId":1000100,
"title": "Data you will be sharing",
"titleBody": "To provide this service, IQBankApp needs you to confirm your consent to access the following information for your your account to Modelo bank.",
"scope":[
{
"scopeId":"ACCOUNT_DETAILS",
"title":"Your Account Details",
"titleBody":[
"Your account name",
"Your account balance"
],
"datasetAttributes":[
"BASIC_AGG_DATA.BASIC_ACCOUNT_INFO",
"BASIC_AGG_DATA.ACCOUNT_DETAILS",
"ACCT_PROFILE.HOLDER_NAME",
"ACCT_PROFILE.FULL_ACCT_NUMBER",
"ACCT_PROFILE.BANK_TRANSFER_CODE"
]
},
{
"scopeId":"TRANSACTION_DETAILS",
"title":"Your Account Transactions for the Last ",
"titleBody":[
"Your account credits",
"Your account debits"
],
"datasetAttributes":[
"BASIC_AGG_DATA.TRANSACTIONS"
]
},
{
"scopeId":"STATEMENT_DETAILS",
"title":"Your Statements",
"titleBody":[
"Your account name",
"Your account balance"
],
"datasetAttributes":[
"BASIC_AGG_DATA.STATEMENTS"
]
},
{
"scopeId":"CONTACT_DETAILS",
"title":"Your Contact details",
"titleBody":[
"Your phone number",
"Your address"
],
"datasetAttributes":[
"ACCT_PROFILE.HOLDER_DETAILS"
]
}
],
"expirationDate":"2019-06-11",
"dataAccessFrequency":"ONE_TIME",
"consentStatus":"ACTIVE",
"providerAccountId":1000345,
"providerId":24016
}
}
Sample Input:
{
"scopeId":[
"ACCOUNT_DETAILS",
"ACCOUNT_TRANSACTIONS"
]
}
Sample Response:
Json
{
"consent":{
"providerId":24016,
"consentId":1000100,
"authorizationUrl":"https://modelobankauth2018.o3bank.co.uk:4101/auth?request=eyJhbGciOiJub25lIn0.eyJpc3MiOiJmN2FhYWNkNi0wZGMyLTRlZWUtYmM5Mi05N2U0MWEwMjM5N2QiLCJhdWQiOiJodHRwczovL21vZGVsb2JhbmthdXRoMjAxOC5vM2JhbmsuY28udWs6NDEwMSIsInNjb3BlIjoib3BlbmlkIGFjY291bnRzIiwiY2xhaW1zIjp7ImlkX3Rva2VuIjp7ImFjciI6eyJ2YWx1ZXMiOlsidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwidXJuOm9wZW5iYW5raW5nOnBzZDI6Y2EiXSwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYXJxLWVmZTVhY2I3LTU3NjctNDMxMC1hMDU3LTAxZGYyYzMzOGFhNyIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhcnEtZWZlNWFjYjctNTc2Ny00MzEwLWEwNTctMDFkZjJjMzM4YWE3IiwiZXNzZW50aWFsIjp0cnVlfX19LCJzdWIiOiJmN2FhYWNkNi0wZGMyLTRlZWUtYmM5Mi05N2U0MWEwMjM5N2QiLCJqdGkiOiJlMmIxMjk0MC1kNWJiLTRlM2YtYWMzMS0zOGY0ZmQwZjI2ZjgiLCJleHAiOjE1NTIzNDkzNTQsImlhdCI6MTU1MjMxMzM1NH0.&response_type=code+id_token&redirect_uri=%24redirect_uri&client_id=f7aaacd6-0dc2-4eee-bc92-97e41a02397d&scope=accounts+openid"
}
}
Sample Response:
Json
{
"consent":[
{
"consentId":1000100,
"title":"Data you will be sharing",
"titleBody":"To provide this service, IQBankApp needs you to confirm your consent to access the following information for your account to Modelo bank.",
"scope":[
{
"scopeId":"ACCOUNT_DETAILS",
"title":"Your Account Details",
"titleBody":[
"Your account name",
"Your account balance"
]
},
{
"scopeId":"TRANSACTION_DETAILS",
"title":"Your Account Transactions for the Last ",
"titleBody ":[
"Your account credits",
"Your account debits"
]
},
{
"scopeId":"STATEMENT_DETAILS",
"title":"Your Statements",
"titleBody":[
"Your account name",
"Your account balance"
]
},
{
"scopeId":"CONTACT_DETAILS",
"title":"Your Contact details",
"titleBody":[
"Your phone number",
"Your address"
]
}
],
"expirationDate":"2019-06-11",
"dataAccessFrequency":"ONE_TIME",
"consentStatus":"ACTIVE",
"providerAccountId":1000345,
"providerId":24016
}
]
}
Sample Response:
Json
{
"consent":{
"providerId":24016,
"consentId":1000100,
"authorizationUrl":"https://modelobankauth2018.o3bank.co.uk:4101/auth?request=eyJhbGciOiJub25lIn0.eyJpc3MiOiJmN2FhYWNkNi0wZGMyLTRlZWUtYmM5Mi05N2U0MWEwMjM5N2QiLCJhdWQiOiJodHRwczovL21vZGVsb2JhbmthdXRoMjAxOC5vM2JhbmsuY28udWs6NDEwMSIsInNjb3BlIjoib3BlbmlkIGFjY291bnRzIiwiY2xhaW1zIjp7ImlkX3Rva2VuIjp7ImFjciI6eyJ2YWx1ZXMiOlsidXJuOm9wZW5iYW5raW5nOnBzZDI6c2NhIiwidXJuOm9wZW5iYW5raW5nOnBzZDI6Y2EiXSwiZXNzZW50aWFsIjp0cnVlfSwib3BlbmJhbmtpbmdfaW50ZW50X2lkIjp7InZhbHVlIjoiYXJxLWVmZTVhY2I3LTU3NjctNDMxMC1hMDU3LTAxZGYyYzMzOGFhNyIsImVzc2VudGlhbCI6dHJ1ZX19LCJ1c2VyaW5mbyI6eyJvcGVuYmFua2luZ19pbnRlbnRfaWQiOnsidmFsdWUiOiJhcnEtZWZlNWFjYjctNTc2Ny00MzEwLWEwNTctMDFkZjJjMzM4YWE3IiwiZXNzZW50aWFsIjp0cnVlfX19LCJzdWIiOiJmN2FhYWNkNi0wZGMyLTRlZWUtYmM5Mi05N2U0MWEwMjM5N2QiLCJqdGkiOiJlMmIxMjk0MC1kNWJiLTRlM2YtYWMzMS0zOGY0ZmQwZjI2ZjgiLCJleHAiOjE1NTIzNDkzNTQsImlhdCI6MTU1MjMxMzM1NH0.&response_type=code+id_token&redirect_uri=%24redirect_uri&client_id=f7aaacd6-0dc2-4eee-bc92-97e41a02397d&scope=accounts+openid"
}
}