-
Notifications
You must be signed in to change notification settings - Fork 4
Expand file tree
/
Copy pathindex.html
More file actions
6607 lines (6273 loc) · 296 KB
/
index.html
File metadata and controls
6607 lines (6273 loc) · 296 KB
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
<!doctype html>
<html>
<head>
<!-- Global site tag (gtag.js) - Google Analytics -->
<script async src="https://www.googletagmanager.com/gtag/js?id=UA-164014896-1"></script>
<script>
window.dataLayer = window.dataLayer || [];
function gtag(){dataLayer.push(arguments);}
gtag('js', new Date());
gtag('config', 'UA-164014896-1');
</script>
<meta charset="utf-8">
<meta content="IE=edge,chrome=1" http-equiv="X-UA-Compatible">
<meta name="viewport" content="width=device-width, initial-scale=1, maximum-scale=1">
<meta property="og:title" content="CDR Register Design Reference" />
<meta property="og:description" content="The CDR Register Design Reference provides participants with design specifications defining how to interact with the CDR Register" />
<meta property="og:image" content="images/ACCC_Stacked_RGB_Positive.png" />
<title>CDR Register Design Reference</title>
<style>
.highlight table td { padding: 5px; }
.highlight table pre { margin: 0; }
.highlight .gh {
color: #999999;
}
.highlight .sr {
color: #f6aa11;
}
.highlight .go {
color: #888888;
}
.highlight .gp {
color: #555555;
}
.highlight .gs {
}
.highlight .gu {
color: #aaaaaa;
}
.highlight .nb {
color: #f6aa11;
}
.highlight .cm {
color: #75715e;
}
.highlight .cp {
color: #75715e;
}
.highlight .c1 {
color: #75715e;
}
.highlight .cs {
color: #75715e;
}
.highlight .c, .highlight .cd {
color: #75715e;
}
.highlight .err {
color: #960050;
}
.highlight .gr {
color: #960050;
}
.highlight .gt {
color: #960050;
}
.highlight .gd {
color: #49483e;
}
.highlight .gi {
color: #49483e;
}
.highlight .ge {
color: #49483e;
}
.highlight .kc {
color: #66d9ef;
}
.highlight .kd {
color: #66d9ef;
}
.highlight .kr {
color: #66d9ef;
}
.highlight .no {
color: #66d9ef;
}
.highlight .kt {
color: #66d9ef;
}
.highlight .mf {
color: #ae81ff;
}
.highlight .mh {
color: #ae81ff;
}
.highlight .il {
color: #ae81ff;
}
.highlight .mi {
color: #ae81ff;
}
.highlight .mo {
color: #ae81ff;
}
.highlight .m, .highlight .mb, .highlight .mx {
color: #ae81ff;
}
.highlight .sc {
color: #ae81ff;
}
.highlight .se {
color: #ae81ff;
}
.highlight .ss {
color: #ae81ff;
}
.highlight .sd {
color: #e6db74;
}
.highlight .s2 {
color: #e6db74;
}
.highlight .sb {
color: #e6db74;
}
.highlight .sh {
color: #e6db74;
}
.highlight .si {
color: #e6db74;
}
.highlight .sx {
color: #e6db74;
}
.highlight .s1 {
color: #e6db74;
}
.highlight .s {
color: #e6db74;
}
.highlight .na {
color: #a6e22e;
}
.highlight .nc {
color: #a6e22e;
}
.highlight .nd {
color: #a6e22e;
}
.highlight .ne {
color: #a6e22e;
}
.highlight .nf {
color: #a6e22e;
}
.highlight .vc {
color: #ffffff;
}
.highlight .nn {
color: #ffffff;
}
.highlight .nl {
color: #ffffff;
}
.highlight .ni {
color: #ffffff;
}
.highlight .bp {
color: #ffffff;
}
.highlight .vg {
color: #ffffff;
}
.highlight .vi {
color: #ffffff;
}
.highlight .nv {
color: #ffffff;
}
.highlight .w {
color: #ffffff;
}
.highlight {
color: #ffffff;
}
.highlight .n, .highlight .py, .highlight .nx {
color: #ffffff;
}
.highlight .ow {
color: #f92672;
}
.highlight .nt {
color: #f92672;
}
.highlight .k, .highlight .kv {
color: #f92672;
}
.highlight .kn {
color: #f92672;
}
.highlight .kp {
color: #f92672;
}
.highlight .o {
color: #f92672;
}
</style>
<link href="stylesheets/screen.css" rel="stylesheet" media="screen" />
<link href="stylesheets/print.css" rel="stylesheet" media="print" />
<script src="javascripts/all.js"></script>
<link href="images/favicon.ico" rel="icon" type="image/ico" />
</head>
<body class="index" data-languages="["Examples"]">
<a href="#" id="nav-button">
<span>
NAV
<img src="images/navbar.png" alt="Navbar" />
</span>
</a>
<div class="toc-wrapper">
<img src="images/ACCC_Stacked_RGB_Reverse.PNG" class="logo" alt="Accc stacked rgb reverse" />
<div class="title">CDR Register Design Reference</div>
<div class="lang-selector">
<a href="#" data-language-name="Examples">Examples</a>
</div>
<div class="search">
<input type="text" class="search" id="input-search" placeholder="Search">
</div>
<ul class="search-results"></ul>
<ul id="toc" class="toc-list-h1">
<li>
<a href="#introduction" class="toc-h1 toc-link" data-title="Introduction">Introduction</a>
<ul class="toc-list-h2">
<li>
<a href="#consumer-data-right" class="toc-h2 toc-link" data-title="Consumer Data Right">Consumer Data Right</a>
</li>
<li>
<a href="#accc-39-s-role" class="toc-h2 toc-link" data-title="ACCC's Role">ACCC's Role</a>
</li>
<li>
<a href="#data-standards-body" class="toc-h2 toc-link" data-title="Data Standards Body">Data Standards Body</a>
</li>
<li>
<a href="#future-dated-obligations" class="toc-h2 toc-link" data-title="Future Dated Obligations">Future Dated Obligations</a>
</li>
</ul>
</li>
<li>
<a href="#consultation-outline" class="toc-h1 toc-link" data-title="Consultation outline">Consultation outline</a>
<ul class="toc-list-h2">
<li>
<a href="#consultation-rules-of-engagement" class="toc-h2 toc-link" data-title="Consultation rules of engagement">Consultation rules of engagement</a>
</li>
<li>
<a href="#feedback-sought" class="toc-h2 toc-link" data-title="Feedback sought">Feedback sought</a>
</li>
</ul>
</li>
<li>
<a href="#consumer-data-right-register" class="toc-h1 toc-link" data-title="Consumer Data Right Register">Consumer Data Right Register</a>
<ul class="toc-list-h2">
<li>
<a href="#ecosystem-entities" class="toc-h2 toc-link" data-title="Ecosystem Entities">Ecosystem Entities</a>
</li>
<li>
<a href="#participant-brands" class="toc-h2 toc-link" data-title="Participant Brands">Participant Brands</a>
</li>
<li>
<a href="#ecosystem-component-diagram" class="toc-h2 toc-link" data-title="Ecosystem Component Diagram">Ecosystem Component Diagram</a>
</li>
<li>
<a href="#data-holder-2" class="toc-h2 toc-link" data-title="Data Holder">Data Holder</a>
</li>
<li>
<a href="#accredited-data-recipient-2" class="toc-h2 toc-link" data-title="Accredited Data Recipient">Accredited Data Recipient</a>
</li>
<li>
<a href="#register" class="toc-h2 toc-link" data-title="Register">Register</a>
</li>
<li>
<a href="#certificate-authority" class="toc-h2 toc-link" data-title="Certificate Authority">Certificate Authority</a>
</li>
</ul>
</li>
<li>
<a href="#intermediaries" class="toc-h1 toc-link" data-title="Intermediaries">Intermediaries</a>
<ul class="toc-list-h2">
<li>
<a href="#collection-arrangements" class="toc-h2 toc-link" data-title="Collection Arrangements">Collection Arrangements</a>
</li>
</ul>
</li>
<li>
<a href="#client-registration" class="toc-h1 toc-link" data-title="Client Registration">Client Registration</a>
<ul class="toc-list-h2">
<li>
<a href="#dynamic-client-registration" class="toc-h2 toc-link" data-title="Dynamic Client Registration">Dynamic Client Registration</a>
</li>
<li>
<a href="#registration-request-using-jwt" class="toc-h2 toc-link" data-title="Registration Request using JWT">Registration Request using JWT</a>
</li>
<li>
<a href="#registration-validation" class="toc-h2 toc-link" data-title="Registration Validation">Registration Validation</a>
</li>
<li>
<a href="#registration-response" class="toc-h2 toc-link" data-title="Registration Response">Registration Response</a>
</li>
<li>
<a href="#registration-errors" class="toc-h2 toc-link" data-title="Registration Errors">Registration Errors</a>
</li>
<li>
<a href="#client-registration-management" class="toc-h2 toc-link" data-title="Client Registration Management">Client Registration Management</a>
</li>
<li>
<a href="#authorisation-server" class="toc-h2 toc-link" data-title="Authorisation Server">Authorisation Server</a>
</li>
<li>
<a href="#registration-flows" class="toc-h2 toc-link" data-title="Registration Flows">Registration Flows</a>
</li>
</ul>
</li>
<li>
<a href="#participant-statuses" class="toc-h1 toc-link" data-title="Participant Statuses">Participant Statuses</a>
<ul class="toc-list-h2">
<li>
<a href="#accredited-data-recipient-and-software-product-statuses" class="toc-h2 toc-link" data-title="Accredited Data Recipient and Software Product Statuses">Accredited Data Recipient and Software Product Statuses</a>
</li>
<li>
<a href="#data-holder-responsibilities" class="toc-h2 toc-link" data-title="Data Holder Responsibilities">Data Holder Responsibilities</a>
</li>
<li>
<a href="#metadata-cache-management" class="toc-h2 toc-link" data-title="Metadata Cache Management">Metadata Cache Management</a>
</li>
<li>
<a href="#etag-support" class="toc-h2 toc-link" data-title="ETag Support">ETag Support</a>
</li>
<li>
<a href="#checking-request-validity" class="toc-h2 toc-link" data-title="Checking Request Validity">Checking Request Validity</a>
</li>
<li>
<a href="#status-changes" class="toc-h2 toc-link" data-title="Status Changes">Status Changes</a>
</li>
<li>
<a href="#cache-refresh-metadata-request" class="toc-h2 toc-link" data-title="Cache Refresh Metadata Request">Cache Refresh Metadata Request</a>
</li>
<li>
<a href="#refusal-to-disclose" class="toc-h2 toc-link" data-title="Refusal To Disclose">Refusal To Disclose</a>
</li>
</ul>
</li>
<li>
<a href="#security-profile" class="toc-h1 toc-link" data-title="Security Profile">Security Profile</a>
<ul class="toc-list-h2">
<li>
<a href="#overview" class="toc-h2 toc-link" data-title="Overview">Overview</a>
</li>
<li>
<a href="#register-endpoints" class="toc-h2 toc-link" data-title="Register Endpoints">Register Endpoints</a>
</li>
<li>
<a href="#client-authentication" class="toc-h2 toc-link" data-title="Client Authentication">Client Authentication</a>
</li>
<li>
<a href="#transaction-security" class="toc-h2 toc-link" data-title="Transaction Security">Transaction Security</a>
</li>
<li>
<a href="#participant-endpoints" class="toc-h2 toc-link" data-title="Participant Endpoints">Participant Endpoints</a>
</li>
<li>
<a href="#jwks-cache-management" class="toc-h2 toc-link" data-title="JWKS Cache Management">JWKS Cache Management</a>
</li>
<li>
<a href="#certificate-management" class="toc-h2 toc-link" data-title="Certificate Management">Certificate Management</a>
</li>
</ul>
</li>
<li>
<a href="#availability" class="toc-h1 toc-link" data-title="Availability">Availability</a>
<ul class="toc-list-h2">
<li>
<a href="#cdn-hosted-endpoints" class="toc-h2 toc-link" data-title="CDN Hosted Endpoints">CDN Hosted Endpoints</a>
</li>
<li>
<a href="#cdr-register-unavailable" class="toc-h2 toc-link" data-title="CDR Register Unavailable">CDR Register Unavailable</a>
</li>
<li>
<a href="#certificate-authority-unavailable" class="toc-h2 toc-link" data-title="Certificate Authority Unavailable">Certificate Authority Unavailable</a>
</li>
<li>
<a href="#data-recipient-unavailable" class="toc-h2 toc-link" data-title="Data Recipient Unavailable">Data Recipient Unavailable</a>
</li>
<li>
<a href="#data-holder-unavailable" class="toc-h2 toc-link" data-title="Data Holder Unavailable">Data Holder Unavailable</a>
</li>
<li>
<a href="#backoff-patterns" class="toc-h2 toc-link" data-title="Backoff Patterns">Backoff Patterns</a>
</li>
</ul>
</li>
<li>
<a href="#versioning" class="toc-h1 toc-link" data-title="Versioning">Versioning</a>
</li>
<li>
<a href="#consumer-data-right-cdr-register-apis" class="toc-h1 toc-link" data-title="Register APIs">Register APIs</a>
<ul class="toc-list-h2">
<li>
<a href="#base-urls" class="toc-h2 toc-link" data-title="Base URLs:">Base URLs:</a>
</li>
<li>
<a href="#getopenidproviderconfig" class="toc-h2 toc-link" data-title="GetOpenIdProviderConfig">GetOpenIdProviderConfig</a>
</li>
<li>
<a href="#getjwks" class="toc-h2 toc-link" data-title="GetJWKS">GetJWKS</a>
</li>
<li>
<a href="#getdataholderbrands" class="toc-h2 toc-link" data-title="GetDataHolderBrands">GetDataHolderBrands</a>
</li>
<li>
<a href="#getsoftwarestatementassertion-ssa" class="toc-h2 toc-link" data-title="GetSoftwareStatementAssertion (SSA)">GetSoftwareStatementAssertion (SSA)</a>
</li>
<li>
<a href="#getsoftwareproductsstatus" class="toc-h2 toc-link" data-title="GetSoftwareProductsStatus">GetSoftwareProductsStatus</a>
</li>
<li>
<a href="#getdatarecipientsstatus" class="toc-h2 toc-link" data-title="GetDataRecipientsStatus">GetDataRecipientsStatus</a>
</li>
<li>
<a href="#getdatarecipients" class="toc-h2 toc-link" data-title="GetDataRecipients">GetDataRecipients</a>
</li>
</ul>
</li>
<li>
<a href="#schemas" class="toc-h1 toc-link" data-title="Schemas">Schemas</a>
<ul class="toc-list-h2">
<li>
<a href="#tocSresponseopenidproviderconfigmetadata" class="toc-h2 toc-link" data-title="ResponseOpenIDProviderConfigMetadata">ResponseOpenIDProviderConfigMetadata</a>
</li>
<li>
<a href="#tocSresponsejwks" class="toc-h2 toc-link" data-title="ResponseJWKS">ResponseJWKS</a>
</li>
<li>
<a href="#tocSjwk" class="toc-h2 toc-link" data-title="JWK">JWK</a>
</li>
<li>
<a href="#tocSresponseregisterdataholderbrandlist" class="toc-h2 toc-link" data-title="ResponseRegisterDataHolderBrandList">ResponseRegisterDataHolderBrandList</a>
</li>
<li>
<a href="#tocSregisterdataholderbrand" class="toc-h2 toc-link" data-title="RegisterDataHolderBrand">RegisterDataHolderBrand</a>
</li>
<li>
<a href="#tocSsoftwareproductsstatuslist" class="toc-h2 toc-link" data-title="SoftwareProductsStatusList">SoftwareProductsStatusList</a>
</li>
<li>
<a href="#tocSsoftwareproductstatus" class="toc-h2 toc-link" data-title="SoftwareProductStatus">SoftwareProductStatus</a>
</li>
<li>
<a href="#tocSdatarecipientsstatuslist" class="toc-h2 toc-link" data-title="DataRecipientsStatusList">DataRecipientsStatusList</a>
</li>
<li>
<a href="#tocSdatarecipientstatus" class="toc-h2 toc-link" data-title="DataRecipientStatus">DataRecipientStatus</a>
</li>
<li>
<a href="#tocSresponseregisterdatarecipientlist" class="toc-h2 toc-link" data-title="ResponseRegisterDataRecipientList">ResponseRegisterDataRecipientList</a>
</li>
<li>
<a href="#tocSregisterdatarecipient" class="toc-h2 toc-link" data-title="RegisterDataRecipient">RegisterDataRecipient</a>
</li>
<li>
<a href="#tocSdatarecipientbrandmetadata" class="toc-h2 toc-link" data-title="DataRecipientBrandMetaData">DataRecipientBrandMetaData</a>
</li>
<li>
<a href="#tocSsoftwareproductmetadata" class="toc-h2 toc-link" data-title="SoftwareProductMetaData">SoftwareProductMetaData</a>
</li>
<li>
<a href="#tocSlegalentitydetail" class="toc-h2 toc-link" data-title="LegalEntityDetail">LegalEntityDetail</a>
</li>
<li>
<a href="#tocSregisterdataholderbrandserviceendpoint" class="toc-h2 toc-link" data-title="RegisterDataHolderBrandServiceEndpoint">RegisterDataHolderBrandServiceEndpoint</a>
</li>
<li>
<a href="#tocSregisterdataholderauth" class="toc-h2 toc-link" data-title="RegisterDataHolderAuth">RegisterDataHolderAuth</a>
</li>
<li>
<a href="#tocSlinkspaginated" class="toc-h2 toc-link" data-title="LinksPaginated">LinksPaginated</a>
</li>
<li>
<a href="#tocSmetapaginated" class="toc-h2 toc-link" data-title="MetaPaginated">MetaPaginated</a>
</li>
<li>
<a href="#tocSresponseerrorlist" class="toc-h2 toc-link" data-title="ResponseErrorList">ResponseErrorList</a>
</li>
<li>
<a href="#tocSerror" class="toc-h2 toc-link" data-title="Error">Error</a>
</li>
</ul>
</li>
<li>
<a href="#dcr-api" class="toc-h1 toc-link" data-title="DCR API">DCR API</a>
<ul class="toc-list-h2">
<li>
<a href="#register-a-client-using-a-cdr-register-issued-software-statement-assertion" class="toc-h2 toc-link" data-title="Register a client using a CDR Register issued Software Statement Assertion">Register a client using a CDR Register issued Software Statement Assertion</a>
</li>
<li>
<a href="#get-a-client-registration-for-a-given-client-id" class="toc-h2 toc-link" data-title="Get a Client Registration for a given Client ID">Get a Client Registration for a given Client ID</a>
</li>
<li>
<a href="#update-a-client-registration-for-a-given-client-id" class="toc-h2 toc-link" data-title="Update a Client Registration for a given Client ID">Update a Client Registration for a given Client ID</a>
</li>
<li>
<a href="#delete-a-client-registration-for-a-given-client-id" class="toc-h2 toc-link" data-title="Delete a Client Registration for a given Client ID">Delete a Client Registration for a given Client ID</a>
</li>
<li>
<a href="#schemas" class="toc-h2 toc-link" data-title="Schemas">Schemas</a>
</li>
<li>
<a href="#tocSregistrationproperties" class="toc-h2 toc-link" data-title="RegistrationProperties">RegistrationProperties</a>
</li>
<li>
<a href="#tocSclientregistration" class="toc-h2 toc-link" data-title="ClientRegistration">ClientRegistration</a>
</li>
<li>
<a href="#tocSregistrationerror" class="toc-h2 toc-link" data-title="RegistrationError">RegistrationError</a>
</li>
</ul>
</li>
<li>
<a href="#change-log" class="toc-h1 toc-link" data-title="Change Log">Change Log</a>
</li>
<li>
<a href="#archives" class="toc-h1 toc-link" data-title="Archives">Archives</a>
</li>
</ul>
<ul class="toc-footer">
<li><a href='https://github.com/cdr-register/register'>CDR Register on Github</a></li>
<li><a href='https://consumerdatastandards.gov.au'>Consumer Data Standards</a></li>
<li><a href='includes/swagger/swagger.json'>Swagger (JSON)</a></li>
<li><a href='includes/swagger/swagger.yaml'>Swagger (YAML)</a></li>
</ul>
<ul class="toc-footer">
<li class="version-footer">Version: 1.5.0</li>
</ul>
</div>
<div class="page-wrapper">
<div class="dark-box"></div>
<div class="content">
<aside class="warning permanent-banner">
<span>This is the archived version </span>
<span style="font-weight: bold;">1.5.0</span>
<span> of the CDR Register Design and is retained for reference only.</span>
<div class="aside-second-line">Please refer to the <a href="https://consumerdatastandardsaustralia.github.io/standards">Consumer Data Standards</a> where this design is now maintained </div>
</aside>
<h1 id='introduction'>Introduction</h1><h2 id='consumer-data-right'>Consumer Data Right</h2>
<p>The Australian Government is introducing a Consumer Data Right (CDR) to give consumers more control over their data.<br>
The CDR will be rolled out sector-by-sector across the economy, starting with the banking sector.<br>
The Government has announced that the energy and telecommunications sectors will follow banking.</p>
<p>Further information on the CDR is available on the Treasury website:<br>
<a href="https://treasury.gov.au/consumer-data-right">https://treasury.gov.au/consumer-data-right</a></p>
<h2 id='accc-39-s-role'>ACCC's Role</h2>
<p>The ACCC is the lead regulator for the CDR regime, and has roles and functions that include:</p>
<ul>
<li><p>accrediting entities to receive data;</p></li>
<li><p>managing an online register of accredited data recipients and data holders;</p></li>
<li><p>providing guidance on the CDR; and</p></li>
<li><p>compliance and enforcement activities.</p></li>
</ul>
<p>Further information on the ACCC’s role in the CDR is available on the ACCC’s website:<br>
<a href="https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0">https://www.accc.gov.au/focus-areas/consumer-data-right-cdr-0</a></p>
<h2 id='data-standards-body'>Data Standards Body</h2>
<p>A Data Standards Body (DSB) is responsible for assisting Mr Andrew Stevens, the Data Standards Chair, in the development of common technical standards to allow Australians to access data held about them by businesses and direct its safe transfer to others. </p>
<p>Further information on the DSB is available on its website:<br>
<a href="https://consumerdatastandards.org.au">https://consumerdatastandards.org.au</a></p>
<h2 id='future-dated-obligations'>Future Dated Obligations</h2>
<p>The CDR Register design publishes content, explicitly specified, which will not take effect until a future date or may cease to have effect on some future date.
The table below highlights these areas of the standards.</p>
<table><thead>
<tr>
<th>Section</th>
<th>Description</th>
<th>Applicable Date</th>
</tr>
</thead><tbody>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td>Introduces the new metadata field <code>recipient_base_uri</code> used to facilitate the ADR <a href="https://consumerdatastandardsaustralia.github.io/standards/#end-points">CDR Arrangement Management End Point</a>. This change deprecates the ADR <code>revocation_uri</code> field which becomes optional</td>
<td>November 2020</td>
</tr>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td><code>recipient_base_uri</code> becomes mandatory, <code>revocation_uri</code> field remains optional</td>
<td>February 2021</td>
</tr>
<tr>
<td><a href="#certificate-management"><strong>Certificate Management</strong></a></td>
<td>Introduces the ADR <a href="https://consumerdatastandardsaustralia.github.io/standards/#end-points">CDR Arrangement Revocation End Point</a> which is secured with either a public or ACCC CA issued certificate</td>
<td>November 2020</td>
</tr>
<tr>
<td><a href="#getdatarecipients"><strong>GetDataRecipients</strong></a></td>
<td>Updates <code>GetDataRecipients</code> to include the accreditationNumber in the response</td>
<td>November 2020</td>
</tr>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td>Introduces the new optional metadata fields <code>sector_identifier_uri</code>, <code>legal_entity_id</code> and <code>legal_entity_name</code></td>
<td>July 2021</td>
</tr>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td>Corrects the new optional metadata fields <code>software_roles</code></td>
<td>July 2021</td>
</tr>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td>Updates the scopes field to include <code>openid</code> and <code>profile</code></td>
<td>July 2021</td>
</tr>
<tr>
<td><a href="#dynamic-client-registration"><strong>Dynamic Client Registration</strong></a></td>
<td>Changes <code>request_object_signing_alg</code> to required in the <a href="#tocSregistrationproperties">DCR API RegistrationProperties</a> schema</td>
<td>July 2021</td>
</tr>
</tbody></table>
<h1 id='consultation-outline'>Consultation outline</h1>
<p>The ACCC is using this website as a tool to consult on aspects of the design and implementation of the register of CDR participants (the CDR Register). The ACCC is seeking comments from interested stakeholders. </p>
<h2 id='consultation-rules-of-engagement'>Consultation rules of engagement</h2>
<p>The ACCC intends to conduct public consultation on the CDR Register. Questions or comments that participants might ask us via email or private message are likely to be questions or comments other participants have as well. Our answers will be of interest to everyone. There are likely to be experiences and lessons everybody working in this ecosystem can learn from. Having these conversations transparently helps reduce duplication, resolve issues faster and keep everyone up to date with the conversation.</p>
<p>We ask that all contributors to the CDR Register GitHub comply with the <a href="https://help.github.com/en/articles/github-community-forum-code-of-conduct">GitHub Community Forum Code of Conduct</a>. </p>
<p>In addition, it would be appreciated if the following rules are adhered to when commenting or contributing:</p>
<ul>
<li> For transparency, if you work at or are associated with an organisation with an interest in the Consumer Data Right, please indicate this in your response.</li>
<li> Please ensure you are aware of and compliant with any social media guidelines or internal processes for response set by your organisation before providing feedback.</li>
</ul>
<p>The ACCC will be actively monitoring and reviewing any comments/responses which are provided, however will not be responding to individual comments.
Depending on the number of responses/comments we get, we will assess what the most efficient and effective way to engage with the community is, noting that we want this to be a collaborative effort.</p>
<p><a href="https://github.com/cdr-register/register">CDR Register on GitHub</a></p>
<h2 id='feedback-sought'>Feedback sought</h2>
<p>To guide responses and comments, we are seeking input which will assist us in ensuring that the Register designs meets the needs of the overarching CDR ecosystem. The focus should be on validating the designs, and providing any necessary context and reasoning. </p>
<h1 id='consumer-data-right-register'>Consumer Data Right Register</h1>
<p>The ACCC will perform the role of the CDR Registrar. The CDR Registrar will have the function of maintaining the Register of Accredited Persons (the Register) who have been granted accreditation by the ACCC in its capacity as Data Recipient Accreditor. Accredited persons become Accredited Data Recipients upon receipt of CDR data.</p>
<p>The Register will also include information about Data Holders. Information about Accredited Data Recipients and Data Holders recorded in the Register will be made available to the public in accordance with the CDR rules. Additional information held in the Register will be available to accredited data recipients and data holders.</p>
<h2 id='ecosystem-entities'>Ecosystem Entities</h2><h3 id='cdr-consumer'>CDR consumer</h3>
<p>A consumer, as defined in the CDR rules, who is able to a make a request for disclosure of CDR data to themselves or to an accredited data recipient</p>
<h3 id='data-holder'>Data Holder</h3>
<p>A person who holds designated CDR data and is required by the CDR rules to disclose product and consumer data</p>
<h3 id='data-holder-brand'>Data Holder Brand</h3>
<p>An individual name that is used to collectively identify CDR data sets held by a Data Holder. This will be aligned to, and may or may not be the same as a business name that is registered to the Legal Entity who is the Data Holder</p>
<p>Data Holders would typically have one or more brands within the Consumer Data Right</p>
<h3 id='accredited-data-recipient'>Accredited Data Recipient</h3>
<p>A person that has been granted accreditation by the ACCC and is able to collect, and receives, CDR data about a CDR consumer from a data holder with the consent of the consumer</p>
<h3 id='accredited-data-recipient-brand'>Accredited Data Recipient Brand</h3>
<p>An individual name that is used to collectively identify a set of products and/or services offered by an Accredited Data Recipient. This will be aligned to, and may or may not be the same as a business name that is registered to the Legal Entity who is the Accredited Data Recipient</p>
<p>Data Recipients would typically have one or more brands within the Consumer Data Right</p>
<h3 id='software-product'>Software Product</h3>
<p>Accredited Data Recipients create Software Products which provide consumers the ability to get insight into their data held by Data Holders</p>
<p>Accredited Data Recipients would typically have one or more products within the Consumer Data Right</p>
<h3 id='entity-relationship-diagram'>Entity Relationship Diagram</h3>
<p>The following is a logical model of the entities exposed to participants through the Register APIs</p>
<p><img class=medium-image src="images/EntityRelationships.png" ></img></p>
<h3 id='identifiers'>Identifiers</h3>
<p>The identifiers outlined in the Ecosystem entities diagram map to Client Registration and APIs defined in this documentation.</p>
<table><thead>
<tr>
<th>Identifier</th>
<th>Mapping</th>
</tr>
</thead><tbody>
<tr>
<td><strong>legalEntityId</strong></td>
<td>Identifier in <a href="#tocSlegalentitydetail">LegalEntityDetail</a> schema returned as part of <a href="#getdataholderbrands">GetDataHolderBrands API</a> </br> Identifier in <a href="#tocSregisterdatarecipient">RegisterDataRecipient</a> schema returned as part of <a href="#getdatarecipients">GetDataRecipients API</a></td>
</tr>
<tr>
<td><strong>dataRecipientId</strong></td>
<td>Identifier in <a href="#tocSdatarecipientstatus">DataRecipientStatus</a> schema returned as part of <a href="#getdatarecipients">GetDataRecipients API</a>. This is the equivalent to the <code>legalEntityId</code> described above </br></td>
</tr>
<tr>
<td><strong>dataHolderBrandId</strong></td>
<td>Identifier in <a href="#tocSregisterdataholderbrand">RegisterDataHolderBrands</a> schema returned as part of <a href="#getdataholderbrands">GetDataHolderBrands API</a> </br></td>
</tr>
<tr>
<td><strong>dataRecipientBrandId</strong></td>
<td><code>org_id</code> claim as defined in the <a href="#dynamic-client-registration">SSA Definition</a> </br> Identifier in <a href="#tocSdatarecipientbrandmetadata">DataRecipientsBrandMetaData</a> schema returned as part of <a href="#getdatarecipients">GetDataRecipients API</a></br>Identifier used as a parameter to the <a href="#getsoftwarestatementassertion-ssa">GetSoftwareStatementAssertion API</a></td>
</tr>
<tr>
<td><strong>softwareProductId</strong></td>
<td><code>software_id</code> claim as defined in the <a href="#dynamic-client-registration">SSA Definition</a> </br> <code>iss</code> claim as defined in the <a href="#registration-request-using-jwt">Registration Request</a> </br>Identifier used as a parameter to the <a href="#getsoftwarestatementassertion-ssa">GetSoftwareStatementAssertion API</a></td>
</tr>
</tbody></table>
<h2 id='participant-brands'>Participant Brands</h2>
<p>The CDR Register has been designed to accommodate a multitude of organisational business models using the concept of brands (<strong>Data Holder Brands</strong> and <strong>Accredited Data Recipient Brands</strong>). This brands flexibility requires participants to understand how different configurations will be presented at the CDR Register.</p>
<p>A dedicated support article has been written on this topic: <a href="https://cdr-support.zendesk.com/hc/en-us/articles/900005881263-Brands-in-the-Consumer-Data-Right-Ecosystem">Brands in the Consumer Data Right Ecosystem</a></p>
<h2 id='ecosystem-component-diagram'>Ecosystem Component Diagram</h2>
<p>The following is a high level overview of the CDR ecosystem outlining the components and API endpoints each participant within the ecosystem will be expected to implement.</p>
<p>Note that ADRs are expected to have one or more Software Products consuming CDR data.</p>
<p><img src="images/FullComponentDiagram.png" alt="Fullcomponentdiagram" /></p>
<h2 id='data-holder-2'>Data Holder</h2>
<table><thead>
<tr>
<th>Component</th>
<th>Responsibility</th>
</tr>
</thead><tbody>
<tr>
<td><strong>Identity Provider</strong></td>
<td>Provides identity services to the Data Holder’s platform for identifying Accredited Data Recipients and the CDR Register</td>
</tr>
<tr>
<td><strong>Authorisation and Consent Manager</strong></td>
<td>Provides authorisation functionality to the consumer including consent withdrawal propagation to the relevant Accredited Data Recipients</td>
</tr>
<tr>
<td><strong>Secrets Manager</strong></td>
<td>Provides key management for issuance/rotation of JWKs & certificates and storing of authorisations</td>
</tr>
<tr>
<td><strong>Standards Platform</strong></td>
<td>Exposes banking, consumer and product data to Accredited Data Recipients as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-banking-apis">Banking APIs</a> and <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-common-apis">Common APIs</a></td>
</tr>
<tr>
<td><strong>MetaData Cache</strong></td>
<td>Cache of discovered Accredited Data Recipients and their associated Software Products within the CDR ecosystem. Caching rules and logic are described at: <a href="#metadata-cache-management">Metadata Cache Management</a></td>
</tr>
<tr>
<td><strong>Metrics</strong></td>
<td>Facilitates <a href="https://consumerdatastandardsaustralia.github.io/standards/#get-metrics">Get Metrics</a> requests from the CDR Register as per the Consumer Data Standards. Data Holders must report this information separately for each of their brands. The CDR Register will therefore collect these metrics per Data Holder Brand.</td>
</tr>
<tr>
<td><strong>Authorisation Dashboard</strong></td>
<td>The Dashboard provided to the consumer to view their current sharing authorisations with the Data Holder. The dashboard also provides the functionality to explicitly withdraw these authorisations with this Data Holder. Details can be found in the <a href="https://consumerdatastandards.org.au/cx-standards">CX Guidelines</a></td>
</tr>
</tbody></table>
<table><thead>
<tr>
<th>API</th>
<th>Responsibility</th>
</tr>
</thead><tbody>
<tr>
<td><strong>Banking APIs</strong></td>
<td>APIs exposing banking data as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-banking-apis">Banking APIs</a></td>
</tr>
<tr>
<td><strong>Common APIs</strong></td>
<td>APIs exposing common data as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-common-apis">Common APIs</a></td>
</tr>
<tr>
<td><strong>InfoSec APIs</strong></td>
<td>APIs exposing endpoints to facilitate the InfoSec profile as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#end-points">Endpoints</a></td>
</tr>
<tr>
<td><strong>Registration APIs</strong></td>
<td>APIs exposing dynamic registration endpoints as described at <a href="#dynamic-client-registration">Dynamic Client Registration</a></td>
</tr>
<tr>
<td><strong>Admin APIs</strong></td>
<td>APIs exposing metrics data as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#admin-apis">Admin APIs</a></td>
</tr>
</tbody></table>
<h2 id='accredited-data-recipient-2'>Accredited Data Recipient</h2>
<table><thead>
<tr>
<th>Component</th>
<th>Responsibility</th>
</tr>
</thead><tbody>
<tr>
<td><strong>Software Application(s)</strong></td>
<td>One or more consumer facing applications provided by the Accredited Data Recipient</td>
</tr>
<tr>
<td><strong>Application Platform</strong></td>
<td>Accredited Data Recipient’s application platform which requests consumer and product data from Data Holders as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-banking-apis">Banking APIs</a> and <a href="https://consumerdatastandardsaustralia.github.io/standards/#consumer-data-standards-common-apis">Common APIs</a></td>
</tr>
<tr>
<td><strong>Consent Manager</strong></td>
<td>Provides consent functionality to the consumer including consent withdrawal propagation to the relevant Data Holder</td>
</tr>
<tr>
<td><strong>Secrets Manager</strong></td>
<td>Provides key management for issuance/rotation of JWKS & certificates and storing of consents</td>
</tr>
<tr>
<td><strong>MetaData Cache</strong></td>
<td>Cache of discovered Data Holders within the CDR ecosystem. Caching rules and logic are described at: <br> <a href="#metadata-cache-management">Metadata Cache Management</a></td>
</tr>
<tr>
<td><strong>Consent Dashboard</strong></td>
<td>The Dashboard provided to the consumer to view the consents given to this Accredited Data Recipient to collect and use CDR data. The Dashboard also provides the functionality to explicitly withdraw these consents with this Accredited Data Recipient. Details can be found in the <a href="https://consumerdatastandards.org.au/cx-standards">CX Guidelines</a></a></td>
</tr>
</tbody></table>
<table><thead>
<tr>
<th>API</th>
<th>Responsibility</th>
</tr>
</thead><tbody>
<tr>
<td><strong>InfoSec APIs</strong></td>
<td>APIs exposing endpoints to facilitate the InfoSec profile as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#end-points">Endpoints</a>. This covers the revocation and CDR arrangement management endpoints, to facilitate bi-directional consent revocation as well as the Data Recipient JWKS endpoint</td>
</tr>
</tbody></table>
<h2 id='register'>Register</h2>
<p>The Register exposed APIs to satisfy the following main requirements:</p>
<p><strong>1.</strong> Facilitates discovery of Data Holders and their endpoint details within the CDR regime</br>
<strong>2.</strong> Facilitates discovery of Data Recipient details within the CDR regime</br>
<strong>3.</strong> Provides SSAs to facilitate Dynamic Client Registration</br>
<strong>4.</strong> Provides public JWKS to assert SSAs are trusted by the CDR Register</br>
<strong>5.</strong> Collect ecosystem metrics from participating Data Holders as per the Consumer Data Standards <a href="https://consumerdatastandardsaustralia.github.io/standards/#get-metrics">Get Metrics</a></br></p>
<table><thead>
<tr>
<th>API</th>
<th>Responsibility</th>
</tr>
</thead><tbody>
<tr>
<td><strong>Discovery APIs (DH & DR)</strong></td>
<td>APIs exposing the discovery of Data Holder Brands and Data Recipients within the CDR regime. </br>APIs are described at: <a href="#getdataholderbrands">GetDataHolderBrands</a>, <a href="#getdatarecipients">GetDataRecipients</a></td>
</tr>
<tr>
<td><strong>Status APIs</strong></td>
<td>APIs exposing the statuses of Accredited Data Recipients and associated Software Products within the CDR regime. </br>APIs are described at: <a href="#getdatarecipientsstatus">GetDataRecipientsStatus</a>, <a href="#getsoftwareproductsstatus">GetSoftwareProductsStatus</a></td>
</tr>
<tr>
<td><strong>SSA API</strong></td>
<td>API exposing the retrieval of SSAs used by Accredited Data Recipients to register with Data Holders within the CDR regime. </br>API is described at: <a href="#getsoftwarestatementassertion-ssa">GetSoftwareStatementAssertion</a></td>
</tr>
<tr>
<td><strong>InfoSec APIs</strong></td>
<td>API exposing endpoints to facilitate OIDC as well as exposing Register public JWKS used to verify the signature of SSA payloads. Further details are available at: <a href="#dynamic-client-registration">Dynamic Client Registration</a></td>
</tr>
</tbody></table>
<h2 id='certificate-authority'>Certificate Authority</h2>
<p>The CDR Register will be using DigiCert as the ACCC endorsed Certificate Authority. Further details on certificate management can be found at:
<a href="#certificate-management">Certificate Management</a></p>
<h1 id='intermediaries'>Intermediaries</h1>
<p>The CDR Register design accommodates intermediaries within the CDR ecosystem.</p>
<h2 id='collection-arrangements'>Collection Arrangements</h2>
<p>Collection arrangements allow for outsourced service providers (’provider’) that are accredited to collect CDR data on behalf of another accredited person (‘principal’). An ‘outsourcing arrangement’ as provided for in the rules will need to be in place between the provider and the principal.</p>
<p>For a reference on how these rules may be implemented, a technical commentary has been published on the <a href="https://cdr-support.zendesk.com/hc/en-us/articles/900003114503-Collection-Arrangement">CDR Support Portal</a></p>
<h3 id='responsibilities'>Responsibilities</h3>
<p>The process of collecting consumer data involves a number of functions. Collection arrangements allow for the responsibilities of these to be assigned to either the provider or principal.</p>
<p><img src="images/ComponentDiagramCollectionArrangement.png" ></img></p>
<p>This diagram models how the scope of responsibilities MAY be split between a principal and a provider collecting on the principal’s behalf. A subset of the principal’s responsibilities can therefore be handled by the provider, allowing them to:</p>
<ul>
<li>specialise in the security and functional requirements of participating in the CDR; and</li>
<li>achieve economies of scale when becoming multi-tenanted and servicing multiple principals in the ecosystem.</li>
</ul>
<h3 id='authentication-with-the-cdr-register'>Authentication with the CDR Register</h3>
<p>Authentication with the Register has been enhanced to allow authentication using the <code>data_recipient_brand_id</code> to alternatively authenticating with the <code>software_product_id</code>.
This change allows the provider to have the capability to maintain the software product and associated registrations on behalf of an accredited data recipient principal.</p>
<p>Please refer to the <a href="#client-authentication">Client Authentication</a> section for further details.</p>
<h3 id='accreditation-status-discovery'>Accreditation Status Discovery</h3>
<p>The status of a software product, managed within a collection arrangement, will be coupled to the accreditation status of both the principal and provider in this arrangement.</p>
<p>To achieve this, cascade rules for software product statuses, as defined in <a href="#accredited-data-recipient-and-software-product-statuses">Status Mapping</a>, will be defined for a collection arrangement as follows:</p>
<table><thead>
<tr>
<th>Provider Status</th>
<th>Principal Status</th>
<th>Cascaded Principal SP Status</th>
</tr>
</thead><tbody>
<tr>
<td>Active</td>
<td>Active</td>
<td>Active</td>
</tr>
<tr>
<td>Suspended</td>
<td>Active</td>
<td>Inactive</td>
</tr>
<tr>
<td>Revoked</td>
<td>Active</td>
<td>Inactive</td>
</tr>
<tr>
<td>Surrendered</td>
<td>Active</td>
<td>Inactive</td>
</tr>
<tr>
<td>Any</td>
<td>Suspended</td>
<td>Inactive</td>
</tr>
<tr>
<td>Any</td>
<td>Revoked</td>
<td>Removed</td>
</tr>
<tr>
<td>Any</td>
<td>Surrendered</td>
<td>Removed</td>
</tr>
</tbody></table>
<h1 id='client-registration'>Client Registration</h1><h2 id='dynamic-client-registration'>Dynamic Client Registration</h2>
<p>Accredited Data Recipient Software Products within the Consumer Data Right will dynamically register with one or more Data Holders, to obtain client credentials used to retrieve consumer data on behalf of a consumer.</p>
<p>The CDR Registration model follows standard <a href="https://tools.ietf.org/html/rfc7591"><strong>[RFC7591]</strong></a> and is derived from <a href="https://openbanking.atlassian.net/wiki/spaces/DZ/pages/36667724/The+OpenBanking+OpenID+Dynamic+Client+Registration+Specification+-+v1.0.0-rc2"><strong>Open Banking UK model</strong></a> with design input from the <a href="https://github.com/cdr-register/register/files/3577911/ABA_RESPONSE_DYvS_SA_05092019_Appendix.pdf"><strong>ABA</strong></a></p>
<p><strong>Pre-Requisites:</strong> Prior to Client Registration, the registering Data Recipient must be accredited and the associated Software Product must be configured within the CDR Register</p>
<h3 id='software-statement-assertion-ssa-design'>Software Statement Assertion (SSA) Design</h3>
<p>A Software Statement is defined in <strong>[RFC7591]</strong> as:
A digitally signed JSON Web Token (JWT) <strong>[RFC7519]</strong> that asserts metadata values about the client software</p>
<p>Within the Consumer Data Right, the CDR Register will issue Software Statements for Accredited Data Recipient Software Products</p>
<p>The trust relationship the authorization server has with the issuer of the software statement is to be used as an input to the evaluation of whether the registration request is accepted.</p>
<p>A software statement is presented by Accredited Data Recipient’s Software Product to Data Holder’s authorisation server as part of a client registration request.</p>
<p>An SSA will be issued for each <em>active</em> Software Product and is retrievable using the CDR Register <a href="#getsoftwarestatementassertion-ssa">GetSoftwareStatementAssertion API</a></p>
<h3 id='namespacing'>Namespacing</h3>
<p>The design will conform to <strong>[RFC7591]</strong> and will not use the software namespace convention as used in the Open Banking UK Dynamic Registration Standard</p>
<h3 id='digital-signing-algorithm'>Digital Signing Algorithm</h3>
<p>Conforming to <strong>[FAPI-RW]</strong>, SSAs will be signed on the CDR Register using <strong>PS256</strong></p>
<h3 id='ssa-lifetime'>SSA Lifetime</h3>
<table><thead>
<tr>
<th>Method</th>
<th>Lifetime (mins)</th>
<th>Notes</th>
</tr>
</thead><tbody>
<tr>
<td><strong>Obtain via API</strong></td>
<td>10</td>
<td>The intention here is this should be sufficient time to </br>batch register with all relevant Data Holders</td>
</tr>
</tbody></table>
<h3 id='ssa-definition'>SSA Definition</h3>
<blockquote>
<p>Example SSA:</p>
</blockquote>
<pre class="highlight plaintext"><code>eyJhbGciOiJQUzI1NiIsImtpZCI6ImI4ZmFjZjJmZjM5NDQ0Zjc4MWUwYmU1ZGI0YjE0ZjE2IiwidHlwIjoiSldUIn0.ew0KICAiaXNzIjogImNkci1yZWdpc3RlciIsDQogICJpYXQiOiAxNTcxODA4MTY3LA0KICAiZXhwIjogMjE0NzQ4MzY0NiwNCiAgImp0aSI6ICIzYmMyMDVhMWViYzk0M2ZiYjYyNGIxNGZjYjI0MTE5NiIsDQogICJvcmdfaWQiOiAiM0IwQjBBN0ItM0U3Qi00QTJDLTk0OTctRTM1N0E3MUQwN0M4IiwNCiAgIm9yZ19uYW1lIjogIk1vY2sgQ29tcGFueSBJbmMuIiwNCiAgImNsaWVudF9uYW1lIjogIk1vY2sgU29mdHdhcmUiLA0KICAiY2xpZW50X2Rlc2NyaXB0aW9uIjogIkEgbW9jayBzb2Z0d2FyZSBwcm9kdWN0IGZvciB0ZXN0aW5nIFNTQSIsDQogICJjbGllbnRfdXJpIjogImh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdSIsDQogICJyZWRpcmVjdF91cmlzIjogWw0KICAgICJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvcmVkaXJlY3RzL3JlZGlyZWN0MSIsDQogICAgImh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS9yZWRpcmVjdHMvcmVkaXJlY3QyIg0KICBdLA0KICAibG9nb191cmkiOiAiaHR0cHM6Ly93d3cubW9ja2NvbXBhbnkuY29tLmF1L2xvZ29zL2xvZ28xLnBuZyIsDQogICJ0b3NfdXJpIjogImh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS90b3MuaHRtbCIsDQogICJwb2xpY3lfdXJpIjogImh0dHBzOi8vd3d3Lm1vY2tjb21wYW55LmNvbS5hdS9wb2xpY3kuaHRtbCIsDQogICJqd2tzX3VyaSI6ICJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvandrcyIsDQogICJyZXZvY2F0aW9uX3VyaSI6ICJodHRwczovL3d3dy5tb2NrY29tcGFueS5jb20uYXUvcmV2b2NhdGlvbiIsDQogICJzb2Z0d2FyZV9pZCI6ICI3NDBDMzY4Ri1FQ0Y5LTREMjktQTJFQS0wNTE0QTY2QjBDREUiLA0KICAic29mdHdhcmVfcm9sZXMiOiAiZGF0YS1yZWNpcGllbnQtc29mdHdhcmUtcHJvZHVjdCIsDQogICJzY29wZSI6ICJiYW5rOmFjY291bnRzLmJhc2ljOnJlYWQgYmFuazphY2NvdW50cy5kZXRhaWw6cmVhZCBiYW5rOnRyYW5zYWN0aW9uczpyZWFkIGJhbms6cGF5ZWVzOnJlYWQgYmFuazpyZWd1bGFyX3BheW1lbnRzOnJlYWQgY29tbW9uOmN1c3RvbWVyLmJhc2ljOnJlYWQgY29tbW9uOmN1c3RvbWVyLmRldGFpbDpyZWFkIg0KfQ.ZNKe8aBHcsZ_OfdP0GvUa0AHrjcoC0Coky4jQHrPsRoG3YMcS2XG9JtyB5zq-AMOQoaib1Ijx1m7B-JOEbVcnNJcLUZeVEIwnP8hRssAnGjWwaYGUAiY-DEFUsuXqpQWgyIOFz84W-FaHFcqpOSGxjGmjICZU9S1Pl4o8b5poA_kJ2n_wdiOBUG4xl3uXqzK_vstcGXbAubFyLhjOxhc_rqONO2NCtpyCwj83Zqi7Ve_A27-ty5N0AQa2xYWvjDt_Xh8xcxRI_ih7_sStvDTTy3gtyX5bAdXsDsweCcvN0d2vOCpm6-dnr8D1fXDTnlT3x2uQ0XAysWr6wU4mAZFVA
</code></pre>
<blockquote>
<p>Associated JWKS:</p>
</blockquote>
<pre class="highlight plaintext"><code>{
"keys": [
{
"kid": "b8facf2ff39444f781e0be5db4b14f16",
"kty": "RSA",
"key_ops": [
"sign",
"verify"
],
"n": "s0zGoaOEJE8HDfHjWtO0xLXtuPcwio8BEoj0-uu9kxxDIF7jH0jb06EwoPkb83BET59x6C0TtRfc_I5ZDksQKRClWXzbazqi62M5YhCgwyB-S09PJb8P1GfQBYyK346nLKARHbFJ1t1SHARcVFJA_8NeHfQn_0fyEc55R3GGNDL3YQtjEoTb-LMR-KpcPB2BpyDuie-jk-3f1t0EfvnkVp-6co1_KTXrbwuYtH31YBZLgU4JeZEJLTnGdMKmJppZ9SnyrBB461hMmw0HJHJj6uZJSiP2onmvlrUezv1T3NM3HOE7WHxlps9MUJj3vcpea-O6n5JBX8emTduLuLuKuw",
"e": "AQAB"
}
]
}
</code></pre>
<blockquote>
<p>Decoded SSA</p>
</blockquote>
<pre class="highlight plaintext"><code>{
"alg": "PS256",
"kid": "b8facf2ff39444f781e0be5db4b14f16",
"typ": "JWT"
}