forked from Mastercard/open-banking-us-openapi
-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathfinicity.yaml
16272 lines (15437 loc) · 554 KB
/
finicity.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
openapi: 3.0.3
info:
title: Finicity APIs
description: >-
OpenAPI specification for Finicity APIs
contact:
name: Finicity
email: [email protected]
url: 'https://www.finicity.com/contact/'
version: 1.11.3
servers:
- url: 'https://api.finicity.com'
description: Production
tags:
- name: Accounts
description: Fetch or refresh customer accounts
- name: 'Accounts (Simple)'
description: Fetch simple customer accounts
- name: App Registration
description: Register and assign apps to customers
- name: Assets
description: Download asset files
- name: Authentication
description: Generate authentication tokens and manage credentials
- name: Balance Analytics
description: Balance Analytics for businesses
- name: Bank Statements
description: Fetch account statements and generate reports asynchronously
- name: Cash Flow
description: Generate cash flow reports asynchronously
- name: Cash Flow Analytics
description: Cash Flow Analytics for business
- name: Connect 🔗
description:
Allow customers to log into their financial institutions and grant
Finicity authorization
- name: Consumers
description:
Create and manage consumers associated with customers in order to use
report services
- name: Customers
description: Enroll and manage customers
- name: Institutions
description: Search and fetch financial institutions
- name: Pay Statements
description: Upload pay statements
- name: Payments
description: Fetch ACH details and account balances
- name: Portfolios
description: Generate portfolios of the most recent reports
- name: Reports
description: Fetch generated reports when ready
- name: Third Party Access
description: Generate and manage access keys for other partners
- name: Transactions
description:
Fetch customer and account transactions and generate reports
asynchronously
- name: TxPush
description: Manage TxPush subscriptions
- name: Verify Assets
description: Generate asset reports asynchronously
- name: Verify Income and Employment
description: Generate income and employment reports asynchronously
security:
- FinicityAppKey: []
FinicityAppToken: []
paths:
/aggregation/v2/partners/authentication:
post:
tags:
- Authentication
summary: Create Access Token
description: >-
Send Partner ID and Partner Secret to the Partner Authentication service
to obtain a token for accessing Finicity APIs.
* The token is valid for two hours and is required on all calls to the
Finicity APIs
* As a best practice, use a single token for all calls. Assign a
timestamp for each token, and then check the current timestamp before
making any calls. If the token is greater than 90 minutes, generate a
new one.
* ⚠️ After five failed attempts to authenticate, your account will be
locked. Contact [[email protected]](mailto:[email protected]) to
get help resetting your account.
_Supported regions_: 
operationId: CreateToken
requestBody:
$ref: '#/components/requestBodies/CreateTokenRequest'
responses:
'200':
$ref: '#/components/responses/CreateTokenResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
security:
- FinicityAppKey: []
put:
tags:
- Authentication
summary: Modify Partner Secret
description: >-
Change the Partner Secret used to authenticate this partner.
The secret does not expire, but can be changed by calling this API. A
valid Partner Secret may contain upper and lowercase characters,
numbers, and the characters !, @, #, $, %, &, *, _, -, +. It must
include at least one number and at least one letter, and its length
should be between 12 and 255 characters.
_Supported regions_: 
operationId: ModifyPartnerSecret
requestBody:
$ref: '#/components/requestBodies/ModifyPartnerSecretRequest'
responses:
'204':
$ref: '#/components/responses/ModifyPartnerSecretResponse'
'400':
$ref: '#/components/responses/ModifyPartnerSecretBadRequestErrorResponse'
'401':
$ref: '#/components/responses/AuthenticationUnauthorizedErrorResponse'
security:
- FinicityAppKey: []
/connect/v2/generate:
post:
tags:
- Connect 🔗
summary: Generate Connect URL
description: >-
Generate a Connect 2.0 URL link to add within your own applications.
In option, use the `experience` parameter to call Connect (per session)
in the body of the request. Configure the `experience` parameter to
change the brand color, logo, icon, which credit decisioning report to
generate when the Connect application completes, and more.
Note: contact your Sales Account Team to set up the `experience`
parameter.
MVS Developers: You can pre-populate the consumer's SSN on the "Find
employment records" page at the beginning of the MVS payroll app. Pass
the SSN value for the consumer in the body of the request call.
_Supported regions_: 
operationId: GenerateConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/lite:
post:
tags:
- Connect 🔗
summary: Generate Lite Connect URL
description: >-
Connect Lite is a variation of Connect Full (`POST
/connect/v2/generate`), which has a limited set of features.
* Sign in, user's credentials, and Multi-Factor Authentication (MFA)
* No user account management
The Connect Web SDK isn't a requirement when using Connect lite.
However, if you want to use the SDK events, routes, and user events,
then you must integrate with the Connect Web SDK.
_Supported regions_: 
operationId: GenerateLiteConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateLiteConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/fix:
post:
tags:
- Connect 🔗
summary: Generate Fix Connect URL
description: >-
Use the Connect Fix API when the following conditions occur:
* The connection to the user's financial institution is lost
* The user's credentials were updated (for any number of reasons)
* The user's MFA challenge has expired
_Supported regions_: 
operationId: GenerateFixConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateFixConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
/connect/v2/send/email:
post:
tags:
- Connect 🔗
summary: Send Connect Email
description: >-
Same as Connect Full (`POST /connect/v2/generate`) but send a Connect
email to a consumer.
_Supported regions_: 
operationId: SendConnectEmail
requestBody:
$ref: '#/components/requestBodies/SendConnectEmailRequest'
responses:
'200':
$ref: '#/components/responses/SendConnectEmailResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/generate/jointBorrower:
post:
tags:
- Connect 🔗
summary: Generate Connect URL - Joint Borrower
description: >-
Same as Connect Full (`POST /connect/v2/generate`) but for joint
borrowers.
MVS prompts both the primary and joint borrower to enter each of their
financial, payroll, and paystub information in the same Connect session.
_Supported regions_: 
operationId: GenerateJointBorrowerConnectUrl
requestBody:
$ref: '#/components/requestBodies/GenerateJointBorrowerConnectUrlRequest'
responses:
'200':
$ref: '#/components/responses/GenerateJointBorrowerConnectUrlResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/connect/v2/send/email/jointBorrower:
post:
tags:
- Connect 🔗
summary: Send Connect Email - Joint Borrower
description: >-
Same as Connect Joint Borrower (`POST
/connect/v2/generate/jointBorrower`) but send a Connect email to at
least one of the joint borrower's email addresses.
When the consumer opens the email, MVS prompts both the primary and
joint borrower to enter each of their financial, payroll, and paystub
information in the same Connect session.
_Supported regions_: 
operationId: SendJointBorrowerConnectEmail
requestBody:
$ref: '#/components/requestBodies/SendJointBorrowerConnectEmailRequest'
responses:
'200':
$ref: '#/components/responses/SendConnectEmailResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/aggregation/v2/customers/testing:
post:
tags:
- Customers
summary: Add Testing Customer
description: >-
Enroll a testing customer ([Test Drive](https://signup.finicity.com/)
accounts).
For using testing customers with FinBank OAuth, you must register a test
application with your systems engineer or account manager. Then, use
that testing `applicationId` when creating testing customers.
Testing Customers can access FinBank profiles (except "FinBank Billable"
profiles), and cannot access live financial institutions.
_Supported regions_: 
operationId: AddTestingCustomer
requestBody:
$ref: '#/components/requestBodies/AddCustomerRequest'
responses:
'201':
$ref: '#/components/responses/AddCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
/aggregation/v2/customers/active:
post:
tags:
- Customers
summary: Add Customer
description: >-
Enroll an active customer, which is the actual owner of one or more
real-world accounts. This is a billable customer.
Active customers must use the "FinBank Billable" profiles for testing
purposes.
_Supported regions_: 
operationId: AddCustomer
requestBody:
$ref: '#/components/requestBodies/AddCustomerRequest'
responses:
'201':
$ref: '#/components/responses/AddCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'429':
$ref: '#/components/responses/TooManyRequestsErrorResponse'
/aggregation/v1/customers:
get:
tags:
- Customers
summary: Get Customers
description: >-
Find all customers enrolled by the current partner, where the search
text is found in the customer's username or any combination of
`firstName` and `lastName` fields. If no search text is provided, all
customers will be returned.
_Supported regions_: 
operationId: GetCustomers
parameters:
- $ref: '#/components/parameters/CustomerUsernameParameter'
- $ref: '#/components/parameters/CustomerTypeParameter'
- $ref: '#/components/parameters/CustomerSearchParameter'
- $ref: '#/components/parameters/StartParameter'
- $ref: '#/components/parameters/LimitParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomersResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'/aggregation/v1/customers/{customerId}/application':
get:
tags:
- Customers
summary: Get Customer With App Data by ID
description: >-
Retrieve a customer along with additional details about the OAuth
application.
_Supported regions_: 
operationId: GetCustomerWithAppData
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerWithAppDataResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}':
get:
tags:
- Customers
summary: Get Customer by ID
description: >-
Retrieve a customer by ID.
_Supported regions_: 
operationId: GetCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
put:
tags:
- Customers
summary: Modify Customer by ID
description: >-
Modify an enrolled customer by ID.
You must specify either `firstName`, `lastName`, or both in the request.
_Supported regions_: 
operationId: ModifyCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/ModifyCustomerRequest'
responses:
'204':
$ref: '#/components/responses/ModifyCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
delete:
tags:
- Customers
summary: Delete Customer by ID
description: >-
Completely remove a customer from the system. This will remove the
customer and all associated accounts and transactions.
⚠️ Use this service carefully! It will not pause for confirmation before
performing the operation!
_Supported regions_: 
operationId: DeleteCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/customers/{customerId}/consumer':
post:
tags:
- Consumers
summary: Create Consumer
description: >-
Create a consumer record associated with the given customer. A consumer
persists as the owner of any reports that are generated, even after the
original customer is deleted from the system.
A consumer must be created for the given customer before calling any of
the Generate Report services.
_Supported regions_: 
operationId: CreateConsumer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
requestBody:
$ref: '#/components/requestBodies/CreateConsumerRequest'
responses:
'201':
$ref: '#/components/responses/CreateConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'409':
$ref: '#/components/responses/ConflictErrorResponse'
get:
tags:
- Consumers
summary: Get Consumer For Customer
description: >-
Get the details of a consumer record by customer ID.
_Supported regions_: 
operationId: GetConsumerForCustomer
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetConsumerForCustomerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/decisioning/v1/consumers/{consumerId}':
get:
tags:
- Consumers
summary: Get Consumer by ID
description: >-
Get the details of a consumer record by consumer ID.
_Supported regions_: 
operationId: GetConsumer
parameters:
- $ref: '#/components/parameters/ConsumerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
put:
tags:
- Consumers
summary: Modify Consumer by ID
description: >-
Modify an existing consumer. All fields are required for a consumer
record, but individual fields for this call are optional because fields
that are not specified will be left unchanged.
_Supported regions_: 
operationId: ModifyConsumer
parameters:
- $ref: '#/components/parameters/ConsumerIdParameter'
requestBody:
$ref: '#/components/requestBodies/ModifyConsumerRequest'
responses:
'204':
$ref: '#/components/responses/ModifyConsumerResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts by Institution Login ID
description: >-
Get all accounts associated with the given institution login. All
accounts returned are accessible by a single set of credentials on a
single institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
post:
tags:
- Accounts
summary: Refresh Customer Accounts by Institution Login ID
description: >-
Refresh account and transaction data for all accounts associated with a
given `institutionLoginId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Because many financial institutions only post transactions once per day,
calling Refresh repeatedly is usually a waste of resources and is not
recommended.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
The recommended timeout setting for this request is 120 seconds in order
to receive a response. However, you can terminate the connection after
making the call the operation will still complete. You will have to pull
the account records to check for an updated aggregation attempt date to
know when the refresh is complete.
Note: This service is not available for all tiers of dynamic billing.
_Supported regions_: 
operationId: RefreshCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/RefreshCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts':
post:
tags:
- Accounts
summary:
Refresh Customer Accounts by Institution Login ID for Dynamic Billing
description: >-
Refresh account and transaction data for all accounts associated with a
given 'institutionLoginId` with a connection to the institution. Client
apps are not permitted to automate calls to the Refresh services. Active
accounts are automatically refreshed by Finicity once per day.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
Note: This service will be used for dynamic billing tiers ASD, AFD and
ATD.
_Supported regions_: 
operationId: RefreshCustomerAccountsByInstitutionLoginV2
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'204':
$ref: '#/components/responses/RefreshCustomerV2AccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}':
delete:
tags:
- Accounts
summary: Delete Customer Accounts by Institution Login ID
description: >-
Remove from Finicity aggregation the set of accounts matching the
institution login ID.
_Supported regions_: 
operationId: DeleteCustomerAccountsByInstitutionLogin
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerAccountsByInstitutionLoginResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/accounts/{accountId}':
get:
tags:
- Accounts
summary: Get Customer Account by ID
description: >-
Get a customer account by ID.
_Supported regions_: 
operationId: GetCustomerAccount
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}':
delete:
tags:
- Accounts
summary: Delete Customer Account by ID
description: >-
Remove the given account from Finicity aggregation.
_Supported regions_: 
operationId: DeleteCustomerAccount
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'204':
$ref: '#/components/responses/DeleteCustomerAccountResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts
description: >-
Get all accounts owned by the given customer.
_Supported regions_: 
operationId: GetCustomerAccounts
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountStatusParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
post:
tags:
- Accounts
summary: Refresh Customer Accounts
description: >-
Refresh account and transaction data for all accounts associated with
the given `customerId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Because many financial institutions only post transactions once per day,
calling Refresh repeatedly is usually a waste of resources and is not
recommended.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
The recommended timeout setting for this request is 120 seconds in order
to receive a response. However, you can terminate the connection after
making the call the operation will still complete. You will have to pull
the account records to check for an updated aggregation attempt date to
know when the refresh is complete.
Note: This service is not available for all tiers of dynamic billing.
_Supported regions_: 
operationId: RefreshCustomerAccounts
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/RefreshCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v2/customers/{customerId}/accounts':
post:
tags:
- Accounts
summary: Refresh Customer Accounts For Dynamic Billing
description: >-
Refresh account and transaction data for all accounts associated with
the given `customerId` with a connection to the institution.
Client apps are not permitted to automate calls to the Refresh services.
Active accounts are automatically refreshed by Finicity once per day.
Apps may call Refresh services for a specific customer when there is a
specific business case for the need of data that is up to date as of the
moment. Please discuss with your account manager and systems engineer
for further clarification.
Note: This service will be used for dynamic billing tiers ASD, AFD and
ATD.
_Supported regions_: 
operationId: RefreshCustomerAccountsV2
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'204':
$ref: '#/components/responses/RefreshCustomerV2AccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts':
get:
tags:
- Accounts
summary: Get Customer Accounts by Institution ID
description: >-
Get all active accounts owned by the given customer at the given
institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitution
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutions/{institutionId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts by Institution ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by Institution
ID, returning only basic information of active accounts owned by the
given customer at the given institution.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/institutionLogins/{institutionLoginId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts by Institution Login ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by Institution
Login ID, returning only basic information of all active accounts owned
by the given customer at the given institution login ID.
_Supported regions_: 
operationId: GetCustomerAccountsByInstitutionLoginSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/InstitutionLoginIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Account by ID (Simple)
description: >-
This API is a lighter version of Get Customer Accounts by ID, returning
only basic information of a customer account.
_Supported regions_: 
operationId: GetCustomerAccountSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
- $ref: '#/components/parameters/AccountIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/simple':
get:
tags:
- 'Accounts (Simple)'
summary: Get Customer Accounts (Simple)
description: >-
This API is a lighter version of Get Customer Accounts, returning only
basic information of all active customer accounts.
_Supported regions_: 
operationId: GetCustomerAccountsSimple
parameters:
- $ref: '#/components/parameters/CustomerIdParameter'
responses:
'200':
$ref: '#/components/responses/GetCustomerAccountsSimpleResponse'
'400':
$ref: '#/components/responses/BadRequestErrorResponse'
'401':
$ref: '#/components/responses/UnauthorizedErrorResponse'
'404':
$ref: '#/components/responses/ResourceNotFoundErrorResponse'
'/aggregation/v1/customers/{customerId}/accounts/{accountId}/transactions/historic':
post:
tags:
- Transactions
summary: Load Historic Transactions for Customer Account
description: >-
Connect to the account's financial institution and load up to 24 months
of historic transactions for the account. Length of history varies by
institution.
This is a premium service. The billable event is a call to this service
specifying a customer ID that has not been seen before by this service.
(If this service is called multiple times with the same customer ID, to
load transactions from multiple accounts, only one billable event has
occurred.)