@pdtf/schemas 3.5.1-9 → 3.6.0-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.
@@ -13,7 +13,28 @@
13
13
  "type": "string"
14
14
  },
15
15
  "externalIds": {
16
- "type": "object"
16
+ "type": "object",
17
+ "patternProperties": {
18
+ ".*": {
19
+ "oneOf": [
20
+ {
21
+ "type": "string"
22
+ },
23
+ {
24
+ "type": "number"
25
+ },
26
+ {
27
+ "type": "boolean"
28
+ },
29
+ {
30
+ "type": "object",
31
+ "patternProperties": {
32
+ ".*": {}
33
+ }
34
+ }
35
+ ]
36
+ }
37
+ }
17
38
  },
18
39
  "status": {
19
40
  "type": "string",
@@ -181,7 +202,28 @@
181
202
  ]
182
203
  },
183
204
  "externalIds": {
184
- "type": "object"
205
+ "type": "object",
206
+ "patternProperties": {
207
+ ".*": {
208
+ "oneOf": [
209
+ {
210
+ "type": "string"
211
+ },
212
+ {
213
+ "type": "number"
214
+ },
215
+ {
216
+ "type": "boolean"
217
+ },
218
+ {
219
+ "type": "object",
220
+ "patternProperties": {
221
+ ".*": {}
222
+ }
223
+ }
224
+ ]
225
+ }
226
+ }
185
227
  },
186
228
  "participantStatus": {
187
229
  "type": "string",
@@ -198,6 +240,17 @@
198
240
  "identity": {
199
241
  "type": "object",
200
242
  "properties": {
243
+ "status": {
244
+ "type": "string",
245
+ "enum": [
246
+ "Requested",
247
+ "In progress",
248
+ "User tasks complete",
249
+ "Report available",
250
+ "Complete",
251
+ "Cancelled"
252
+ ]
253
+ },
201
254
  "result": {
202
255
  "type": "string",
203
256
  "enum": [
@@ -233,6 +286,63 @@
233
286
  "antiMoneyLaundering": {
234
287
  "type": "object",
235
288
  "properties": {
289
+ "status": {
290
+ "type": "string",
291
+ "enum": [
292
+ "Requested",
293
+ "In progress",
294
+ "User tasks complete",
295
+ "Report available",
296
+ "Complete",
297
+ "Cancelled"
298
+ ]
299
+ },
300
+ "result": {
301
+ "type": "string",
302
+ "enum": [
303
+ "pass",
304
+ "fail",
305
+ "consider"
306
+ ]
307
+ },
308
+ "reports": {
309
+ "type": "array",
310
+ "items": {
311
+ "type": "object",
312
+ "properties": {
313
+ "reportName": {
314
+ "type": "string"
315
+ },
316
+ "result": {
317
+ "type": "string",
318
+ "enum": [
319
+ "pass",
320
+ "fail",
321
+ "consider"
322
+ ]
323
+ },
324
+ "details": {
325
+ "type": "string"
326
+ }
327
+ }
328
+ }
329
+ }
330
+ }
331
+ },
332
+ "sourceOfFunds": {
333
+ "type": "object",
334
+ "properties": {
335
+ "status": {
336
+ "type": "string",
337
+ "enum": [
338
+ "Requested",
339
+ "In progress",
340
+ "User tasks complete",
341
+ "Report available",
342
+ "Complete",
343
+ "Cancelled"
344
+ ]
345
+ },
236
346
  "result": {
237
347
  "type": "string",
238
348
  "enum": [
@@ -320,6 +430,9 @@
320
430
  "Personal Representative for a Deceased Owner",
321
431
  "Under Power of Attorney",
322
432
  "Mortgagee in Possession",
433
+ "Company Director",
434
+ "Company Secretary",
435
+ "Trustee",
323
436
  "Assistant",
324
437
  "Other"
325
438
  ]
@@ -355,6 +468,9 @@
355
468
  "enum": [
356
469
  "Personal Representative for a Deceased Owner",
357
470
  "Under Power of Attorney",
471
+ "Company Director",
472
+ "Company Secretary",
473
+ "Trustee",
358
474
  "Assistant",
359
475
  "Other"
360
476
  ]
@@ -1408,6 +1524,18 @@
1408
1524
  "description": "This may differ from the number of legal owners, for example if the property is being sold by executors of a deceased owner",
1409
1525
  "type": "integer"
1410
1526
  },
1527
+ "outstandingMortgage": {
1528
+ "title": "Are there any outstanding mortgages on the property?",
1529
+ "type": "string",
1530
+ "enum": [
1531
+ "Yes",
1532
+ "No"
1533
+ ]
1534
+ },
1535
+ "existingLender": {
1536
+ "title": "What is the name of the existing lender?",
1537
+ "type": "string"
1538
+ },
1411
1539
  "hasHelpToBuyEquityLoan": {
1412
1540
  "title": "Is the property being sold with a Help to Buy equity loan outstanding?",
1413
1541
  "type": "string",
@@ -21341,6 +21469,39 @@
21341
21469
  "Attached",
21342
21470
  "To follow"
21343
21471
  ]
21472
+ },
21473
+ "fensaCertificates": {
21474
+ "type": "object",
21475
+ "properties": {
21476
+ "certificates": {
21477
+ "type": "array",
21478
+ "items": {
21479
+ "type": "object",
21480
+ "properties": {
21481
+ "certificateId": {
21482
+ "type": "string",
21483
+ "minLength": 1
21484
+ },
21485
+ "numberOfWindows": {
21486
+ "type": "integer",
21487
+ "minimum": 0
21488
+ },
21489
+ "numberOfDoors": {
21490
+ "type": "integer",
21491
+ "minimum": 0
21492
+ },
21493
+ "certificateIssued": {
21494
+ "type": "string",
21495
+ "format": "date"
21496
+ },
21497
+ "workCompleted": {
21498
+ "type": "string",
21499
+ "format": "date"
21500
+ }
21501
+ }
21502
+ }
21503
+ }
21504
+ }
21344
21505
  }
21345
21506
  }
21346
21507
  }
@@ -22045,7 +22206,28 @@
22045
22206
  "format": "date-time"
22046
22207
  },
22047
22208
  "externalIds": {
22048
- "type": "object"
22209
+ "type": "object",
22210
+ "patternProperties": {
22211
+ ".*": {
22212
+ "oneOf": [
22213
+ {
22214
+ "type": "string"
22215
+ },
22216
+ {
22217
+ "type": "number"
22218
+ },
22219
+ {
22220
+ "type": "boolean"
22221
+ },
22222
+ {
22223
+ "type": "object",
22224
+ "patternProperties": {
22225
+ ".*": {}
22226
+ }
22227
+ }
22228
+ ]
22229
+ }
22230
+ }
22049
22231
  }
22050
22232
  }
22051
22233
  }
@@ -34190,10 +34372,35 @@
34190
34372
  "minLength": 1
34191
34373
  },
34192
34374
  "externalIds": {
34193
- "type": "object"
34375
+ "type": "object",
34376
+ "patternProperties": {
34377
+ ".*": {
34378
+ "oneOf": [
34379
+ {
34380
+ "type": "string"
34381
+ },
34382
+ {
34383
+ "type": "number"
34384
+ },
34385
+ {
34386
+ "type": "boolean"
34387
+ },
34388
+ {
34389
+ "type": "object",
34390
+ "patternProperties": {
34391
+ ".*": {}
34392
+ }
34393
+ }
34394
+ ]
34395
+ }
34396
+ }
34194
34397
  },
34195
34398
  "isDeleted": {
34196
34399
  "type": "boolean"
34400
+ },
34401
+ "summary": {
34402
+ "title": "Structured summary of the document",
34403
+ "type": "object"
34197
34404
  }
34198
34405
  }
34199
34406
  }
@@ -36968,7 +37175,28 @@
36968
37175
  "format": "uri"
36969
37176
  },
36970
37177
  "externalIds": {
36971
- "type": "object"
37178
+ "type": "object",
37179
+ "patternProperties": {
37180
+ ".*": {
37181
+ "oneOf": [
37182
+ {
37183
+ "type": "string"
37184
+ },
37185
+ {
37186
+ "type": "number"
37187
+ },
37188
+ {
37189
+ "type": "boolean"
37190
+ },
37191
+ {
37192
+ "type": "object",
37193
+ "patternProperties": {
37194
+ ".*": {}
37195
+ }
37196
+ }
37197
+ ]
37198
+ }
37199
+ }
36972
37200
  },
36973
37201
  "requiredSignatories": {
36974
37202
  "type": "array",
@@ -37024,7 +37252,28 @@
37024
37252
  "format": "date-time"
37025
37253
  },
37026
37254
  "externalIds": {
37027
- "type": "object"
37255
+ "type": "object",
37256
+ "patternProperties": {
37257
+ ".*": {
37258
+ "oneOf": [
37259
+ {
37260
+ "type": "string"
37261
+ },
37262
+ {
37263
+ "type": "number"
37264
+ },
37265
+ {
37266
+ "type": "boolean"
37267
+ },
37268
+ {
37269
+ "type": "object",
37270
+ "patternProperties": {
37271
+ ".*": {}
37272
+ }
37273
+ }
37274
+ ]
37275
+ }
37276
+ }
37028
37277
  }
37029
37278
  },
37030
37279
  "role": {
@@ -37070,7 +37319,28 @@
37070
37319
  "type": "string"
37071
37320
  },
37072
37321
  "externalIds": {
37073
- "type": "object"
37322
+ "type": "object",
37323
+ "patternProperties": {
37324
+ ".*": {
37325
+ "oneOf": [
37326
+ {
37327
+ "type": "string"
37328
+ },
37329
+ {
37330
+ "type": "number"
37331
+ },
37332
+ {
37333
+ "type": "boolean"
37334
+ },
37335
+ {
37336
+ "type": "object",
37337
+ "patternProperties": {
37338
+ ".*": {}
37339
+ }
37340
+ }
37341
+ ]
37342
+ }
37343
+ }
37074
37344
  },
37075
37345
  "address": {
37076
37346
  "title": "Address",
@@ -37152,7 +37422,28 @@
37152
37422
  "type": "string"
37153
37423
  },
37154
37424
  "externalIds": {
37155
- "type": "object"
37425
+ "type": "object",
37426
+ "patternProperties": {
37427
+ ".*": {
37428
+ "oneOf": [
37429
+ {
37430
+ "type": "string"
37431
+ },
37432
+ {
37433
+ "type": "number"
37434
+ },
37435
+ {
37436
+ "type": "boolean"
37437
+ },
37438
+ {
37439
+ "type": "object",
37440
+ "patternProperties": {
37441
+ ".*": {}
37442
+ }
37443
+ }
37444
+ ]
37445
+ }
37446
+ }
37156
37447
  },
37157
37448
  "address": {
37158
37449
  "title": "Address",
@@ -37361,11 +37652,11 @@
37361
37652
  "status": {
37362
37653
  "type": "string",
37363
37654
  "enum": [
37364
- "pending",
37365
- "withdrawn",
37366
- "rejected",
37367
- "accepted",
37368
- "noteOfInterest"
37655
+ "Pending",
37656
+ "Withdrawn",
37657
+ "Rejected",
37658
+ "Accepted",
37659
+ "Note of Interest"
37369
37660
  ]
37370
37661
  },
37371
37662
  "inclusions": {
@@ -37385,12 +37676,363 @@
37385
37676
  "items": {
37386
37677
  "type": "string"
37387
37678
  }
37679
+ },
37680
+ "externalIds": {
37681
+ "type": "object",
37682
+ "patternProperties": {
37683
+ ".*": {
37684
+ "oneOf": [
37685
+ {
37686
+ "type": "string"
37687
+ },
37688
+ {
37689
+ "type": "number"
37690
+ },
37691
+ {
37692
+ "type": "boolean"
37693
+ },
37694
+ {
37695
+ "type": "object",
37696
+ "patternProperties": {
37697
+ ".*": {}
37698
+ }
37699
+ }
37700
+ ]
37701
+ }
37702
+ }
37703
+ },
37704
+ "buyerCircumstances": {
37705
+ "title": "Buyer circumstances",
37706
+ "description": "Information about the buyer's circumstances for lender compatibility analysis and conveyancing quotes",
37707
+ "type": "object",
37708
+ "properties": {
37709
+ "intendedUse": {
37710
+ "type": "string",
37711
+ "title": "Intended use of property",
37712
+ "enum": [
37713
+ "Owner occupied",
37714
+ "Buy-to-let",
37715
+ "Holiday let",
37716
+ "Second home"
37717
+ ]
37718
+ },
37719
+ "firstTimeBuyer": {
37720
+ "type": "boolean",
37721
+ "title": "First-time buyer"
37722
+ },
37723
+ "rightToBuy": {
37724
+ "type": "boolean",
37725
+ "title": "Right to Buy purchase"
37726
+ },
37727
+ "ltdCompanyPurchase": {
37728
+ "type": "boolean",
37729
+ "title": "Limited company purchase"
37730
+ },
37731
+ "numberOfOwners": {
37732
+ "type": "integer",
37733
+ "title": "Number of owners",
37734
+ "nullable": true
37735
+ },
37736
+ "numberOfExpats": {
37737
+ "type": "integer",
37738
+ "title": "Number of expat buyers",
37739
+ "nullable": true
37740
+ },
37741
+ "giftedEquity": {
37742
+ "type": "boolean",
37743
+ "title": "Gifted equity"
37744
+ },
37745
+ "numberOfGiftedDeposits": {
37746
+ "type": "integer",
37747
+ "title": "Number of gifted deposits",
37748
+ "nullable": true
37749
+ },
37750
+ "requiresMortgage": {
37751
+ "type": "string",
37752
+ "title": "Requires mortgage",
37753
+ "enum": [
37754
+ "Yes",
37755
+ "No"
37756
+ ]
37757
+ }
37758
+ },
37759
+ "required": [
37760
+ "requiresMortgage"
37761
+ ],
37762
+ "oneOf": [
37763
+ {
37764
+ "properties": {
37765
+ "requiresMortgage": {
37766
+ "enum": [
37767
+ "No"
37768
+ ]
37769
+ }
37770
+ }
37771
+ },
37772
+ {
37773
+ "properties": {
37774
+ "requiresMortgage": {
37775
+ "enum": [
37776
+ "Yes"
37777
+ ]
37778
+ },
37779
+ "helpToBuyEquityLoan": {
37780
+ "type": "boolean",
37781
+ "title": "Help to Buy equity loan"
37782
+ },
37783
+ "armedForcesHelpToBuy": {
37784
+ "type": "boolean",
37785
+ "title": "Armed Forces Help to Buy"
37786
+ },
37787
+ "numberOfHelpToBuyIsas": {
37788
+ "type": "integer",
37789
+ "title": "Number of Help to Buy ISAs",
37790
+ "nullable": true
37791
+ },
37792
+ "bridgingFinanceRepresentation": {
37793
+ "type": "string",
37794
+ "title": "Bridging finance representation",
37795
+ "enum": [
37796
+ "Dual",
37797
+ "Separate"
37798
+ ],
37799
+ "nullable": true
37800
+ },
37801
+ "depositAmount": {
37802
+ "type": "number",
37803
+ "title": "Deposit amount",
37804
+ "minimum": 0
37805
+ },
37806
+ "loanToValue": {
37807
+ "type": "number",
37808
+ "title": "Loan-to-Value (LTV)",
37809
+ "minimum": 0,
37810
+ "maximum": 100
37811
+ },
37812
+ "numberOfBorrowers": {
37813
+ "type": "integer",
37814
+ "title": "Number of borrowers",
37815
+ "minimum": 1,
37816
+ "maximum": 4,
37817
+ "default": 1
37818
+ },
37819
+ "jointProprietorSoleMortgagor": {
37820
+ "type": "boolean",
37821
+ "title": "Joint proprietor, sole mortgagor"
37822
+ },
37823
+ "soleProprietorJointMortgagor": {
37824
+ "type": "boolean",
37825
+ "title": "Sole proprietor, joint mortgagor"
37826
+ },
37827
+ "deedOfPostponement": {
37828
+ "type": "boolean",
37829
+ "title": "Deed of postponement required"
37830
+ },
37831
+ "separateRepresentation": {
37832
+ "type": "boolean",
37833
+ "title": "Separate legal representation required",
37834
+ "nullable": true
37835
+ },
37836
+ "oldestBorrowerAge": {
37837
+ "type": "integer",
37838
+ "title": "Oldest borrower age",
37839
+ "minimum": 18,
37840
+ "maximum": 85
37841
+ },
37842
+ "mortgageTerm": {
37843
+ "type": "integer",
37844
+ "title": "Mortgage term",
37845
+ "minimum": 5,
37846
+ "maximum": 40
37847
+ },
37848
+ "adverseCredit": {
37849
+ "type": "string",
37850
+ "title": "Adverse credit",
37851
+ "enum": [
37852
+ "No",
37853
+ "Yes",
37854
+ "Prefer not to say"
37855
+ ]
37856
+ },
37857
+ "employmentType": {
37858
+ "type": "string",
37859
+ "title": "Employment type",
37860
+ "enum": [
37861
+ "Employed",
37862
+ "Self-employed",
37863
+ "Retired",
37864
+ "Contractor",
37865
+ "Other"
37866
+ ]
37867
+ },
37868
+ "existingMortgagedProperties": {
37869
+ "type": "integer",
37870
+ "title": "Existing mortgaged properties",
37871
+ "minimum": 0
37872
+ },
37873
+ "annualIncome": {
37874
+ "type": "number",
37875
+ "title": "Annual gross income",
37876
+ "minimum": 0
37877
+ },
37878
+ "residencyStatus": {
37879
+ "type": "string",
37880
+ "title": "Residency status",
37881
+ "enum": [
37882
+ "UK citizen",
37883
+ "Permanent resident",
37884
+ "Visa holder",
37885
+ "Non-resident"
37886
+ ]
37887
+ },
37888
+ "nominatedLender": {
37889
+ "type": "string",
37890
+ "title": "Nominated lender"
37891
+ }
37892
+ }
37893
+ }
37894
+ ]
37895
+ }
37896
+ }
37897
+ }
37898
+ }
37899
+ },
37900
+ "enquiries": {
37901
+ "title": "Property transaction enquiries between conveyancers",
37902
+ "type": "object",
37903
+ "propertyNames": {
37904
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
37905
+ },
37906
+ "patternProperties": {
37907
+ ".*": {
37908
+ "type": "object",
37909
+ "properties": {
37910
+ "subject": {
37911
+ "description": "The subject or topic of the enquiry",
37912
+ "type": "string"
37913
+ },
37914
+ "status": {
37915
+ "type": "string",
37916
+ "enum": [
37917
+ "pending",
37918
+ "open",
37919
+ "resolved",
37920
+ "resolvedWithCondition",
37921
+ "withdrawn"
37922
+ ]
37923
+ },
37924
+ "messages": {
37925
+ "description": "Messages exchanged regarding this enquiry",
37926
+ "type": "object",
37927
+ "propertyNames": {
37928
+ "pattern": "^[A-Za-z0-9][A-Za-z0-9._:+-]*$"
37929
+ },
37930
+ "patternProperties": {
37931
+ ".*": {
37932
+ "type": "object",
37933
+ "properties": {
37934
+ "datetime": {
37935
+ "type": "string",
37936
+ "format": "date-time"
37937
+ },
37938
+ "originatorRole": {
37939
+ "type": "string",
37940
+ "enum": [
37941
+ "Seller",
37942
+ "Seller's Conveyancer",
37943
+ "Buyer",
37944
+ "Buyer's Conveyancer",
37945
+ "Estate Agent",
37946
+ "Buyer's Agent",
37947
+ "Surveyor",
37948
+ "Mortgage Broker",
37949
+ "Lender"
37950
+ ]
37951
+ },
37952
+ "destinationRole": {
37953
+ "type": "string",
37954
+ "enum": [
37955
+ "Seller",
37956
+ "Seller's Conveyancer",
37957
+ "Buyer",
37958
+ "Buyer's Conveyancer",
37959
+ "Estate Agent",
37960
+ "Buyer's Agent",
37961
+ "Surveyor",
37962
+ "Mortgage Broker",
37963
+ "Lender"
37964
+ ]
37965
+ },
37966
+ "messageText": {
37967
+ "type": "string"
37968
+ }
37969
+ },
37970
+ "required": [
37971
+ "datetime",
37972
+ "originatorRole",
37973
+ "destinationRole",
37974
+ "messageText"
37975
+ ]
37976
+ }
37977
+ }
37978
+ },
37979
+ "externalIds": {
37980
+ "type": "object",
37981
+ "patternProperties": {
37982
+ ".*": {
37983
+ "oneOf": [
37984
+ {
37985
+ "type": "string"
37986
+ },
37987
+ {
37988
+ "type": "number"
37989
+ },
37990
+ {
37991
+ "type": "boolean"
37992
+ },
37993
+ {
37994
+ "type": "object",
37995
+ "patternProperties": {
37996
+ ".*": {}
37997
+ }
37998
+ }
37999
+ ]
38000
+ }
38001
+ }
37388
38002
  }
37389
38003
  },
37390
38004
  "required": [
37391
- "amount",
37392
- "currency",
37393
- "status"
38005
+ "subject",
38006
+ "status",
38007
+ "messages"
38008
+ ],
38009
+ "oneOf": [
38010
+ {
38011
+ "properties": {
38012
+ "status": {
38013
+ "const": "resolvedWithCondition"
38014
+ },
38015
+ "resolutionCondition": {
38016
+ "description": "Condition that must be met for the enquiry to be fully resolved",
38017
+ "type": "string"
38018
+ }
38019
+ },
38020
+ "required": [
38021
+ "resolutionCondition"
38022
+ ]
38023
+ },
38024
+ {
38025
+ "properties": {
38026
+ "status": {
38027
+ "enum": [
38028
+ "pending",
38029
+ "open",
38030
+ "resolved",
38031
+ "withdrawn"
38032
+ ]
38033
+ }
38034
+ }
38035
+ }
37394
38036
  ]
37395
38037
  }
37396
38038
  }