-
Notifications
You must be signed in to change notification settings - Fork 22
/
Copy pathdirectory-api-swagger.yaml
4740 lines (4716 loc) · 197 KB
/
directory-api-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
openapi: 3.0.0
info:
title: Open Banking Directory API
version: 2.2.0
description: OB Tech Directory API
servers:
- url: https://matls-dirapi.openbanking.org.uk
description: Production
- url: https://matls-dirapi.openbankingtest.org.uk
description: Sandbox
paths:
'/v2.1/oauth/{OrganisationId}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
get:
summary: Get details of the active OAuthClient for the given Organisation
tags:
- OAuth Client v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/OAuthClient200OKResponse'
'204':
$ref: '#/components/responses/204NoContentResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
put:
summary: Update OAuthClient for the given Organisation
tags:
- OAuth Client v2.1
security:
- OAuth2SecurityReadWriteOps:
- ASPSPManage
- TPPManage
requestBody:
$ref: '#/components/requestBodies/CertificateOBWACorQWAC'
responses:
'200':
$ref: '#/components/responses/OAuthClient200OKResponse'
'204':
$ref: '#/components/responses/204NoContentResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation':
post:
summary: Enrol a eIDAS QWAC/QSeal-bearing participant
description: Enrol an eIDAS QWAC/QSealC certificate-bearing participant onto the Open Banking Directory. Currenty only TPPs can use this enrolment endpoint.Enrol an eIDAS QWAC/QSeal certificate-bearing participant onto the Open Banking Directory.
tags:
- Organisations v2.1
requestBody:
$ref: '#/components/requestBodies/Enrol'
responses:
'201':
$ref: '#/components/responses/Enrol201CreatedResponse'
'400':
$ref: '#/components/responses/Enrol400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get all organisations that the client is authorised to retrieve
description: Note that this was not in the original design but is included to inform the client
tags:
- Organisations v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/OrganisationsGetFromSCIM200OKResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'403':
$ref: '#/components/responses/403ForbiddenResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'/v2.1/organisation/{OrganisationId}':
get:
summary: Get the given organisation's details
tags:
- Organisations v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/OrganisationGetFromSCIM200OKResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'403':
$ref: '#/components/responses/403ForbiddenResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'/v2.1/organisation/{OrganisationId}/contact/{ContactType}':
put:
summary: Update the business or the technical contacts for the given organisation
tags:
- Contacts v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/ContactType'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
requestBody:
$ref: '#/components/requestBodies/Contact'
responses:
'200':
$ref: '#/components/responses/Contact200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get the business or the technical contacts for the given organisation
x-PingAccessResourceName: OrganisationContactGET
x-PingAccessRuleType: uk.org.openbanking.policy.RequestHostOverride
x-PingAccessRuleTarget: obdorgcontacts.{environment}
tags:
- Contacts v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/ContactType'
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/Contact200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement':
parameters:
- $ref: '#/components/parameters/OrganisationId'
post:
summary: Create a software statement
tags:
- Software Statements v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
requestBody:
$ref: '#/components/requestBodies/SoftwareStatement'
responses:
'201':
$ref: '#/components/responses/SoftwareStatement201CreatedResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get all software statements for the given organisation
tags:
- Software Statements v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/SoftwareStatementsGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
get:
summary: Get a software statement
tags:
- Software Statements v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/SoftwareStatement201CreatedResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
put:
summary: Activate or deactive a software statement
tags:
- Software Statements v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
requestBody:
$ref: '#/components/requestBodies/SoftwareStatementState'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'200':
$ref: '#/components/responses/SoftwareStatementUpdated200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}/redirect-uri':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
post:
summary: Add a redirect URI to the given Software Statement
tags:
- Software Statement Redirect URIs v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
requestBody:
$ref: '#/components/requestBodies/SoftwareStatementRedirectURI'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'200':
$ref: '#/components/responses/SoftwareStatementUpdated200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'409':
$ref: '#/components/responses/409ConflictResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}/software-statement-assertion':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
get:
summary:
Retrieve the software statement assertion for the given SoftwareStatementID.
description: |
# Depending on the type of participant, one of the following pre-conditions must be met in order to generate an SSA:
* EU TPPs NOT on the TPR must hold at least one eIDAS certificate.
* EU TPPs on the TPR must hold at least one eIDAS or OB certiticate.
* UK TPPs on the TPR must hold at least one OB certificate.
The response body is a signed JWT and the values found in the header and the payload of the SSA are specified below
# Terminology
This specification uses the terms "access token", "authorization code", "authorization endpoint", "authorization grant", "authorization server", "client", "client identifier", "client secret", "grant type", "protected resource", "redirection URI", "refresh token", "resource owner", "resource server", "response type", and "token endpoint" defined by OAuth 2.0 [RFC6749] and uses the term "Claim" defined by JSON Web Token (JWT) [RFC7519].
* __Account Servicing Payment Services Provider (ASPSP)__ -- An organisation managing customer accounts (and operating banking APIs).
* __Primary Technical Contact__ -- The person at the TPP who creates an SSA and invokes a registration mechanism. This is an example of an [RFC7591] Client Developer.
* __OB Organisation ID__ -- The unique identifier for each OpenBanking participant. Both TPPs and ASPSPs have OB Organisation IDs.
* __OpenBanking Directory__ -- An implementation of a [PSD2] competent authority; acts as an Identity Provider, certificate authority, and registry governing the participants in the UK OpenBanking API scheme.
* __ASPSP Registration Endpoint__ -- OAuth 2.0 & [RFC7591] compliant endpoint, exact value is discoverable from the [OIDCD] openid-configuration file of the ASPSP.
* __Software Statement Assertion (SSA)__ -- An implementation of an [RFC7591] software statement, signed by the OpenBanking Directory.
* __Trusted Third Party (TPP)__ -- An organization working to initiate payments or consume account information with/from an ASPSP.
* __TPP Client Software__ -- software implementing an OAuth2 client, interacting with an ASPSP registration endpoint.
# Software Statement Assertion (SSA)
The SSA is a JSON Web Token (JWT) containing client metadata about an instance of TPP client software. The JWT is issued and signed by the OpenBanking Directory.
## SSA Payload
The payload of an OpenBanking SSA MUST be a compliant software statement according to [RFC7591]. The SSA MUST also be a compliant JWT according to [RFC7519]. The following metadata profiles the metadata in [RFC7591] and [RFC7519]:
| Metadata | Description | Source Specification |
|----------|-------------|----------------------|
|`software_id`|Unique Identifier for TPP Client Software|[RFC7591]|
|`iss`|SSA Issuer|[RFC7519]|
|`iat`|Time SSA issued|[RFC7519]|
|`jti`|JWT ID|[RFC7519]|
The following software metadata is additionally defined for this profile:
|Metadata |Description |Field Size |Default values |
|---------|------------|-----------|---------------|
|`software_client_id`|The Client ID Registered at OB used to access OB resources|Base62 GUID (22 chars)| |
|`software_client_description`|Human-readable detailed description of the client|Max256Text| |
|`software_client_name`|Human-readable Software Name|Max40Text| |
|`software_client_uri`|The website or resource root uri|Max256Text| |
|`software_version`|The version number of the software should a TPP choose to register and / or maintain it|Max42Text| |
|`software_environment`|Requested additional field to avoid certificate check|Max256Text| |
|`software_jwks_endpoint`|Contains all active signing and network certs for the software|Max256Text| |
|`software_jwks_revoked_endpoint`|Contains all revoked signing and network certs for the software|Max256Text| |
|`software_logo_uri`|Link to the TPP logo. Note, ASPSPs are not obliged to display images hosted by third parties|Max256Text| |
|`software_mode`|ASPSP Requested additional field to indicate that this software is `Test` or `Live` the default is `Live`. Impact and support for `Test` software is up to the ASPSP.|Max40Text| |
|`software_on_behalf_of_org`|A reference to fourth party organsiation resource on the OB Directory if the registering TPP is acting on behalf of another.|Max40Text| |
|`software_policy_uri`|A link to the software's policy page|Max256Text| |
|`software_redirect_uris`|Registered client callback endpoints as registered with Open Banking|A string array of Max256Text items|
|`software_roles`|A multi value list of PSD2 roles that this software is authorized to perform.|A string array of Max256Text items| |
|`software_tos_uri`|A link to the software's terms of service page|Max256Text| |
The following Organisational metadata is defined for this profile:
|Metadata |Description |Field Size | Default values |
|---------|------------|-----------|----------------|
|`organisation_competent_authority_claims`|Authorisations granted to the organsiation by an NCA|CodeList {`AISP`, `PISP`, `CBPII`, `ASPSP`}| |
|`org_status`|Included to cater for voluntary withdrawal from OB scenarios|`Active`, `Revoked`, or `Withdrawn`| |
|`org_id`|The Unique TPP or ASPSP ID held by OpenBanking.|Max35Text| |
|`org_name`|Legal Entity Identifier or other known organisation name|Max140Text| |
|`org_contacts`|JSON array of objects containing a triplet of name, email, and phone number|Each item Max256Text| |
|`org_jwks_endpoint`|Contains all active signing and network certs for the organisation|Max256Text| |
|`org_jwks_revoked_endpoint`|Contains all revoked signing and network certs for the organisation|Max256Text| |
## SSA header
The SSA header MUST comply with [RFC7519].
|Metadata |Description |Comments |
|---------|------------|---------|
|`typ`|MUST be set to `JWT`| |
|`alg`|MUST be set to `ES256` or `PS256`| |
|`kid`|The kid will be kept the same as the `x5t` parameter. (X.509 Certificate SHA-1 Thumbprint) of the signing certificate.| |
### Example SSA
The elements defined in the software statement will consist of the following values.
*Note that there are inconsistent applications of booleans or "Active" strings in the current data model.*
*Note that there are inconsistent applications of status flags case sensitivity.*
*The attributes required to be displayed by ASPSPs.*
```
{
"typ": "JWT",
"alg": "ES256",
"kid": "ABCD1234"
}
{
"iss": "OpenBanking Ltd",
"iat": 1492756331,
"jti": "id12345685439487678",
"software_environment": "production",
"software_mode": "live",
"software_id": "65d1f27c-4aea-4549-9c21-60e495a7a86f",
"software_client_id": "Open Banking TPP Client Unique ID",
"software_client_name": "Amazon Prime Movies",
"software_client_description": "Amazon Prime Movies is a movie streaming service",
"software_version": "2.2.2",
"software_client_uri": "https://prime.amazon.com",
"software_redirect_uris": [
"https://prime.amazon.com/cb",
"https://prime.amazon.co.uk/cb"
],
"software_roles": [
"PISP",
"AISP"
],
"organisation_competent_authority_claims": {
"authority_id": "FMA", // Austrian Financial Market Authority
"registration_id": "111111",
"status": "Active",
"authorisations": [
{
"member_state": "GB",
"roles": [
"PISP",
"AISP"
]
},
{
"member_state": "IR",
"roles": [
"PISP"
]
}
]
},
"software_logo_uri": "https://prime.amazon.com/logo.png",
"org_status": "Active",
"org_id": "Amazon TPPID",
"org_name": "OpenBanking TPP Registered Name",
"org_contacts": [
{
"name": "contact name",
"email": "contact@contact.com",
"phone": "+447890130558"
"type": "business"
},
{
"name": "contact name",
"email": "contact@contact.com",
"phone": "+447890130558",
"type": "technical"
}
],
"org_jwks_endpoint": "https://jwks.openbanking.org.uk/org_id/org_id.jkws",
"org_jwks_revoked_endpoint": "https://jwks.openbanking.org.uk/org_id/revoked/org_id.jkws",
"software_jwks_endpoint": "https://jwks.openbanking.org.uk/org_id/software_id.jkws",
"software_jwks_revoked_endpoint": "https://jwks.openbanking.org.uk/org_id/revoked/software_id.jkws",
"software_policy_uri": "https://tpp.com/policy.html",
"software_tos_uri": "https://tpp.com/tos.html",
"software_on_behalf_of_org": "Acme Ltd"
}
{
Signature
}
```
# Automated Client Registration
A TPP MAY use automated client registration to submit an SSA to an ASPSP in exchange for client credentials for use as a client against an OAuth 2.0 Authorization Server. It is RECOMMENDED for ASPSPs to support the automated client registration mechanism. A large number of claims that OpenID Connect OPs could support as part of the RFC7591 request are detailed [https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata](https://openid.net/specs/openid-connect-registration-1_0.html#ClientMetadata) and should be followed if not explicitly referenced in the Software Statement Assertion claim set.
## Request Validation
Prior to issuing a client registration response, the ASPSP MUST perform the following checks
* The ASPSP SHOULD check whether the TPP that initiated the TLS connection is the same TPP as listed in the SSA.
* In the case where a gateway or other piece of infrastructure pre-terminates the MATLS channel in front of the registration endpoint, the certificate used to initiate the connection or some part of that certificate (such as DN & Issuer) SHOULD be made available to the ASPSP for validation against the claims in the SSA.
* The registration request MUST be signed with a key contained in the JWKS referenced in the SSA included with the request. This ensures that a holder-of-key proof-of-possession is performed proving that the TPP app was the originally intended recipient of the SSA when the OB issued it.
* The SSA MUST be validated according to [RFC7519], including validation of the signature and validity window.
JWT signature must be validated, this involves retrieving the jwks keyset for both the OB and the TPP. The OB keystore location will be published as part of the directory specification, The TPP's will be included in the software statement.
### SSA Lifetime
The SSA's Lifetime / Validity period is not defined by Open Banking. ASPSPs in the Open Banking ecosystem are required to implement pragmatic time ranges in which to accept an SSA. For example, an ASPSP that has implemented Dynamic Client Registration may choose to accept SSA's that were issued no earlier than 1 minute prior to their presentation however ASPSPs that only support manual registration may need to accept SSAs that were issued 30 minutes prior as the elapsed time period between generation and use between these two flows is expected to differ significantly.
tags:
- Software Statement Assertions v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/SoftwareStatementAssertion200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/certificate':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
get:
summary: Get the certificates for the given organisation
tags:
- Organisation Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificatesOrKeysGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/certificate/{OrganisationCertificateType}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
- $ref: '#/components/parameters/OrganisationCertificateType'
post:
summary: Store or create a new certificate of the given OrganisationCertificateType for the given organisation
tags:
- Organisation Certificates v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
- $ref: '#/components/parameters/OrganisationCertificateType'
requestBody:
$ref: '#/components/requestBodies/CertificateOrCSROrJWS'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'201':
$ref: '#/components/responses/CertificateOrKey201CreatedResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get the certificates of the given OrganisationCertificateType for the given oranisation
tags:
- Organisation Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificatesOrKeysGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/certificate/kid/{CertificateOrKeyId}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/CertificateOrKeyId'
get:
summary: Retrieve a certificate with the given CertificateOrKeyId
tags:
- Organisation Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificateOrKeyGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
delete:
summary: Revoke or remove a certificate with the given CertificateOrKeyId
tags:
- Organisation Certificates v2.1
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'204':
$ref: '#/components/responses/204NoContentResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
get:
summary: Get certificates for the given software statement
tags:
- Software Statement Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificatesOrKeysGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{SoftwareStatementCertificateOrKeyType}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
- $ref: '#/components/parameters/SoftwareStatementCertificateOrKeyType'
post:
summary: Add a key or create a new certificate for the given software statement
tags:
- Software Statement Certificates v2.1
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
requestBody:
$ref: '#/components/requestBodies/CSROrKey'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'201':
$ref: '#/components/responses/CertificateOrKey201CreatedResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get the certificates of the given type for the given software statement
tags:
- Software Statement Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificatesOrKeysGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/software-statement/{SoftwareStatementId}/certificate/{OrganisationAssociativeCertificateType}/{CertificateOrKeyId}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/SoftwareStatementId'
- $ref: '#/components/parameters/OrganisationAssociativeCertificateType'
- $ref: '#/components/parameters/CertificateOrKeyId'
put:
summary: Associate/de-associate a QSEAL/OBSEAL certificate with the given software statement
tags:
- Certificate Associations v2.1
requestBody:
$ref: '#/components/requestBodies/CertificateOrKeyAssociation'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'200':
$ref: '#/components/responses/CertificateAssociatedWithASoftwareStatement200AcceptedResponse'
'204':
$ref: '#/components/responses/204NoContentResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'409':
$ref: '#/components/responses/409ConflictResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get the certificate of the given type and ID for the given software statement
tags:
- Software Statement Certificates v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificateOrKeyGet200OKResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/authorisation-server':
parameters:
- $ref: '#/components/parameters/OrganisationId'
get:
summary: Get all Authorisation Servers for the given organisation
tags:
- Authorisation Servers v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/AuthorisationServersResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
post:
summary: Create an Authorisation Server for the given organisation
tags:
- Authorisation Servers v2.1
requestBody:
$ref: '#/components/requestBodies/AuthorisationServer'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'201':
$ref: '#/components/responses/AuthorisationServerResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/organisation/{OrganisationId}/authorisation-server/{AuthorisationServerId}':
parameters:
- $ref: '#/components/parameters/OrganisationId'
- $ref: '#/components/parameters/AuthorisationServerId'
get:
summary: Get .well-known entity
tags:
- Authorisation Servers v2.1
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/AuthorisationServerResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
put:
summary: Update .well-known entity
tags:
- Authorisation Servers v2.1
requestBody:
$ref: '#/components/requestBodies/AuthorisationServer'
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'202':
$ref: '#/components/responses/AuthorisationServer202AcceptedResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
delete:
summary: Delete an Authorisation Server
tags:
- Authorisation Servers v2.1
security:
- OAuth2SecurityReadWriteOps:
- ASPSPReadAccess
- TPPReadAccess
- TPPManage
responses:
'204':
$ref: '#/components/responses/204NoContentResponse'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2.1/certificate/validate':
post:
summary: Validate certificate
tags:
- Certificate Validation v2.1
requestBody:
$ref: '#/components/requestBodies/CertificateValidationRequestBody'
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/CertificateValidationServerResponseV2.1'
'400':
$ref: '#/components/responses/400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
'/v2/organisation':
post:
summary: Enrol a eIDAS QWAC/QSeal-bearing participant
description: Enrol an eIDAS QWAC/QSealC certificate-bearing participant onto the Open Banking Directory. Currenty only TPPs can use this enrolment endpoint.Enrol an eIDAS QWAC/QSeal certificate-bearing participant onto the Open Banking Directory.
tags:
- Organisations
requestBody:
$ref: '#/components/requestBodies/Enrol'
responses:
'201':
$ref: '#/components/responses/Enrol201CreatedResponse'
'400':
$ref: '#/components/responses/Enrol400BadRequestResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'500':
$ref: '#/components/responses/500InternalServerErrorResponse'
'502':
$ref: '#/components/responses/502BadGatewayResponse'
get:
summary: Get all organisations that the client is authorised to retrieve
description: Note that this was not in the original design but is included to inform the client
tags:
- Organisations
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses:
'200':
$ref: '#/components/responses/OrganisationsGetFromSCIM200OKResponse'
'401':
$ref: '#/components/responses/401UnauthorizedResponse'
'403':
$ref: '#/components/responses/403ForbiddenResponse'
'404':
$ref: '#/components/responses/404NotFoundResponse'
'406':
$ref: '#/components/responses/406NotAcceptableResponse'
'/v2/organisation/{OrganisationId}':
get:
summary: Get the given organisation's details
tags:
- Organisations
parameters:
- $ref: '#/components/parameters/OrganisationId'
security:
- OAuth2SecurityReadOps:
- ASPSPReadAccess
- TPPReadAccess
responses: