-
Notifications
You must be signed in to change notification settings - Fork 7
/
Copy pathswagger.yaml
12846 lines (12846 loc) · 664 KB
/
swagger.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
---
basePath: "/"
paths:
/transactions:
get:
summary: "Get Transactions"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The Transaction service is used to get a list of transactions for a user.<br>By default, this service returns the last 30 days of transactions from today's date.<br>API will only return up to 2 years of transaction history. If the difference between fromDate and toDate is more than 2 years, API will return only last 2 years from the toDate.<br>The keyword parameter performs a contains search on the original, consumer, and simple description attributes, replace the special characters #, &, and + with percent-encoding values %23, %26, and %2B respectively. Eg: for -Debit# , pass the input as -Debit%23.<br>Values for categoryId parameter can be fetched from get transaction category list service.<br> The categoryId is used to filter transactions based on system-defined category as well as user-defined category.<br>User-defined categoryIds should be provided in the filter with the prefix ''U''. E.g. U10002<br>The skip and top parameters are used for pagination. In the skip and top parameters pass the number of records to be skipped and retrieved, respectively. The response header provides the links to retrieve the next and previous set of transactions.<br>Double quotes in the merchant name will be prefixed by backslashes (\) in the response, e.g. Toys \"R\" Us. <br>sourceId is a unique ID that the provider site has assigned to the transaction. The source ID is only available for the pre-populated accounts. Pre-populated accounts are the accounts that the FI customers shares with Yodlee, so that the user does not have to add or aggregate those accounts.<br><br><b>Note</b><ul><li><a href=\"https://developer.envestnet.com/resources/yodlee/transaction-data-enrichment/docs/overview\">Transaction Data Enrichment</a> is made available for bank and card accounts. The address field in the response is available only when the Transaction Data Enrichment key is turned ON.</li><li>The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 transactions.</li><li>This service supports the localization feature and accepts locale as a header parameter.</li></ul>"
operationId: "getTransactions"
responses:
200:
schema:
$ref: "#/definitions/TransactionResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for baseType<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for category<br>Y800 : Invalid value for toDate<br>Y800 : Invalid value for container<br>Y809 : Invalid date range<br>Y804 : Permitted values of top between 1 - 500<br>Y805 : Multiple containers not supported<br>Y800 : Invalid value for transaction type<br>Y824 : The maximum number of accountIds permitted is 100<br>Y824 : The maximum number of categoryIds permitted is 100<br>Y824 : The maximum number of highLevelCategoryIds permitted is 100<br>Y848 : detailCategoryId cannot be provided as input, as the detailedCategory feature is not enabled<br>Y823 : detailCategoryId is not for applicable containers other than bank and card<br>Y824 : The maximum number of detailCategoryIds permitted is 100<br>Y800 : Invalid value for detailCategoryId<br>Y800 : Invalid value for convertToCurrency<br>Y820 : The currency value is not supported for convertToCurrency<br>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "Comma separated accountIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "baseType"
description: "DEBIT/CREDIT"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryId"
description: "Comma separated categoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "categoryType"
description: "Transaction Category Type(LOAN, UNCATEGORIZE, INCOME, TRANSFER, EXPENSE or DEFERRED_COMPENSATION)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "container"
description: "bank/creditCard/investment/insurance/loan"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "convertToCurrency"
description: "On-demand currency conversion parameter"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "detailCategoryId"
description: "Comma separated detailCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "Transaction from date(YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "highLevelCategoryId"
description: "Comma separated highLevelCategoryIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "keyword"
description: "Transaction search text"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "Transaction end date (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "type"
description: "Transaction Type(SELL,SWEEP, etc.) for bank/creditCard/investment"
type: "string"
required: false
tags:
- "Transactions"
/accounts/associatedAccounts/{providerAccountId}:
get:
summary: "Associated Accounts"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "Yodlee classifies providers into credential-based aggregation and Open Banking (OB) providers.<br>This service is associated with the OB aggregation flow. As part of the OB solution, financial institutions may merge their subsidiaries and provide data as a single OB provider.<br>Before the OB solution, this data was aggregated with different provider IDs.<br>This service accepts the providerAccountId and returns all accounts of the associated providerAccounts that belong to the subsidiary of the financial institution.<br>This data should be displayed to the user to let them select the accounts that they wish to provide consent to share account data.<br>"
operationId: "getAssociatedAccounts"
responses:
200:
schema:
$ref: "#/definitions/AssociatedAccountsResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for providerAccountId<br>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "providerAccountId"
format: "int64"
description: "providerAccountId"
type: "integer"
required: true
tags:
- "Accounts"
/verification/verifiedAccounts:
get:
summary: "Get Verified Accounts"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The Verified Accounts API v1.1 provides information about the bank and investment accounts that the user has selected for verification, during the Account Verification flow on FastLink 4. By default, the API only returns information of the accounts that were selected and have been successfully verified. <br><br>"
operationId: "getVerifiedAccounts"
responses:
200:
schema:
$ref: "#/definitions/VerifiedAccountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y813 : providerAccountId should be provided<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for verificationStatus<br>Y800 : Invalid value for isSelected<br>Y800 : Invalid value for accountId<br>Y807 : Resource not found<br>Y871 : The verification process for the request is still in progress. This API can only be invoked after the verification process is completed<br>Y824 : The maximum number of accountIds permitted is 10"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "Comma separated accountIds."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "isSelected"
description: "Comma separated isSelected. Allowed values are true, false. <br>"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "providerAccountId"
description: "providerAccountId."
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "verificationStatus"
description: "Comma separated verificationStatus. Allowed values are SUCCESS, FAILED <br><b>Note:</b> If no value is passed, the implicit default value is SUCCESS."
type: "string"
required: false
tags:
- "Verification"
/cobrand/login:
post:
summary: "Cobrand Login"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The cobrand login service authenticates a cobrand.<br>Cobrand session in the response includes the cobrand session token (cobSession) <br>which is used in subsequent API calls like registering or signing in the user. <br>The idle timeout for a cobrand session is 2 hours and the absolute timeout is 24 hours. This service can be <br>invoked to create a new cobrand session token. <br><b>Note:</b> This endpoint is deprecated for customers using the API Key-based authentication and is applicable only to customers who use the SAML-based authentication.<br>The content type has to be passed as application/json for the body parameter. <br>"
operationId: "cobrandLogin"
responses:
200:
schema:
$ref: "#/definitions/CobrandLoginResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for cobrandParam"
401:
schema:
$ref: "#/definitions/YodleeError"
description: "Y003 : Account is locked, contact Yodlee customer care<br>Y001 : User name and password required"
404:
description: "Not Found"
parameters:
- schema:
$ref: "#/definitions/CobrandLoginRequest"
in: "body"
name: "cobrandLoginRequest"
description: "cobrandLoginRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
/dataExtracts/userData:
get:
summary: "Get userData"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get user data service is used to get a user's modified data for a particular period of time for accounts, transactions, holdings, and provider account information.<br>The time difference between fromDate and toDate fields cannot be more than 60 minutes.<br>By default, pagination is available for the transaction entity in this API. In the first response, the API will retrieve 500 transactions along with other data. The response header will provide a link to retrieve the next set of transactions.<br>In the response body of the first API response, totalTransactionsCount indicates the total number of transactions the API will retrieve for the user.<br>This service is only invoked with either admin access token or a cobrand session.<br/>Refer to <a href=\"https://developer.envestnet.com/resources/yodlee/data-extracts/docs/overview\">dataExtracts</a> page for more information.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.</li>"
operationId: "getDataExtractsUserData"
responses:
200:
schema:
$ref: "#/definitions/DataExtractsUserDataResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for eventName<br>Y821 : Data update event not supported<br>Y800 : Invalid value for fromDate.fromDate cannot be greater than current time<br>Y800 : Invalid value for toDate.toDate cannot be greater than current time<br>.Y800 : Invalid value for fromDate or toDate.fromDate and toDate cannot be older than 7 days<br>Y800 : Invalid value for fromDate.fromDate can not be greater than toDate<br>Y800 : Invalid value for loginName"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "From DateTime (YYYY-MM-DDThh:mm:ssZ)"
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "loginName"
description: "Login Name"
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "To DateTime (YYYY-MM-DDThh:mm:ssZ)"
type: "string"
required: true
tags:
- "DataExtracts"
/providers:
get:
summary: "Get Providers"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get provider service is used to get all the providers that are enabled, search a provider service by name or routing number and get popular sites of a region. <br>Searching for a provider using a routing number is applicable only to the USA and Canada regions.<br>The valid values for priority are: <br> 1. cobrand: Returns providers enabled for the cobrand (Default priority)<br> 2. popular: Returns providers popular among users of the customer<br><br>Only the datasets, attributes, and containers that are enabled for the customer will be returned in the response.<br>Input for the dataset$filter should adhere to the following expression:<br><dataset.name>[<attribute.name>.container[<container> OR <container>] OR <attribute.name>.container[<container>]] <br>OR <dataset.name>[<attribute.name> OR <attribute.name>]<br><b>dataset$filter value examples:</b><br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank OR investment OR creditCard]]<br>ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA[ACCOUNT_DETAILS.container[bank OR investment] OR HOLDINGS.container[bank]] OR ACCT_PROFILE[FULL_ACCT_NUMBER.container[bank]]<br>BASIC_AGG_DATA<br>BASIC_AGG_DATA OR ACCT_PROFILE<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS OR HOLDINGS ]<br>BASIC_AGG_DATA [ ACCOUNT_DETAILS] OR DOCUMENT <br>BASIC_AGG_DATA [ BASIC_ACCOUNT_INFO OR ACCOUNT_DETAILS ] <br><br>The fullAcountNumberFields is specified to filter the providers that have paymentAccountNumber or unmaskedAccountNumber support in the FULL_ACCT_NUMBER dataset attribute.<br><b>Examples for usage of fullAccountNumberFields </b><br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=paymentAccountNumber<br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber<br>dataset$filter=ACCT_PROFILE[ FULL_ACCT_NUMBER.container [ bank ]] & fullAccountNumberFields=unmaskedAccountNumber,paymentAccountNumber<br><br>The skip and top parameters are used for pagination. In the skip and top parameters, pass the number of records to be skipped and retrieved, respectively.<br>The response header provides the links to retrieve the next and previous set of transactions.<br><br><b>Note:</b> <ol><li>In a product flow involving user interaction, Yodlee recommends invoking this service with filters.<li>Without filters, the service may perform slowly as it takes a few minutes to return data in the response.<li>The AuthParameter appears in the response only in case of token-based aggregation sites.<li>The pagination feature only applies when the priority parameter is set as cobrand. If no values are provided in the skip and top parameters, the API will only return the first 500 records.<li>This service supports the localization feature and accepts locale as a header parameter.<li>The capability has been deprecated in query parameter and response.</li></ol>"
operationId: "getAllProviders"
responses:
200:
schema:
$ref: "#/definitions/ProviderResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have atleast 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "capability"
description: "CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "dataset$filter"
description: "Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fullAccountNumberFields"
description: "Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "institutionId"
format: "int64"
description: "Institution Id for Single site selection"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "name"
description: "Name in minimum 1 character or routing number."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "priority"
description: "Search priority"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "providerId"
description: "Max 5 Comma seperated Provider Ids"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0) - This is not applicable along with 'name' parameter."
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500) - This is not applicable along with 'name' parameter."
type: "integer"
required: false
tags:
- "Providers"
/providers/{providerId}:
get:
summary: "Get Provider Details"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get provider detail service is used to get detailed information including the login form for a provider.<br>The response is a provider object that includes information such as name of the provider, <br>provider's base URL, a list of containers supported by the provider, the login form details of the provider, etc.<br>Only enabled datasets, attributes and containers gets returned in the response.<br><br><b>Note:</b><li>This service supports the localization feature and accepts locale as a header parameter.<li>The capability has been deprecated in the response."
operationId: "getProvider"
responses:
200:
schema:
$ref: "#/definitions/ProviderDetailResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for providerId"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "providerId"
format: "int64"
description: "providerId"
type: "integer"
required: true
tags:
- "Providers"
/cobrand/config/notifications/events/{eventName}:
post:
summary: "Subscribe Event"
deprecated: true
produces:
- "application/json;charset=UTF-8"
description: "<b>Refer POST /configs/notifications/events/{eventName}.</b><br>The subscribe events service is used to subscribe to an event for receiving notifications.<br>The callback URL, where the notification will be posted should be provided to this service.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br>Customers can subscribe to REFRESH,DATA_UPDATES and AUTO_REFRESH_UPDATES event.<br><br><b>Notes</b>:<br>This service is not available in developer sandbox/test environment and will be made available for testing in your dedicated environment, once the contract is signed.<br>The content type has to be passed as application/json for the body parameter.<br>"
operationId: "createSubscriptionEvent"
responses:
201:
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
- schema:
$ref: "#/definitions/CreateCobrandNotificationEventRequest"
in: "body"
name: "eventRequest"
description: "eventRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
delete:
summary: "Delete Subscription"
deprecated: true
produces:
- "application/json;charset=UTF-8"
description: "<b>Refer DELETE /configs/notifications/events/{eventName}.</b><br>The delete events service is used to unsubscribe from an events service.<br>"
operationId: "deleteSubscribedEvent"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
tags:
- "Cobrand"
put:
summary: "Update Subscription"
deprecated: true
produces:
- "application/json;charset=UTF-8"
description: "<b>Refer PUT /configs/notifications/events/{eventName}.</b><br>The update events service is used to update the callback URL.<br>If the callback URL is invalid or inaccessible, the subscription will be unsuccessful, and an error will be thrown.<br><b>Note:</b> The content type has to be passed as application/json for the body parameter. <br>"
operationId: "updateSubscribedEvent"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y803 : eventName required<br>Y803 : callbackUrl required<br>Y800 : Invalid value for callbackUrl"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "eventName"
description: "eventName"
type: "string"
required: true
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
- schema:
$ref: "#/definitions/UpdateCobrandNotificationEventRequest"
in: "body"
name: "eventRequest"
description: "eventRequest"
required: true
tags:
- "Cobrand"
consumes:
- "application/json"
/configs/notifications/events:
get:
summary: "Get Subscribed Notification Events"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get events service provides the list of events for which consumers subscribed to receive notifications. <br>"
operationId: "getSubscribedNotificationEvents"
responses:
200:
schema:
$ref: "#/definitions/ConfigsNotificationResponse"
description: "OK"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "eventName"
description: "Name of the webhook subscription event"
type: "string"
required: false
enum:
- "REFRESH"
- "DATA_UPDATES"
- "AUTO_REFRESH_UPDATES"
- "LATEST_BALANCE_UPDATES"
- "CREDIT_ACCELERATOR_REPORT_UPDATES"
tags:
- "Configs"
/consents/history/count:
get:
summary: "Get Consent History Count"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The count service provides the total number of history records for a specific consent. <br/>If you are implementing pagination for consent history, call this endpoint before calling GET /consents/history to know the number of records for the given consent that are returned for the input parameters passed.<br/>"
operationId: "getConsentHistoryCount"
responses:
200:
schema:
$ref: "#/definitions/ConsentHistoryCountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for consentId <br/>Y803 : consentId is required <br/>Y800 : Invalid value for fromDate<br/>Y800 : Invalid value for toDate<br/>Y809 : Invalid date range<br/>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "consentId"
description: "Consent Id generated through POST Consent."
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "Consent History from date(YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "Consent History end date (YYYY-MM-DD)"
type: "string"
required: false
tags:
- "Consents"
/providers/count:
get:
summary: "Get Providers Count"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The count service provides the total number of providers that get returned in the GET /providers depending on the input parameters passed.<br>If you are implementing pagination for providers, call this endpoint before calling GET /providers to know the number of providers that are returned for the input parameters passed.<br>The functionality of the input parameters remains the same as that of the GET /providers endpoint<br><br><b>Note:</b> <li>The capability has been deprecated in the query parameter.</li>"
operationId: "getProvidersCount"
responses:
200:
schema:
$ref: "#/definitions/ProvidersCountResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for priority<br>Y800 : Invalid value for providerName<br>Y801 : Invalid length for a site search. The search string must have at least 1 character<br>Y800 : Invalid value for skip<br>Y804 : Permitted values of top between 1 - 500<br>Y821 : Dataset not supported<br>Y820 : The additionalDataSet is not supported for Get provider API"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "capability"
description: "CHALLENGE_DEPOSIT_VERIFICATION - capability search is deprecated"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "dataset$filter"
description: "Expression to filter the providers by dataset(s) or dataset attribute(s). The default value will be the dataset or dataset attributes configured as default for the customer."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fullAccountNumberFields"
description: "Specify to filter the providers with values paymentAccountNumber,unmaskedAccountNumber."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "name"
description: "Name in minimum 1 character or routing number."
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "priority"
description: "Search priority"
type: "string"
required: false
tags:
- "Providers"
/derived/networth:
get:
summary: "Get Networth Summary"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get networth service is used to get the networth for the user.<br>If the include parameter value is passed as details then networth with historical balances is returned. <br>"
operationId: "getNetworth"
responses:
200:
schema:
$ref: "#/definitions/DerivedNetworthResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for accountIds<br>Y800 : Invalid value for fromDate<br>Y800 : Invalid value for toDate<br>Y809 : Invalid date range<br>Y800 : Invalid value for interval<br>Y802 : Future date not allowed<br>Y814 : Exchange rate not available for currency<br>Y800 : Invalid value for container"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountIds"
description: "comma separated accountIds"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "container"
description: "bank/creditCard/investment/insurance/loan/realEstate/otherAssets/otherLiabilities"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "from date for balance retrieval (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "include"
description: "details"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "interval"
description: "D-daily, W-weekly or M-monthly"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "toDate for balance retrieval (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500)"
type: "integer"
required: false
tags:
- "Derived"
/consents/history:
get:
summary: "Get Consent History "
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get consent history service is used to retrieve all the history related to the consent. <br/>All history event details for few fields like userDataPurge, deidentificationPreference and consentCollectionPeriod may not be available for older AU Open Banking consents and other Open Banking regions.<br/>For any consent, history will be captured and available from consent authorization (consent status Active) event onwards.<br/><b>Note:</b><br/> i. Duration (fromDate and toDate) is optional. In the absence of duration, one year history is retrieved from today's date.<br/>ii. The pagination feature is available by default. If no values are passed in the skip and top parameters, the API will only return the first 500 records.<br/>"
operationId: "getConsentHistory"
responses:
200:
schema:
$ref: "#/definitions/ConsentHistoryResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for consentId <br/>Y803 : consentId is required <br/>Y804 : Permitted values of top between 1 - 500<br/>Y800 : Invalid value for skip<br/>Y800 : Invalid value for fromDate<br/>Y800 : Invalid value for toDate<br/>Y809 : Invalid date range<br/>"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "consentId"
description: "Consent Id generated through POST Consent."
type: "string"
required: true
- in: "query"
allowEmptyValue: false
name: "fromDate"
description: "Consent History from date(YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "skip"
format: "int32"
description: "skip (Min 0)"
type: "integer"
required: false
- in: "query"
allowEmptyValue: false
name: "toDate"
description: "Consent History end date (YYYY-MM-DD)"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "top"
format: "int32"
description: "top (Max 500)"
type: "integer"
required: false
tags:
- "Consents"
/user/samlLogin:
post:
summary: "Saml Login"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The SAML login service is used to authenticate system users with a SAML response.<br>A new user will be created with the input provided if that user isn't already in the system.<br>For existing users, the system will make updates based on changes or new information.<br>When authentication is successful, a user session token is returned.<br><br><b>Note:</b> <li>The content type has to be passed as application/x-www-form-urlencoded. <li>issuer, source and samlResponse should be passed as body parameters.</li>"
operationId: "samlLogin"
responses:
200:
schema:
$ref: "#/definitions/UserResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y013 : Invalid value for samlResponse<br>Y013 : Invalid value for issuer"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
name: "issuer"
description: "issuer"
type: "string"
required: true
- in: "query"
name: "samlResponse"
description: "samlResponse"
type: "string"
required: true
- in: "query"
name: "source"
description: "source"
type: "string"
required: false
tags:
- "User"
consumes:
- "application/json"
/verification/holderProfile:
get:
summary: "Get Holder Profile"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The Holder Profile API service allows retrieving the user's profile details (i.e., PII data such as name, email, phone number, and address) that are available at the provider account and each account level. The API accepts the providerAccountId and retrieves the profile information available under it and all the details available under each of the associated accounts. <br><br>This service can only be invoked by Yodlee API v1.1, FastLink 3, and FastLink 4 customers. <br><br>"
operationId: "getHolderProfile"
responses:
200:
schema:
$ref: "#/definitions/HolderProfileResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y901 : Service not supported<br>Y800 : Invalid value for providerAccountId<br>Y800 : Invalid value for accountId. Only ACTIVE accountIds are supported<br>Y800 : Invalid value for accountId. All accountIds should belong to the same providerAccountId<br>Y803 : providerAccountId required<br>Y805 : Multiple providerAccountId not supported<br>Y820 : The accountId is not supported for containers other than bank and investment<br>can only be invoked after the verification process is completed<br>Y824 : The maximum number of accountIds permitted is 10<br>Y878 : Profile data is not yet requested for this account"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "query"
allowEmptyValue: false
name: "accountId"
description: "accountId"
type: "string"
required: false
- in: "query"
allowEmptyValue: false
name: "providerAccountId"
description: "providerAccountId."
type: "string"
required: true
tags:
- "Verification"
/documents/{documentId}:
get:
summary: "Download a Document"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get document details service allows consumers to download a document. The document is provided in base64.<br>This API is a premium service which requires subscription in advance to use. Please contact Yodlee Client Services for more information. <br>"
operationId: "downloadDocument"
responses:
200:
schema:
$ref: "#/definitions/DocumentDownloadResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for documentId"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "path"
name: "documentId"
description: "documentId"
type: "string"
required: true
tags:
- "Documents"
delete:
summary: "Delete Document"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The delete document service allows the consumer to delete a document. The deleted document will not be returned in the get documents API. The HTTP response code is 204 (success without content).<br>Documents can be deleted only if the document related dataset attributes are subscribed.<br>"
operationId: "deleteDocument"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for documentId<br>Y868 : No action is allowed, as the data is being migrated to the Open Banking provider<br>"
401:
description: "Unauthorized"
204:
description: "OK"
404:
description: "Not Found"
parameters:
- in: "path"
name: "documentId"
description: "documentId"
type: "string"
required: true
tags:
- "Documents"
/partner/paymentProcessor/account/holder:
get:
summary: "Get Account Holder Details"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The get account holder details service retrieves the account holder information such as name, email, phone number, address, etc. of the verified financial account associated with the <code>processorToken</code>. The <code>lastUpdated</code> field indicates when the account information was last updated. We recommend using this service when looking for information related to the account holder(s), for instance, to confirm the account holder's name. <br><br><b>Note: </b>Remember to include the <code>Authorization</code> header."
operationId: "getVerifiedAccountHolder"
responses:
200:
schema:
$ref: "#/definitions/PaymentAccountHolderResponse"
description: "OK"
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y007 : Authorization header missing<br>Y008 : Invalid token in authorization header<br>Y800 : Invalid value for processorToken<br>Y016 : processorToken header missing"
401:
description: "Unauthorized"
404:
description: "Not Found"
parameters:
- in: "header"
name: "processorToken"
description: "Token shared by customer to access financial account information."
type: "string"
required: true
tags:
- "Payment Processor"
/transactions/categories/rules/{ruleId}:
post:
summary: "Run Transaction Categorization Rule"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The run transaction categorization rule service is used to run a rule on transactions, to categorize the transactions.<br>The HTTP response code is 204 (Success with no content).<br>"
operationId: "runTransactionCategorizationRule"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for ruleId<br>Y400 : Categorization already in progress"
401:
description: "Unauthorized"
204:
description: "Run Successfully"
404:
description: "Not Found"
parameters:
- default: "run"
in: "query"
name: "action"
type: "string"
required: true
enum:
- "run"
- in: "path"
name: "ruleId"
format: "int64"
description: "Unique id of the categorization rule"
type: "integer"
required: true
tags:
- "Transactions"
consumes:
- "application/json"
delete:
summary: "Delete Transaction Categorization Rule"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The delete transaction categorization rule service is used to delete the given user-defined transaction categorization rule for both system-defined category as well as user-defined category.<br>This will delete all the corresponding rule clauses associated with the rule.<br>The HTTP response code is 204 (Success without content).<br>"
operationId: "deleteTransactionCategorizationRule"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for ruleId"
401:
description: "Unauthorized"
204:
description: "Deleted Successfully"
404:
description: "Not Found"
parameters:
- in: "path"
name: "ruleId"
format: "int64"
description: "ruleId"
type: "integer"
required: true
tags:
- "Transactions"
put:
summary: "Update Transaction Categorization Rule"
deprecated: false
produces:
- "application/json;charset=UTF-8"
description: "The update transaction categorization rule service is used to update a categorization rule for both system-defined category as well as user-defined category.<br>ruleParam JSON input should be as explained in the create transaction categorization rule service.<br>The HTTP response code is 204 (Success without content).<br>"
operationId: "updateTransactionCategorizationRule"
responses:
400:
schema:
$ref: "#/definitions/YodleeError"
description: "Y800 : Invalid value for ruleId<br>Y806 : Invalid input"
401:
description: "Unauthorized"
204:
description: "Updated Successfully"
404:
description: "Not Found"
parameters:
- in: "path"
name: "ruleId"
format: "int64"
description: "ruleId"
type: "integer"
required: true
- schema:
$ref: "#/definitions/TransactionCategorizationRuleRequest"
in: "body"
name: "transactionCategoriesRuleRequest"
description: "transactionCategoriesRuleRequest"
required: true
tags: