-
Notifications
You must be signed in to change notification settings - Fork 1
/
mortgageAPI.yaml
3587 lines (3485 loc) · 119 KB
/
mortgageAPI.yaml
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
263
264
265
266
267
268
269
270
271
272
273
274
275
276
277
278
279
280
281
282
283
284
285
286
287
288
289
290
291
292
293
294
295
296
297
298
299
300
301
302
303
304
305
306
307
308
309
310
311
312
313
314
315
316
317
318
319
320
321
322
323
324
325
326
327
328
329
330
331
332
333
334
335
336
337
338
339
340
341
342
343
344
345
346
347
348
349
350
351
352
353
354
355
356
357
358
359
360
361
362
363
364
365
366
367
368
369
370
371
372
373
374
375
376
377
378
379
380
381
382
383
384
385
386
387
388
389
390
391
392
393
394
395
396
397
398
399
400
401
402
403
404
405
406
407
408
409
410
411
412
413
414
415
416
417
418
419
420
421
422
423
424
425
426
427
428
429
430
431
432
433
434
435
436
437
438
439
440
441
442
443
444
445
446
447
448
449
450
451
452
453
454
455
456
457
458
459
460
461
462
463
464
465
466
467
468
469
470
471
472
473
474
475
476
477
478
479
480
481
482
483
484
485
486
487
488
489
490
491
492
493
494
495
496
497
498
499
500
501
502
503
504
505
506
507
508
509
510
511
512
513
514
515
516
517
518
519
520
521
522
523
524
525
526
527
528
529
530
531
532
533
534
535
536
537
538
539
540
541
542
543
544
545
546
547
548
549
550
551
552
553
554
555
556
557
558
559
560
561
562
563
564
565
566
567
568
569
570
571
572
573
574
575
576
577
578
579
580
581
582
583
584
585
586
587
588
589
590
591
592
593
594
595
596
597
598
599
600
601
602
603
604
605
606
607
608
609
610
611
612
613
614
615
616
617
618
619
620
621
622
623
624
625
626
627
628
629
630
631
632
633
634
635
636
637
638
639
640
641
642
643
644
645
646
647
648
649
650
651
652
653
654
655
656
657
658
659
660
661
662
663
664
665
666
667
668
669
670
671
672
673
674
675
676
677
678
679
680
681
682
683
684
685
686
687
688
689
690
691
692
693
694
695
696
697
698
699
700
701
702
703
704
705
706
707
708
709
710
711
712
713
714
715
716
717
718
719
720
721
722
723
724
725
726
727
728
729
730
731
732
733
734
735
736
737
738
739
740
741
742
743
744
745
746
747
748
749
750
751
752
753
754
755
756
757
758
759
760
761
762
763
764
765
766
767
768
769
770
771
772
773
774
775
776
777
778
779
780
781
782
783
784
785
786
787
788
789
790
791
792
793
794
795
796
797
798
799
800
801
802
803
804
805
806
807
808
809
810
811
812
813
814
815
816
817
818
819
820
821
822
823
824
825
826
827
828
829
830
831
832
833
834
835
836
837
838
839
840
841
842
843
844
845
846
847
848
849
850
851
852
853
854
855
856
857
858
859
860
861
862
863
864
865
866
867
868
869
870
871
872
873
874
875
876
877
878
879
880
881
882
883
884
885
886
887
888
889
890
891
892
893
894
895
896
897
898
899
900
901
902
903
904
905
906
907
908
909
910
911
912
913
914
915
916
917
918
919
920
921
922
923
924
925
926
927
928
929
930
931
932
933
934
935
936
937
938
939
940
941
942
943
944
945
946
947
948
949
950
951
952
953
954
955
956
957
958
959
960
961
962
963
964
965
966
967
968
969
970
971
972
973
974
975
976
977
978
979
980
981
982
983
984
985
986
987
988
989
990
991
992
993
994
995
996
997
998
999
1000
openapi: 3.0.0
info:
version: 3.6.0
title: Common Mortgage API (Public)
description: >
This specification defines a common mortgage API for mortgages as used in Switzerland.
The API is supposed to be used by requesting parties who want to get, extend, or transfer mortgages from and to financial institutions.
This specification uses schema definitions from the Common Data Model v1.2.2.
termsOfService: Tbd
contact:
email: [email protected]
license:
name: Apache 2.0
url: http://www.apache.org/licenses/LICENSE-2.0.html
servers:
- url: https://mortgage.common-api.ch
externalDocs:
description: Find out more about SFTI API specifications
url: https://www.common-api.ch
tags:
- name: Full Mortgage Cases
description: Operatios related to full mortgage cases including the application details
- name: Existing Mortgages
description: Operations related with existing mortgages
- name: Mortgage Products and Conditions
description: Operations for synchronizing general mortgage product information from an FI
- name: Mortgage Application
description: Operations needed to place an application (dossier) for a new mortgage
- name: Mortgage Financing Request
description: Operations for handling financing requests for a specific accepted application (dossier)
- name: Mortgage Offers
description: Operations for handling the binding offers an FI provides
- name: Mortgage Order
description: Operations for placing a binding order for a chosen offer
- name: Mortgage Prolongation
description: Operations for handling the common special case of prolonging an existing mortgage
security:
- ApiKeyAuth: []
- OAuth2:
- read
- write
paths:
/mortgage-cases:
get:
tags:
- Full Mortgage Cases
summary: Return the list of all mortgage cases for the authenticated context
description: List of mortgage cases for the authenticated context including the corresponding properties, sorted by caseId.
parameters:
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: Paginated list of all mortgage cases with all related information sorted by caseId.
content:
application/json:
schema:
type: object
properties:
caseList:
type: array
items:
$ref: '#/components/schemas/MortgageCase'
_links:
$ref: '#/components/schemas/linksPagination'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgage-cases/{caseId}:
get:
tags:
- Full Mortgage Cases
summary: Return a specific existing mortgage case
description: A specific existing mortgage case including the corresponding properties.
parameters:
- $ref: '#/components/parameters/path_caseId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: Mortgage case details with the corresponding properties.
content:
application/json:
schema:
type: object
properties:
Case:
$ref: '#/components/schemas/MortgageCase'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages:
get:
tags:
- Existing Mortgages
summary: Return the list of all mortgages for the authenticated context
description: List of mortgages for the authenticated context including the corresponding properties and related mortgages, sorted by mortgageId.
parameters:
- in: query
name: expiring
schema:
type: boolean
example: true
description: Whether or not the mortgage is qualified for being prolonged, i.e., expiring soon or already expired (for filtering).
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: Paginated list of all mortgages with all related information sorted by mortgageId.
content:
application/json:
schema:
type: object
properties:
MortgageList:
type: array
items:
$ref: '#/components/schemas/Mortgage'
_links:
$ref: '#/components/schemas/linksPagination'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/{mortgageId}:
get:
tags:
- Existing Mortgages
summary: Return a specific existing mortgage
description: A specific existing mortgage including the corresponding properties and related mortgages.
parameters:
- $ref: '#/components/parameters/path_mortgageId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: Mortgage details with the corresponding properties and related mortgages.
content:
application/json:
schema:
type: object
properties:
Mortgage:
$ref: '#/components/schemas/Mortgage'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/products:
get:
summary: Get a list of all mortgage products
description: Get a complete overview of all available mortgage products sorted by productId.
tags:
- Mortgage Products and Conditions
parameters:
- in: query
name: interestRateType
schema:
type: string
example: saron
enum:
- variable
- libor
- saron
- fixed
description: The type of the interest rates (for filtering).
- $ref: '#/components/parameters/duration'
- $ref: '#/components/parameters/limit'
- $ref: '#/components/parameters/offset'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: Paginated list of all mortgage products with all related information sorted by productId.
content:
application/json:
schema:
type: object
properties:
productList:
type: array
items:
$ref: '#/components/schemas/Product'
_links:
$ref: '#/components/schemas/linksPagination'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/products/{productId}/conditions:
get:
summary: Get the general conditions for the specified mortgage product
description: The standard financial conditions for the product.
tags:
- Mortgage Products and Conditions
parameters:
- $ref: '#/components/parameters/path_productId'
- $ref: '#/components/parameters/limit'
- in: query
name: interest
schema:
type: string
description: The interest (for filtering).
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: List of conditions related to a specific mortgage product.
content:
application/json:
schema:
type: object
properties:
conditionList:
type: array
items:
$ref: '#/components/schemas/Condition'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications:
post:
summary: Place a new mortgage application (serves as dossier)
description: |
Place a new application including all necessary information about the property and applicant's financial situation.
**Note that in the case where the FI needs additional information on the property, the error response 400 must contain the minimum required JSON object (PropertyObject) as detail**.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Static details (requesting party, property object) of the application to be added as a dossier.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
responses:
'201':
$ref: '#/components/responses/standard201'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/required-information:
get:
summary: Get the required property information for the specific FI needed for valuation
description: Show the subset of property details required by the FI for valuation.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
$ref: '#/components/schemas/PropertyObject'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}:
get:
summary: Get the details of a specific placed application
description: Get the details of a specific placed application.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
application:
$ref: '#/components/schemas/Application'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
put:
summary: Update the application's details
description: Update the application's details. Note that changing the application's details should not be possible after the application has been accepted by the FI.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Details of the order to be added.
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/Application'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
status:
type: string
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
delete:
summary: Cancel the application and removing it
description: The request to delete a previously shared application.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
reason:
description: The reason for rejecting an application.
type: string
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/swissrets:
post:
summary: Add property details in the SwissRETS standard
description: This endpoint allows to upload the real estate property's details as an XML file in the SwissRETS format according to https://swissrets.ch/.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Details of the real estate property to be added.
required: true
content:
application/xml:
schema:
type: string
responses:
'201':
$ref: '#/components/responses/standard201'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
get:
summary: Get property details in SwissRETS format
description: Get the real estate property's details in SwissRETS format XML according to https://swissrets.ch/.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/xml:
schema:
type: string
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
put:
summary: Update the real estate property's details
description: This endpoint allows to upload a modified XML file in the SwissRETS format changing the already existing information.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Details of the real estate property to be added.
required: true
content:
application/xml:
schema:
type: string
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
status:
type: string
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/documents:
post:
summary: Add documents for the specific application
description: Documents can be assigned to a specific application ID.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Details of the document to be added.
required: true
content:
multipart/form-data:
schema:
type: object
required:
- documentType
- fileContent
- name
- type
- size
properties:
documentType:
$ref: '#/components/schemas/DocumentType'
fileContent:
type: string
format: binary
description: The file content.
name:
type: string
description: The name of the file without file type extension.
maxLength: 128
example: my-property-flyer
type:
type: string
description: The file type.
maxLength: 64
example: application/pdf
size:
type: integer
format: int64
description: The file size in bytes.
example: 21543
applicantId:
type: string
format: uuid
description: UUID v4 of the applicant (existing applicant within the current application).
example: 576f8de3-6b30-4882-a7af-da2132a456cf
responses:
'201':
$ref: '#/components/responses/standard201'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
get:
summary: Get a list of submitted documents for a specifically placed application
description: All documents that have been shared against the Application ID can be retrieved here.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: array
items:
type: object
properties:
filename:
type: string
example: customer_id.pdf
filetype:
type: string
example: pdf
documentId:
type: string
format: uuid
example: 7f648f12-fd45-4930-6543-456hf5671c37
description: Document ID in uuid v4 format.
filesize:
type: integer
example: 1024
description: The file size in bytes.
uploaddate:
$ref: '#/components/schemas/Date'
statusInfo:
description: Document status info.
type: object
required:
- status
properties:
status:
type: string
enum:
- accepted
- rejected
- pending
default: pending
description: Get the current status of the application.
statusReason:
type: string
example: Additional information that can be shared with the status.
description: The reason, of current status.
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/documents/{documentId}:
delete:
summary: Delete a formerly uploaded document
description: >
Deletes a specific document attached to a specific application.
Note that deleting documents should not be possible after the application has been accepted by the FI.
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/path_documentId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
status:
type: string
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/status:
get:
summary: Get the current status of the application
description: Get the current status of the application (rejected with reason, accepted, pending with reason).
tags:
- Mortgage Application
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.
content:
application/json:
schema:
type: object
properties:
status:
type: string
enum:
- accepted
- rejected
- pending
example: pending
detail:
type: string
example: Waiting for details
description: Additional information that can be shared with the status.
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/financing-requests:
post:
summary: Place a new financing-request for a specific accepted application (dossier)
description: Place a new financing request including all necessary information.
tags:
- Mortgage Financing Request
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
requestBody:
description: Specific financing request fo the given application (dossier).
required: true
content:
application/json:
schema:
$ref: '#/components/schemas/FinancingRequest'
responses:
'201':
$ref: '#/components/responses/standard201'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}/required-information:
get:
summary: List all required documents / information for processing specific Financial request at FI
description: All required documents for a specific FinancingRequestId can be retrieved herewith.
tags:
- Mortgage Financing Request
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/path_financingRequestId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK
content:
application/json:
schema:
type: object
properties:
financingRequestId:
type: string
format: uuid
documents:
type: array
items:
$ref: '#/components/schemas/DocumentType'
'400':
$ref: '#/components/responses/standard400'
'401':
$ref: '#/components/responses/standard401'
'403':
$ref: '#/components/responses/standard403'
'404':
$ref: '#/components/responses/standard404'
'405':
$ref: '#/components/responses/standard405'
'500':
$ref: '#/components/responses/standard500'
'501':
$ref: '#/components/responses/standard501'
'503':
$ref: '#/components/responses/standard503'
/mortgages/applications/{applicationId}/financing-requests/{financingRequestId}:
get:
summary: Get the details of a financing request
description: Get a specific financing request based on the financingRequestId.
tags:
- Mortgage Financing Request
parameters:
- $ref: '#/components/parameters/path_applicationId'
- $ref: '#/components/parameters/path_financingRequestId'
- $ref: '#/components/parameters/clientid_in_header'
- $ref: '#/components/parameters/correlation_in_header'
- $ref: '#/components/parameters/agent_in_header'
responses:
'200':
headers:
X-Correlation-ID:
$ref: '#/components/headers/X-Correlation-ID'
description: OK.