@pdtf/schemas 3.6.0-dev.1 → 3.6.0-dev.10

This diff represents the content of publicly available package versions that have been released to one of the supported registries. The information contained in this diff is provided for informational purposes only and reflects changes between package versions as they appear in their respective public registries.
Files changed (53) hide show
  1. package/package.json +9 -1
  2. package/src/schemas/v3/combined.json +662 -178
  3. package/src/schemas/v3/compactSkeleton.txt +63 -0
  4. package/src/schemas/v3/overlays/baspi4.json +43 -73
  5. package/src/schemas/v3/overlays/baspi5.json +43 -73
  6. package/src/schemas/v3/overlays/extensions/ac.json +2 -1
  7. package/src/schemas/v3/overlays/extensions/dk.json +3 -2
  8. package/src/schemas/v3/overlays/extensions/ic.json +44 -9
  9. package/src/schemas/v3/overlays/extensions/lc.json +3 -2
  10. package/src/schemas/v3/overlays/extensions/mi.json +2 -1
  11. package/src/schemas/v3/overlays/extensions/nd.json +3 -2
  12. package/src/schemas/v3/overlays/extensions/pc.json +3 -2
  13. package/src/schemas/v3/overlays/extensions/ph.json +2 -1
  14. package/src/schemas/v3/overlays/extensions/rw.json +4 -3
  15. package/src/schemas/v3/overlays/extensions/sc.json +8 -4
  16. package/src/schemas/v3/overlays/extensions/sd.json +3 -2
  17. package/src/schemas/v3/overlays/extensions/ta.json +0 -48
  18. package/src/schemas/v3/overlays/extensions/tr.json +3 -2
  19. package/src/schemas/v3/overlays/extensions/wg.json +2 -1
  20. package/src/schemas/v3/overlays/llc1.json +1 -2
  21. package/src/schemas/v3/overlays/lpe1.json +1 -1
  22. package/src/schemas/v3/overlays/nts.json +3 -1
  23. package/src/schemas/v3/overlays/nts2.json +3 -1
  24. package/src/schemas/v3/overlays/ntsl.json +3 -1
  25. package/src/schemas/v3/overlays/ntsl2.json +3 -1
  26. package/src/schemas/v3/overlays/piq.json +23 -24
  27. package/src/schemas/v3/overlays/rds.json +22 -49
  28. package/src/schemas/v3/overlays/sef25.json +16 -2
  29. package/src/schemas/v3/overlays/ta10.json +0 -9
  30. package/src/schemas/v3/overlays/ta6.json +37 -69
  31. package/src/schemas/v3/overlays/ta6ed6.json +248 -140
  32. package/src/schemas/v3/overlays/ta7ed5.json +66 -20
  33. package/src/schemas/v3/pdtf-transaction.json +397 -95
  34. package/src/schemas/v3/skeleton.json +70 -5
  35. package/src/utils/extractExtensionOverlays.js +11 -2
  36. package/src/utils/extractOverlay.js +20 -0
  37. package/CLAUDE.md +0 -101
  38. package/docs/backend-lms-profile-filtering-spec.md +0 -180
  39. package/src/examples/v1/exampleAddParticipantVouch.json +0 -32
  40. package/src/examples/v1/exampleDocumentedVouch.json +0 -40
  41. package/src/examples/v1/exampleElectronicRecord.json +0 -30
  42. package/src/examples/v1/exampleTransaction.json +0 -878
  43. package/src/examples/v1/exampleVouch.json +0 -25
  44. package/src/examples/v2/exampleTransaction.json +0 -901
  45. package/src/examples/v3/exampleAddParticipantVouch.json +0 -38
  46. package/src/examples/v3/exampleCustomOverlay.json +0 -55
  47. package/src/examples/v3/exampleCustomOverlay2.json +0 -93
  48. package/src/examples/v3/exampleDocumentedVouch.json +0 -47
  49. package/src/examples/v3/exampleElectronicRecord.json +0 -36
  50. package/src/examples/v3/exampleTransaction.json +0 -1038
  51. package/src/examples/v3/exampleVouch.json +0 -32
  52. package/src/mappings/SendPropertyDetailsRequestSchema.json +0 -1588
  53. package/src/mappings/adf.js +0 -198
package/src/schemas/v3/pdtf-transaction.json CHANGED
@@ -198,7 +198,8 @@
198
198
  "Mortgage Broker",
199
199
  "Lender",
200
200
  "Landlord",
201
- "Tenant"
201
+ "Tenant",
202
+ "Platform Support"
202
203
  ]
203
204
  },
204
205
  "externalIds": {
@@ -392,7 +393,8 @@
392
393
  "Mortgage Broker",
393
394
  "Lender",
394
395
  "Landlord",
395
- "Tenant"
396
+ "Tenant",
397
+ "Platform Support"
396
398
  ]
397
399
  }
398
400
  }
@@ -638,6 +640,39 @@
638
640
  }
639
641
  }
640
642
  },
643
+ "ruralUrbanClassification": {
644
+ "title": "ONS Rural Urban Classification (2021)",
645
+ "description": "The human-readable Rural Urban Classification for the area containing this property. For England and Wales this is the ONS 2021 RUC21 category (e.g. \"Urban: Nearer to a major town or city\", \"Larger rural: Further from a major town or city\", \"Smaller rural: Nearer to a major town or city\"). For Scotland this is the Scottish Government Urban Rural Classification category (e.g. \"Large Urban Areas\", \"Remote Rural\"), which uses a different scheme and is not represented in ruralUrbanCode.",
646
+ "type": "string"
647
+ },
648
+ "ruralUrbanCode": {
649
+ "title": "ONS Rural Urban Classification code (2021)",
650
+ "description": "The ONS 2021 Rural Urban Classification code for the Output Area containing this property (England and Wales only). UN1 = Urban: Nearer to a major town or city; UF1 = Urban: Further from a major town or city; RLN1 = Larger rural: Nearer; RLF1 = Larger rural: Further; RSN1 = Smaller rural: Nearer; RSF1 = Smaller rural: Further.",
651
+ "type": "string",
652
+ "enum": [
653
+ "UN1",
654
+ "UF1",
655
+ "RLN1",
656
+ "RLF1",
657
+ "RSN1",
658
+ "RSF1"
659
+ ]
660
+ },
661
+ "region": {
662
+ "title": "Government Office Region",
663
+ "description": "The Government Office Region for this property (e.g. East Midlands, London, South East). England and Wales only.",
664
+ "type": "string"
665
+ },
666
+ "parish": {
667
+ "title": "Civil parish",
668
+ "description": "The civil parish or community (Wales) for this property, if applicable.",
669
+ "type": "string"
670
+ },
671
+ "outputArea": {
672
+ "title": "Census Output Area code (2021)",
673
+ "description": "The ONS 2021 Census Output Area code for this property.",
674
+ "type": "string"
675
+ },
641
676
  "googleStreetViewPOV": {
642
677
  "title": "Street View to render street nearby property in Google Street View",
643
678
  "type": "object",
@@ -921,6 +956,11 @@
921
956
  "Yes",
922
957
  "No"
923
958
  ]
959
+ },
960
+ "detailsAnalysis": {
961
+ "type": "object",
962
+ "additionalProperties": true,
963
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
924
964
  }
925
965
  },
926
966
  "required": [
@@ -6230,6 +6270,11 @@
6230
6270
  "Yes",
6231
6271
  "No"
6232
6272
  ]
6273
+ },
6274
+ "detailsAnalysis": {
6275
+ "type": "object",
6276
+ "additionalProperties": true,
6277
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
6233
6278
  }
6234
6279
  },
6235
6280
  "oneOf": [
@@ -6324,6 +6369,11 @@
6324
6369
  "Yes",
6325
6370
  "No"
6326
6371
  ]
6372
+ },
6373
+ "detailsAnalysis": {
6374
+ "type": "object",
6375
+ "additionalProperties": true,
6376
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
6327
6377
  }
6328
6378
  },
6329
6379
  "oneOf": [
@@ -6459,6 +6509,11 @@
6459
6509
  "Anticipated",
6460
6510
  "Not applicable"
6461
6511
  ]
6512
+ },
6513
+ "detailsAnalysis": {
6514
+ "type": "object",
6515
+ "additionalProperties": true,
6516
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
6462
6517
  }
6463
6518
  },
6464
6519
  "oneOf": [
@@ -6500,6 +6555,11 @@
6500
6555
  "Yes",
6501
6556
  "No"
6502
6557
  ]
6558
+ },
6559
+ "detailsAnalysis": {
6560
+ "type": "object",
6561
+ "additionalProperties": true,
6562
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
6503
6563
  }
6504
6564
  },
6505
6565
  "oneOf": [
@@ -6968,7 +7028,7 @@
6968
7028
  "assessmentsCarriedOut": {
6969
7029
  "enum": [
6970
7030
  "Fire risk assessment",
6971
- "External Wall fire risk assessment",
7031
+ "External wall fire risk assessment",
6972
7032
  "Both"
6973
7033
  ]
6974
7034
  },
@@ -7284,6 +7344,11 @@
7284
7344
  "Yes",
7285
7345
  "No"
7286
7346
  ]
7347
+ },
7348
+ "detailsAnalysis": {
7349
+ "type": "object",
7350
+ "additionalProperties": true,
7351
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
7287
7352
  }
7288
7353
  },
7289
7354
  "oneOf": [
@@ -7323,6 +7388,11 @@
7323
7388
  "Yes",
7324
7389
  "No"
7325
7390
  ]
7391
+ },
7392
+ "detailsAnalysis": {
7393
+ "type": "object",
7394
+ "additionalProperties": true,
7395
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
7326
7396
  }
7327
7397
  },
7328
7398
  "oneOf": [
@@ -7488,6 +7558,11 @@
7488
7558
  "Yes",
7489
7559
  "No"
7490
7560
  ]
7561
+ },
7562
+ "detailsAnalysis": {
7563
+ "type": "object",
7564
+ "additionalProperties": true,
7565
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
7491
7566
  }
7492
7567
  },
7493
7568
  "oneOf": [
@@ -8600,6 +8675,11 @@
8600
8675
  "No",
8601
8676
  "Not known"
8602
8677
  ]
8678
+ },
8679
+ "detailsAnalysis": {
8680
+ "type": "object",
8681
+ "additionalProperties": true,
8682
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8603
8683
  }
8604
8684
  },
8605
8685
  "oneOf": [
@@ -8729,6 +8809,11 @@
8729
8809
  "Yes",
8730
8810
  "No"
8731
8811
  ]
8812
+ },
8813
+ "detailsAnalysis": {
8814
+ "type": "object",
8815
+ "additionalProperties": true,
8816
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8732
8817
  }
8733
8818
  },
8734
8819
  "oneOf": [
@@ -8796,6 +8881,11 @@
8796
8881
  "Yes",
8797
8882
  "No"
8798
8883
  ]
8884
+ },
8885
+ "detailsAnalysis": {
8886
+ "type": "object",
8887
+ "additionalProperties": true,
8888
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8799
8889
  }
8800
8890
  },
8801
8891
  "oneOf": [
@@ -8849,6 +8939,11 @@
8849
8939
  "Not applicable",
8850
8940
  "Not known"
8851
8941
  ]
8942
+ },
8943
+ "detailsAnalysis": {
8944
+ "type": "object",
8945
+ "additionalProperties": true,
8946
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8852
8947
  }
8853
8948
  },
8854
8949
  "oneOf": [
@@ -8856,7 +8951,9 @@
8856
8951
  "properties": {
8857
8952
  "yesNo": {
8858
8953
  "enum": [
8859
- "No"
8954
+ "No",
8955
+ "Not applicable",
8956
+ "Not known"
8860
8957
  ]
8861
8958
  }
8862
8959
  }
@@ -8916,6 +9013,11 @@
8916
9013
  "Yes",
8917
9014
  "No"
8918
9015
  ]
9016
+ },
9017
+ "detailsAnalysis": {
9018
+ "type": "object",
9019
+ "additionalProperties": true,
9020
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8919
9021
  }
8920
9022
  },
8921
9023
  "oneOf": [
@@ -8971,6 +9073,11 @@
8971
9073
  "Yes",
8972
9074
  "No"
8973
9075
  ]
9076
+ },
9077
+ "detailsAnalysis": {
9078
+ "type": "object",
9079
+ "additionalProperties": true,
9080
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
8974
9081
  }
8975
9082
  },
8976
9083
  "oneOf": [
@@ -9516,6 +9623,11 @@
9516
9623
  "Yes",
9517
9624
  "No"
9518
9625
  ]
9626
+ },
9627
+ "detailsAnalysis": {
9628
+ "type": "object",
9629
+ "additionalProperties": true,
9630
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9519
9631
  }
9520
9632
  },
9521
9633
  "oneOf": [
@@ -9555,6 +9667,11 @@
9555
9667
  "Yes",
9556
9668
  "No"
9557
9669
  ]
9670
+ },
9671
+ "detailsAnalysis": {
9672
+ "type": "object",
9673
+ "additionalProperties": true,
9674
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9558
9675
  }
9559
9676
  },
9560
9677
  "oneOf": [
@@ -9601,6 +9718,11 @@
9601
9718
  "Yes",
9602
9719
  "No"
9603
9720
  ]
9721
+ },
9722
+ "detailsAnalysis": {
9723
+ "type": "object",
9724
+ "additionalProperties": true,
9725
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9604
9726
  }
9605
9727
  },
9606
9728
  "oneOf": [
@@ -9637,6 +9759,11 @@
9637
9759
  "No",
9638
9760
  "Not required"
9639
9761
  ]
9762
+ },
9763
+ "detailsAnalysis": {
9764
+ "type": "object",
9765
+ "additionalProperties": true,
9766
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9640
9767
  }
9641
9768
  },
9642
9769
  "oneOf": [
@@ -9687,6 +9814,11 @@
9687
9814
  "No",
9688
9815
  "Not required"
9689
9816
  ]
9817
+ },
9818
+ "detailsAnalysis": {
9819
+ "type": "object",
9820
+ "additionalProperties": true,
9821
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9690
9822
  }
9691
9823
  },
9692
9824
  "oneOf": [
@@ -9838,6 +9970,11 @@
9838
9970
  "Yes",
9839
9971
  "No"
9840
9972
  ]
9973
+ },
9974
+ "detailsAnalysis": {
9975
+ "type": "object",
9976
+ "additionalProperties": true,
9977
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9841
9978
  }
9842
9979
  },
9843
9980
  "oneOf": [
@@ -9878,6 +10015,11 @@
9878
10015
  "No",
9879
10016
  "Not required"
9880
10017
  ]
10018
+ },
10019
+ "detailsAnalysis": {
10020
+ "type": "object",
10021
+ "additionalProperties": true,
10022
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
9881
10023
  }
9882
10024
  },
9883
10025
  "oneOf": [
@@ -10127,6 +10269,11 @@
10127
10269
  "Yes",
10128
10270
  "No"
10129
10271
  ]
10272
+ },
10273
+ "detailsAnalysis": {
10274
+ "type": "object",
10275
+ "additionalProperties": true,
10276
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
10130
10277
  }
10131
10278
  },
10132
10279
  "oneOf": [
@@ -10167,6 +10314,11 @@
10167
10314
  "No",
10168
10315
  "Not required"
10169
10316
  ]
10317
+ },
10318
+ "detailsAnalysis": {
10319
+ "type": "object",
10320
+ "additionalProperties": true,
10321
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
10170
10322
  }
10171
10323
  },
10172
10324
  "oneOf": [
@@ -10601,6 +10753,11 @@
10601
10753
  "Yes",
10602
10754
  "No"
10603
10755
  ]
10756
+ },
10757
+ "detailsAnalysis": {
10758
+ "type": "object",
10759
+ "additionalProperties": true,
10760
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
10604
10761
  }
10605
10762
  },
10606
10763
  "oneOf": [
@@ -10641,6 +10798,11 @@
10641
10798
  "No",
10642
10799
  "Not required"
10643
10800
  ]
10801
+ },
10802
+ "detailsAnalysis": {
10803
+ "type": "object",
10804
+ "additionalProperties": true,
10805
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
10644
10806
  }
10645
10807
  },
10646
10808
  "oneOf": [
@@ -12000,6 +12162,11 @@
12000
12162
  "Yes",
12001
12163
  "No"
12002
12164
  ]
12165
+ },
12166
+ "detailsAnalysis": {
12167
+ "type": "object",
12168
+ "additionalProperties": true,
12169
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
12003
12170
  }
12004
12171
  },
12005
12172
  "oneOf": [
@@ -12047,6 +12214,11 @@
12047
12214
  "Yes",
12048
12215
  "No"
12049
12216
  ]
12217
+ },
12218
+ "detailsAnalysis": {
12219
+ "type": "object",
12220
+ "additionalProperties": true,
12221
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
12050
12222
  }
12051
12223
  },
12052
12224
  "oneOf": [
@@ -12102,6 +12274,11 @@
12102
12274
  "Yes",
12103
12275
  "No"
12104
12276
  ]
12277
+ },
12278
+ "detailsAnalysis": {
12279
+ "type": "object",
12280
+ "additionalProperties": true,
12281
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
12105
12282
  }
12106
12283
  },
12107
12284
  "oneOf": [
@@ -12399,6 +12576,11 @@
12399
12576
  "Yes",
12400
12577
  "No"
12401
12578
  ]
12579
+ },
12580
+ "detailsAnalysis": {
12581
+ "type": "object",
12582
+ "additionalProperties": true,
12583
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
12402
12584
  }
12403
12585
  },
12404
12586
  "oneOf": [
@@ -12711,6 +12893,11 @@
12711
12893
  "Yes",
12712
12894
  "No"
12713
12895
  ]
12896
+ },
12897
+ "detailsAnalysis": {
12898
+ "type": "object",
12899
+ "additionalProperties": true,
12900
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
12714
12901
  }
12715
12902
  },
12716
12903
  "oneOf": [
@@ -14606,15 +14793,6 @@
14606
14793
  }
14607
14794
  }
14608
14795
  }
14609
- },
14610
- {
14611
- "properties": {
14612
- "isIncludedOrExcluded": {
14613
- "enum": [
14614
- "None"
14615
- ]
14616
- }
14617
- }
14618
14796
  }
14619
14797
  ]
14620
14798
  }
@@ -18031,6 +18209,11 @@
18031
18209
  "Yes",
18032
18210
  "No"
18033
18211
  ]
18212
+ },
18213
+ "detailsAnalysis": {
18214
+ "type": "object",
18215
+ "additionalProperties": true,
18216
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
18034
18217
  }
18035
18218
  },
18036
18219
  "oneOf": [
@@ -18121,6 +18304,11 @@
18121
18304
  "Yes",
18122
18305
  "No"
18123
18306
  ]
18307
+ },
18308
+ "detailsAnalysis": {
18309
+ "type": "object",
18310
+ "additionalProperties": true,
18311
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
18124
18312
  }
18125
18313
  },
18126
18314
  "oneOf": [
@@ -19875,6 +20063,11 @@
19875
20063
  "Room heaters only",
19876
20064
  "None"
19877
20065
  ]
20066
+ },
20067
+ "detailsAnalysis": {
20068
+ "type": "object",
20069
+ "additionalProperties": true,
20070
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
19878
20071
  }
19879
20072
  },
19880
20073
  "oneOf": [
@@ -20083,7 +20276,8 @@
20083
20276
  "properties": {
20084
20277
  "yesNo": {
20085
20278
  "enum": [
20086
- "No"
20279
+ "No",
20280
+ "Not known"
20087
20281
  ]
20088
20282
  }
20089
20283
  }
@@ -20150,7 +20344,8 @@
20150
20344
  "properties": {
20151
20345
  "yesNo": {
20152
20346
  "enum": [
20153
- "Yes"
20347
+ "Yes",
20348
+ "Not known"
20154
20349
  ]
20155
20350
  }
20156
20351
  }
@@ -20599,6 +20794,11 @@
20599
20794
  "Yes",
20600
20795
  "No"
20601
20796
  ]
20797
+ },
20798
+ "detailsAnalysis": {
20799
+ "type": "object",
20800
+ "additionalProperties": true,
20801
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
20602
20802
  }
20603
20803
  },
20604
20804
  "oneOf": [
@@ -20638,6 +20838,11 @@
20638
20838
  "Yes",
20639
20839
  "No"
20640
20840
  ]
20841
+ },
20842
+ "detailsAnalysis": {
20843
+ "type": "object",
20844
+ "additionalProperties": true,
20845
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
20641
20846
  }
20642
20847
  },
20643
20848
  "oneOf": [
@@ -20677,6 +20882,11 @@
20677
20882
  "Yes",
20678
20883
  "No"
20679
20884
  ]
20885
+ },
20886
+ "detailsAnalysis": {
20887
+ "type": "object",
20888
+ "additionalProperties": true,
20889
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
20680
20890
  }
20681
20891
  },
20682
20892
  "oneOf": [
@@ -20716,6 +20926,11 @@
20716
20926
  "Yes",
20717
20927
  "No"
20718
20928
  ]
20929
+ },
20930
+ "detailsAnalysis": {
20931
+ "type": "object",
20932
+ "additionalProperties": true,
20933
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
20719
20934
  }
20720
20935
  },
20721
20936
  "oneOf": [
@@ -20803,6 +21018,11 @@
20803
21018
  "Yes",
20804
21019
  "No"
20805
21020
  ]
21021
+ },
21022
+ "detailsAnalysis": {
21023
+ "type": "object",
21024
+ "additionalProperties": true,
21025
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
20806
21026
  }
20807
21027
  },
20808
21028
  "oneOf": [
@@ -20858,7 +21078,8 @@
20858
21078
  "properties": {
20859
21079
  "yesNo": {
20860
21080
  "enum": [
20861
- "No"
21081
+ "No",
21082
+ "Not applicable"
20862
21083
  ]
20863
21084
  }
20864
21085
  }
@@ -21024,7 +21245,8 @@
21024
21245
  "properties": {
21025
21246
  "yesNo": {
21026
21247
  "enum": [
21027
- "No"
21248
+ "No",
21249
+ "Not known"
21028
21250
  ]
21029
21251
  }
21030
21252
  }
@@ -22974,8 +23196,7 @@
22974
23196
  "properties": {
22975
23197
  "riskIndicator": {
22976
23198
  "enum": [
22977
- "No",
22978
- "Not known"
23199
+ "No"
22979
23200
  ]
22980
23201
  }
22981
23202
  }
@@ -23483,6 +23704,11 @@
23483
23704
  "Yes",
23484
23705
  "No"
23485
23706
  ]
23707
+ },
23708
+ "detailsAnalysis": {
23709
+ "type": "object",
23710
+ "additionalProperties": true,
23711
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23486
23712
  }
23487
23713
  },
23488
23714
  "oneOf": [
@@ -23522,6 +23748,11 @@
23522
23748
  "Yes",
23523
23749
  "No"
23524
23750
  ]
23751
+ },
23752
+ "detailsAnalysis": {
23753
+ "type": "object",
23754
+ "additionalProperties": true,
23755
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23525
23756
  }
23526
23757
  },
23527
23758
  "oneOf": [
@@ -23561,6 +23792,11 @@
23561
23792
  "Yes",
23562
23793
  "No"
23563
23794
  ]
23795
+ },
23796
+ "detailsAnalysis": {
23797
+ "type": "object",
23798
+ "additionalProperties": true,
23799
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23564
23800
  }
23565
23801
  },
23566
23802
  "oneOf": [
@@ -23608,6 +23844,11 @@
23608
23844
  "Yes",
23609
23845
  "No"
23610
23846
  ]
23847
+ },
23848
+ "detailsAnalysis": {
23849
+ "type": "object",
23850
+ "additionalProperties": true,
23851
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23611
23852
  }
23612
23853
  },
23613
23854
  "oneOf": [
@@ -23649,97 +23890,73 @@
23649
23890
  "No",
23650
23891
  "Not applicable"
23651
23892
  ]
23652
- }
23653
- },
23654
- "oneOf": [
23655
- {
23893
+ },
23894
+ "uniformBoundaries": {
23895
+ "title": "Please indicate who has repaired, or treated as belonging to them, each of the boundaries. Identify each boundary as if you were looking at the property from the road.",
23896
+ "ta6title": "Looking towards the property from the road, who owns or accepts responsibility to maintain or repair the boundary features:",
23897
+ "type": "object",
23656
23898
  "properties": {
23657
- "areBoundariesUniform": {
23899
+ "left": {
23900
+ "title": "On the left",
23901
+ "type": "string",
23658
23902
  "enum": [
23659
- "Yes"
23903
+ "Seller",
23904
+ "Shared",
23905
+ "Neighbour",
23906
+ "Not known"
23660
23907
  ]
23661
23908
  },
23662
- "uniformBoundaries": {
23663
- "title": "Please indicate who has repaired, or treated as belonging to them, each of the boundaries. Identify each boundary as if you were looking at the property from the road.",
23664
- "ta6title": "Looking towards the property from the road, who owns or accepts responsibility to maintain or repair the boundary features:",
23665
- "type": "object",
23666
- "properties": {
23667
- "left": {
23668
- "title": "On the left",
23669
- "type": "string",
23670
- "enum": [
23671
- "Seller",
23672
- "Shared",
23673
- "Neighbour",
23674
- "Not known"
23675
- ]
23676
- },
23677
- "right": {
23678
- "title": "On the right",
23679
- "type": "string",
23680
- "enum": [
23681
- "Seller",
23682
- "Shared",
23683
- "Neighbour",
23684
- "Not known"
23685
- ]
23686
- },
23687
- "rear": {
23688
- "title": "At the rear",
23689
- "type": "string",
23690
- "enum": [
23691
- "Seller",
23692
- "Shared",
23693
- "Neighbour",
23694
- "Not known"
23695
- ]
23696
- },
23697
- "front": {
23698
- "title": "At the front",
23699
- "type": "string",
23700
- "enum": [
23701
- "Seller",
23702
- "Shared",
23703
- "Neighbour",
23704
- "Not known"
23705
- ]
23706
- }
23707
- }
23708
- }
23709
- }
23710
- },
23711
- {
23712
- "properties": {
23713
- "areBoundariesUniform": {
23909
+ "right": {
23910
+ "title": "On the right",
23911
+ "type": "string",
23714
23912
  "enum": [
23715
- "No"
23913
+ "Seller",
23914
+ "Shared",
23915
+ "Neighbour",
23916
+ "Not known"
23716
23917
  ]
23717
23918
  },
23718
- "details": {
23719
- "title": "Please indicate ownership or those you have repaired by written description or marking them on a plan of the property",
23919
+ "rear": {
23920
+ "title": "At the rear",
23720
23921
  "type": "string",
23721
- "minLength": 1
23922
+ "enum": [
23923
+ "Seller",
23924
+ "Shared",
23925
+ "Neighbour",
23926
+ "Not known"
23927
+ ]
23722
23928
  },
23723
- "attachments": {
23724
- "title": "Attachments",
23929
+ "front": {
23930
+ "title": "At the front",
23725
23931
  "type": "string",
23726
23932
  "enum": [
23727
- "Attached",
23728
- "To follow"
23933
+ "Seller",
23934
+ "Shared",
23935
+ "Neighbour",
23936
+ "Not known"
23729
23937
  ]
23730
23938
  }
23731
23939
  }
23732
23940
  },
23733
- {
23734
- "properties": {
23735
- "areBoundariesUniform": {
23736
- "enum": [
23737
- "Not applicable"
23738
- ]
23739
- }
23740
- }
23941
+ "details": {
23942
+ "title": "Please indicate ownership or those you have repaired by written description or marking them on a plan of the property",
23943
+ "type": "string",
23944
+ "minLength": 1
23945
+ },
23946
+ "attachments": {
23947
+ "title": "Attachments",
23948
+ "type": "string",
23949
+ "enum": [
23950
+ "Attached",
23951
+ "To follow"
23952
+ ]
23953
+ },
23954
+ "detailsAnalysis": {
23955
+ "type": "object",
23956
+ "additionalProperties": true,
23957
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23741
23958
  }
23742
- ]
23959
+ }
23743
23960
  },
23744
23961
  "haveBoundaryFeaturesMoved": {
23745
23962
  "title": "Has any boundary features been moved during your ownership or in the last 10 years, to your knowledge?",
@@ -23753,6 +23970,11 @@
23753
23970
  "No",
23754
23971
  "Not applicable"
23755
23972
  ]
23973
+ },
23974
+ "detailsAnalysis": {
23975
+ "type": "object",
23976
+ "additionalProperties": true,
23977
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23756
23978
  }
23757
23979
  },
23758
23980
  "oneOf": [
@@ -23794,6 +24016,11 @@
23794
24016
  "No",
23795
24017
  "Not applicable"
23796
24018
  ]
24019
+ },
24020
+ "detailsAnalysis": {
24021
+ "type": "object",
24022
+ "additionalProperties": true,
24023
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23797
24024
  }
23798
24025
  },
23799
24026
  "oneOf": [
@@ -23837,6 +24064,11 @@
23837
24064
  "Not applicable",
23838
24065
  "Not known"
23839
24066
  ]
24067
+ },
24068
+ "detailsAnalysis": {
24069
+ "type": "object",
24070
+ "additionalProperties": true,
24071
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
23840
24072
  }
23841
24073
  },
23842
24074
  "oneOf": [
@@ -23845,7 +24077,8 @@
23845
24077
  "yesNo": {
23846
24078
  "enum": [
23847
24079
  "No",
23848
- "Not applicable"
24080
+ "Not applicable",
24081
+ "Not known"
23849
24082
  ]
23850
24083
  }
23851
24084
  }
@@ -24085,6 +24318,11 @@
24085
24318
  "No",
24086
24319
  "Not known"
24087
24320
  ]
24321
+ },
24322
+ "detailsAnalysis": {
24323
+ "type": "object",
24324
+ "additionalProperties": true,
24325
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
24088
24326
  }
24089
24327
  },
24090
24328
  "oneOf": [
@@ -24344,6 +24582,11 @@
24344
24582
  "Yes",
24345
24583
  "No"
24346
24584
  ]
24585
+ },
24586
+ "detailsAnalysis": {
24587
+ "type": "object",
24588
+ "additionalProperties": true,
24589
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
24347
24590
  }
24348
24591
  },
24349
24592
  "oneOf": [
@@ -24849,6 +25092,11 @@
24849
25092
  "Yes",
24850
25093
  "No"
24851
25094
  ]
25095
+ },
25096
+ "detailsAnalysis": {
25097
+ "type": "object",
25098
+ "additionalProperties": true,
25099
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
24852
25100
  }
24853
25101
  },
24854
25102
  "oneOf": [
@@ -24935,6 +25183,11 @@
24935
25183
  "Yes",
24936
25184
  "No"
24937
25185
  ]
25186
+ },
25187
+ "detailsAnalysis": {
25188
+ "type": "object",
25189
+ "additionalProperties": true,
25190
+ "description": "Optional sibling object carrying vendor-emitted analysis of the parent's `details` free-text disclosure. Payload shape is vendor-specific; consumers that don't recognise the shape should ignore the object."
24938
25191
  }
24939
25192
  },
24940
25193
  "oneOf": [
@@ -37445,9 +37698,53 @@
37445
37698
  "filedUnder": {
37446
37699
  "title": "Related title number",
37447
37700
  "type": "string"
37701
+ },
37702
+ "summary": {
37703
+ "type": "object",
37704
+ "description": "Structured extraction output from the filed document. Shape varies by documentType.",
37705
+ "additionalProperties": true
37706
+ },
37707
+ "availability": {
37708
+ "title": "Human-readable HMLR availability description",
37709
+ "description": "From HMLR's official-copies/availability response, e.g. \"available for immediate download\". Optional; typically populated before the document is retrieved.",
37710
+ "type": "string"
37711
+ },
37712
+ "availabilityCode": {
37713
+ "title": "HMLR availability code",
37714
+ "description": "From HMLR's official-copies/availability response. Optional; typically populated before the document is retrieved.",
37715
+ "type": "string",
37716
+ "enum": [
37717
+ "IMMEDIATE",
37718
+ "MANUAL",
37719
+ "UNAVAILABLE"
37720
+ ]
37721
+ },
37722
+ "entryNumbers": {
37723
+ "title": "Register entry numbers referencing this document",
37724
+ "description": "Register entries (e.g. \"A5\", \"C1\") that refer to this document, from HMLR's official-copies/availability response. Optional.",
37725
+ "type": "array",
37726
+ "items": {
37727
+ "type": "string",
37728
+ "minLength": 1
37729
+ }
37730
+ },
37731
+ "backdated": {
37732
+ "title": "Whether HMLR considers this document backdated",
37733
+ "description": "From HMLR's official-copies/availability response, typically present on register and title-plan entries. Optional.",
37734
+ "type": "boolean"
37448
37735
  }
37449
37736
  }
37450
37737
  }
37738
+ },
37739
+ "keyFacts": {
37740
+ "type": "object",
37741
+ "description": "Generated summary of owners, charges, restrictions, rights and easements from the title register.",
37742
+ "additionalProperties": true
37743
+ },
37744
+ "covenantAnalysis": {
37745
+ "type": "object",
37746
+ "description": "Categorised covenant analysis from register entries and filed documents, including enforceability assessment and breach consequences.",
37747
+ "additionalProperties": true
37451
37748
  }
37452
37749
  }
37453
37750
  }
@@ -41163,6 +41460,11 @@
41163
41460
  },
41164
41461
  "messageText": {
41165
41462
  "type": "string"
41463
+ },
41464
+ "pdtfPath": {
41465
+ "description": "PDTF schema path indicating where response data should be stored, enabling structured data resolution alongside the enquiry message",
41466
+ "type": "string",
41467
+ "pattern": "^/"
41166
41468
  }
41167
41469
  },
41168
41470
  "required": [