-
Notifications
You must be signed in to change notification settings - Fork 2
/
openapi.json
6322 lines (6322 loc) · 274 KB
/
openapi.json
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.1.0",
"info": {
"title": "FlowPay API",
"version": "2.0.0-alpha.4",
"description": {
"$ref": "docs/general.md"
},
"termsOfService": "https://developer.flowpay.it/tos",
"license": {
"name": "FlowPay SRL",
"url": "https://developer.flowpay.it/tos"
},
"x-logo": {
"url": "https://images.flowpay.it/logo",
"altText": "FlowPay"
},
"contact": {
"name": "API Support",
"url": "https://developer.flowpay.it",
"email": "api-support@flowpay.it"
},
"x-json-schema-faker": {
"locale": "it-IT",
"omitNulls": true,
"fillProperties": true,
"reuseProperties": true
}
},
"servers": [
{
"url": "https://api.flowpay.it/v2",
"description": "Production server (Not implementend)"
},
{
"url": "https://mock.flowpay.it/v2",
"description": "Mock server"
},
{
"url": "https://sandbox.{customerID}.flowpay.it/v2",
"description": "Customer-assigned sandbox server",
"variables": {
"customerID": {
"default": "00000000-00000000-00000000-00000000",
"description": "Unique customer identifier assigned after contract signature"
}
}
},
{
"url": "http://localhost:5002",
"description": "Debug"
}
],
"components": {
"securitySchemes": {
"oAuth2": {
"type": "oauth2",
"description": "OAuth2 flow",
"flows": {
"authorizationCode": {
"authorizationUrl": "/openid/authenticate",
"tokenUrl": "/oauth/token",
"refreshUrl": "/oauth/token",
"scopes": {
"accounts:read": "Allow to read accounts",
"accounts:write": "Allow to mediate accounts creation and open banking consent renewal",
"invoices:read": "Allow to read invoices",
"invoices:write": "Allow to create invoices and manage lifecycle",
"bills:read": "Allow to read bills",
"bills:write": "Allow to create bills and manage lifecycle",
"constructions:read": "Allow to read information about construction sites",
"constructions:write": "Allow to create construction sites and manage the lifecycle",
"openid": "Allow to read user profile",
"pagopa:read": "Allow to retrieve users' PagoPA payment notices",
"pagopa:write": "Allow to create PagoPA payment notices",
"transfers:read": "Allow to read transfers",
"transfers:write": "Allow to create transfers and manage lifecycle",
"wallet:`document_type`": "Allow to manage wallet for the specified use case"
}
},
"clientCredentials": {
"tokenUrl": "/oauth/token",
"scopes": {
"ade": "Allow to interact with Agenzia delle Entrate services",
"accounts:read": "Allow to read accounts",
"accounts:write": "Allow to mediate accounts creation and open banking consent renewal",
"invoices:read": "Allow to read invoices",
"invoices:write": "Allow to create invoices and manage lifecycle",
"bills:read": "Allow to read bills",
"bills:write": "Allow to create bills and manage lifecycle",
"constructions:read": "Allow to read information about construction sites",
"constructions:write": "Allow to create construction sites and manage the lifecycle",
"openid": "Allow to read user profile",
"pagopa:read": "Allow to retrieve users' PagoPA payment notices",
"pagopa:write": "Allow to create PagoPA payment notices",
"transfers:read": "Allow to read transfers",
"transfers:write": "Allow to create transfers and manage lifecycle",
"wallet:`document_type`": "Allow to manage wallet for the specified use case"
}
}
}
}
},
"schemas": {
"Address": {
"type": "object",
"properties": {
"city": {
"type": "string",
"description": "Name of the city where the property is located."
},
"street": {
"type": "string",
"description": "This field contains the name of the street where the property is located. It must include the name with a type (e.g., Avenue, Street, Road, etc.) but not the number or any other information."
},
"number": {
"type": "string",
"description": "This field refers to the numeric or alphanumeric value assigned to a property on a street."
},
"unitNumber": {
"type": "string",
"description": "his field is used when a single property has multiple units, such as apartments or office suites. It differentiates one unit from another within the same property."
},
"postalCode": {
"type": "string",
"description": "Also known as ZIP code (or CAP in Italy)"
},
"province": {
"type": "string",
"description": "It refers to the name of the state or province where the property is located."
},
"country": {
"type": "string",
"description": "The name of the country where the property is located."
}
},
"required": [
"city",
"street",
"postalCode",
"province",
"country"
]
},
"Bank": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the bank",
"example": "Intesa Sanpaolo",
"x-faker": "Company.companyName"
},
"nationalID": {
"type": "string",
"description": "National identifier of the bank",
"example": "03999",
"x-faker": "finance.bic"
},
"id": {
"type": "string",
"description": "Unique identifier of the bank",
"example": "intesa_sanpaolo"
},
"countries": {
"type": "array",
"items": {
"type": "string",
"description": "Countries where the bank operates in ISO 3166-1 alpha-2 format",
"example": "IT",
"x-faker": "address.countryCode"
}
},
"logo": {
"type": "string",
"description": "URL of the bank logo",
"example": "https://flowpayproduction.blob.core.windows.net/img/84036981-d004-40c4-a872-c81dd37e4acc.png",
"x-faker": "image.imageUrl"
},
"features": {
"type": "object",
"description": "Features supported by the bank",
"properties": {
"futurePayments": {
"type": "boolean",
"description": "True if the bank supports future payments",
"example": true
},
"sct": {
"type": "array",
"description": "List of SCT payment types supported by the bank",
"items": {
"type": "string",
"enum": [
"standard",
"instant"
],
"description": "SCT payment type"
}
},
"recurringPayments": {
"type": "array",
"description": "List of recurring payment types supported by the bank",
"items": {
"type": "string",
"enum": [
"monthly",
"everyTwoMonths",
"quarterly",
"semiAnnual",
"daily",
"everyFourMonths",
"weekly",
"everyTwoWeeks",
"annual"
],
"description": "Recurring payment frequency"
}
}
}
}
}
},
"BankAccount": {
"type": "object",
"properties": {
"owner": {
"type": "string",
"format": "uuid",
"description": "Identifier of the owner of the bank account"
},
"iban": {
"type": "string",
"description": "International Bank Account Number",
"x-faker": "finance.iban",
"example": "IT60X0542811101000000123456"
},
"currencies": {
"type": "array",
"items": {
"type": "string",
"description": "Currencies supported by the bank account",
"x-faker": "finance.currencyCode"
},
"example": [
"EUR",
"CHF",
"GBP"
]
},
"bankName": {
"type": "string",
"description": "Identifier of the bank",
"example": "intesa_sanpaolo"
},
"owners": {
"type": "array",
"description": "List of owners of the bank account",
"items": {
"type": "string",
"description": "Name of the owner of the bank account",
"x-faker": "person.fullName"
},
"example": [
"Maria Fumagalli",
"Luigi Verdi"
]
},
"consentStatus": {
"$ref": "#/components/schemas/ConsentStatusEnum"
}
}
},
"Bulk": {
"type": "object",
"properties": {
"fingerprint": {
"$ref": "#/components/schemas/Fingerprint"
},
"amount": {
"type": "number",
"format": "double",
"example": 48223.07,
"description": "Total amount of the bulk"
},
"allowWireTranfersAggregation": {
"type": "boolean",
"example": true,
"description": "Indicate if the wire transfers to the same beneficiary can be aggregated"
},
"documents": {
"type": "object",
"description": "Dictionary of documents related to the bulk. Keys are the document type, values are the fingerprints of the documents.",
"additionalProperties": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fingerprint"
}
}
}
}
},
"Chain": {
"description": "Chain of documents",
"type": "object",
"properties": {
"fingerprint": {
"$ref": "#/components/schemas/Fingerprint"
},
"targetType": {
"$ref": "#/components/schemas/DocumentKindEnum"
},
"targetFingerprint": {
"$ref": "#/components/schemas/Fingerprint"
},
"triggerType": {
"$ref": "#/components/schemas/DocumentKindEnum"
},
"triggerFingerprint": {
"$ref": "#/components/schemas/Fingerprint"
}
}
},
"Checkout": {
"type": "object",
"properties": {
"code": {
"type": "string",
"pattern": "^[a-zA-Z\\d]{8}$",
"description": "Unique identifier of the checkout session. This code is secret and should never be shared with anyone who is not the payer."
},
"fingerprint": {
"$ref": "#/components/schemas/Fingerprint"
},
"type": {
"$ref": "#/components/schemas/DocumentKindEnum"
},
"creditor": {
"type": "string",
"format": "uuid",
"description": "Identifier of the creditor",
"x-faker": "datatype.uuid"
},
"debtor": {
"type": "string",
"format": "uuid",
"description": "Identifier of the debtor",
"x-faker": "datatype.uuid"
},
"collectionMethods": {
"type": "array",
"items": {
"$ref": "#/components/schemas/CollectionMethodEnum"
},
"description": "Collection methods enabled for the payment.<br>Note that collection methods are the intersection of the collection methods techologies enabled for the creditor and the collection methods allowed by the client for checkout."
},
"payments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Payment"
},
"description": "List of payments related to the checkout"
}
},
"required": [
"code",
"fingerprint",
"type",
"creditor",
"debtor",
"collectionMethods"
]
},
"ConsentStatusEnum": {
"type": "string",
"enum": [
"not_granted",
"granted",
"revoked",
"expired",
"all"
],
"default": "all",
"description": "Status of the account information service (AIS) consent granted by account owner to FlowPay.<br/> - `not_granted`: owner has never granted a consent<br> - `granted`: consent granted by account owner<br> - `revoked`: consent revoked by account owner<br> - `expired`: consent expired<br> - `all`: all types of consent"
},
"CollectionMethodEnum": {
"type": "string",
"enum": [
"sct",
"sct-inst",
"sdd",
"card",
"custom/<label>"
],
"description": "Collection method enabled for the payment. <br> - `sct`: SEPA Credit Transfer (SCT)<br> - `sct-inst`: SEPA Credit Transfer Instant (SCT-INST)<br> - `sdd`: SEPA Direct Debit (SDD)<br> - `card`: Credit Card<br> - `custom/label`: Custom collection method, enabled by the client who created the checkout. Please see the `custom` section for more details: https://docs.flowpay.it/docs/custom-collection-method"
},
"CompanyVATNumber": {
"type": "string",
"description": "VAT number of the company, full european format",
"pattern": "/^((AT)(U\\d{8})|(BE)(0\\d{9})|(BG)(\\d{9,10})|(CY)(\\d{8}[LX])|(CZ)(\\d{8,10})|(DE)(\\d{9})|(DK)(\\d{8})|(EE)(\\d{9})|(EL|GR)(\\d{9})|(ES)([\\dA-Z]\\d{7}[\\dA-Z])|(FI)(\\d{8})|(FR)([\\dA-Z]{2}\\d{9})|(HU)(\\d{8})|(IE)(\\d{7}[A-Z]{2})|(IT)(\\d{11})|(LT)(\\d{9}|\\d{12})|(LU)(\\d{8})|(LV)(\\d{11})|(MT)(\\d{8})|(NL)(\\d{9}(B\\d{2}|BO2))|(PL)(\\d{10})|(PT)(\\d{9})|(RO)(\\d{2,10})|(SE)(\\d{12})|(SI)(\\d{8})|(SK)(\\d{10}))$",
"example": "IT12345678901",
"x-faker": "finance.vat"
},
"ConstructionProgress": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the construction progress",
"x-faker": "datatype.uuid"
},
"site": {
"type": "string",
"format": "uuid",
"description": "Identifier of the construction site",
"x-faker": "datatype.uuid"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of the construction progress creation",
"example": "2020-01-01T00:00:00Z",
"x-faker": "date.past"
},
"amount": {
"type": "number",
"format": "float",
"example": 45050.23,
"description": "Total amount of the construction progress",
"x-faker": "finance.amount"
},
"invoices": {
"type": "object",
"description": "Array of invoices related to each supplier for the worker. Keys are the creditor identifiers.",
"additionalProperties": {
"$ref": "#/components/schemas/Fingerprint"
}
}
}
},
"ConstructionSite": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the construction site",
"x-faker": "datatype.uuid"
},
"name": {
"type": "string",
"description": "Name of the construction site",
"example": "Calenzano Payments Museum",
"x-faker": "lorem.word"
},
"address": {
"$ref": "#/components/schemas/Address"
},
"initialCreditFingerprint": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the initial credit document, used to transfer money to the wallet"
},
"availableBalance": {}
}
},
"ConsumerNationalID": {
"type": "string",
"description": "National ID of the consumer, currently only italian format is supported",
"pattern": "/^([A-Z]{6}\\d{2}[A-Z]\\d{2}[A-Z]\\d{3}[A-Z])$",
"example": "RSSMRA80A01H501T"
},
"Contact": {
"type": "object",
"properties": {
"fullName": {
"description": "Full name of the contact, contains the concatenation of the name and surname of a consumer, or the name of a company.",
"oneOf": [
{
"type": "string",
"description": "Full name of the consumer",
"example": "Mario Rossi",
"x-faker": "person.fullName"
},
{
"type": "string",
"description": "Company name",
"example": "Illustrious Company S.p.A.",
"x-faker": "company.companyName"
}
]
},
"fullVat": {
"type": "string",
"description": "VAT number of the company in full european format or national ID of the consumer ",
"oneOf": [
{
"$ref": "#/components/schemas/ConsumerNationalID"
},
{
"$ref": "#/components/schemas/CompanyVATNumber"
}
]
},
"type": {
"type": "string",
"enum": [
"consumer",
"company"
],
"description": "Type of the contact"
}
}
},
"DocumentKindEnum": {
"type": "string",
"enum": [
"bill",
"bulk",
"chain",
"construction",
"invoice",
"pagopa",
"transfer"
],
"description": {
"$ref": "types/DocumentKind.md"
}
},
"Fee": {
"type": "object",
"properties": {
"fingerprint": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the fee"
},
"amount": {
"type": "number",
"format": "double",
"minimum": 0,
"example": 0.5,
"description": "Amount of the fee"
},
"targetFingerprint": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the document the fee is related to"
},
"targetType": {
"$ref": "#/components/schemas/DocumentKindEnum",
"description": "Type of the document the fee is related to"
},
"ruleID": {
"type": "string",
"format": "uuid",
"description": "Identifier of the rule that generated the fee"
},
"linkedFingerprint": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the document the fee is linked to. Can be related to a `bulk` if the payer is the debtor of the target or to a `chain` if the payer is the creditor of the target."
}
}
},
"FeeRule": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the fee rule",
"x-faker": "datatype.uuid"
},
"clientID": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the client that created the rule",
"x-faker": "datatype.uuid"
},
"useCase": {
"$ref": "#/components/schemas/DocumentKindEnum",
"description": "Use case of the rule"
},
"method": {
"type": "string",
"enum": [
"pis",
"sdd",
"card"
],
"description": "Payment method the rule applies to"
},
"lowerBound": {
"type": "number",
"format": "double",
"description": "Lower bound of the rule. If the amount is lower than this value, the rule does not apply."
},
"kind": {
"type": "string",
"enum": [
"fixed",
"percentage"
],
"description": "Calculation method of the fee. <br> - `fixed`: the fee is a fixed amount<br> - `percentage`: the fee is a percentage of the target's amount"
},
"numeric": {
"type": "number",
"format": "double",
"description": "Value of the fee. If the kind is `percentage`, the value is a percentage of the target's amount and can assume values between 0 and 1."
},
"remittance": {
"type": "string",
"description": "Remittance information of the fee charged to the payer"
},
"payer": {
"type": "string",
"enum": [
"debtor",
"creditor"
],
"description": "Payer of the fee. <br> - `debtor`: the debtor of the target document pays the fee using a bulk<br> - `creditor`: the creditor of the target document pays the fee using a chain"
}
},
"required": [
"id",
"clientID",
"useCase",
"method",
"kind",
"numeric",
"payer",
"lowerBound"
]
},
"Fingerprint": {
"type": "string",
"description": "Fingerprint of the document",
"example": "d41d8cd98f00b204e9800998ecf8427e"
},
"Invoice": {
"type": "object",
"properties": {
"number": {
"type": "string",
"description": "Invoice number",
"x-faker": "finance.account"
},
"date": {
"type": "string",
"format": "iso8601",
"example": "2019-01-01T00:00:00Z",
"description": "Invoice date of issue",
"x-faker": "date.past"
},
"amount": {
"type": "number",
"description": "Invoice amount",
"x-faker": "finance.amount"
},
"currency": {
"type": "string",
"description": "Invoice currency",
"default": "EUR",
"x-faker": "finance.currencyCode"
},
"stage": {
"type": "string",
"enum": [
"proforma",
"invoice",
"creditNote"
],
"default": "invoice",
"description": "Invoice stage"
},
"type": {
"type": "string",
"enum": [
"b2b",
"b2c"
],
"description": "Invoice relations with the debtor. <br> - `b2b`: invoice issued to a business<br> - `b2c`: invoice issued to a private person. <br> Note:. Invoice relations with Public Administrations are not directly supported by FlowPay. However, you can use the `b2b` type to represent the invoice issued to a Public Administration."
},
"creditor": {
"type": "string",
"format": "uuid",
"description": "Identifier of the creditor",
"x-faker": "datatype.uuid"
},
"debtor": {
"type": "string",
"format": "uuid",
"description": "Identifier of the debtor",
"x-faker": "datatype.uuid"
},
"attachments": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentAttachment"
},
"description": "Attachments of the invoice"
},
"items": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentItem"
},
"description": "Items of the invoice"
},
"terms": {
"type": "array",
"items": {
"$ref": "#/components/schemas/DocumentTerm"
},
"description": "Terms of the invoice"
},
"invoice": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the invoice related to the proforma invoice or credit note, if any"
},
"proforma": {
"$ref": "#/components/schemas/Fingerprint",
"description": "Fingerprint of the proforma invoice related to the invoice, if any"
},
"creditNotes": {
"type": "array",
"items": {
"$ref": "#/components/schemas/Fingerprint"
},
"description": "Fingerprints of the credit notes related to the invoice, if any"
}
},
"description": "Document representing an invoice at any stage.",
"required": [
"number",
"date",
"amount",
"currency",
"stage",
"type",
"creditor",
"debtor",
"terms"
]
},
"KYCBankAccountDossier": {
"type": "object",
"properties": {
"iban": {
"type": "string",
"description": "IBAN of the bank account",
"x-faker": "finance.iban"
},
"label": {
"type": "string",
"description": "Label of the bank account",
"example": "My bank account"
},
"verified": {
"type": "boolean",
"description": "True if the ownership of the bank account has been verified"
},
"consentExpiresAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of the bank account PSD2 consent expiration",
"example": "2020-01-01T00:00:00Z",
"x-faker": "date.future"
}
}
},
"KYCCompanyDossier": {
"type": "object",
"description": "Company information",
"properties": {
"name": {
"type": "string",
"description": "Name of the company",
"example": "Illustrious Company S.p.A.",
"x-faker": "company.companyName"
},
"vat": {
"$ref": "#/components/schemas/CompanyVATNumber",
"description": "VAT number of the company"
},
"address": {
"$ref": "#/components/schemas/Address",
"description": "Address of the company"
},
"email": {
"type": "string",
"format": "email",
"description": "Email of the company",
"x-faker": "internet.email"
},
"phone": {
"type": "string",
"description": "Phone number of the company",
"example": "+393331234567",
"x-faker": "phone.phoneNumber"
},
"sanctioned": {
"type": "boolean",
"description": "True if the company is present in the list of sanctioned subjects"
},
"verified": {
"type": "boolean",
"description": "True if the company information has been verified"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KYCBankAccountDossier"
},
"description": "List of bank accounts of the company"
}
}
},
"KYCConsumerDossier": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the consumer",
"example": "Mario",
"x-faker": "person.firstName"
},
"surname": {
"type": "string",
"description": "Surname of the consumer",
"example": "Rossi",
"x-faker": "person.lastName"
},
"tin": {
"$ref": "#/components/schemas/ConsumerNationalID",
"description": "National ID of the consumer"
},
"birthDate": {
"type": "string",
"format": "date",
"description": "Date of birth of the consumer",
"example": "1980-01-01",
"x-faker": "date.past"
},
"birthPlace": {
"type": "string",
"description": "Place of birth of the consumer",
"example": "Milano",
"x-faker": "address.city"
},
"birthCountry": {
"type": "string",
"description": "Country of birth of the consumer",
"example": "IT",
"x-faker": "address.countryCode"
},
"address": {
"$ref": "#/components/schemas/Address",
"description": "Address of the consumer"
},
"email": {
"type": "string",
"format": "email",
"description": "Email of the consumer",
"x-faker": "internet.email"
},
"phone": {
"type": "string",
"description": "Phone number of the consumer",
"example": "+393331234567",
"x-faker": "phone.phoneNumber"
},
"sanctioned": {
"type": "boolean",
"description": "True if the consumer is present in the list of sanctioned subjects"
},
"verified": {
"type": "boolean",
"description": "True if the consumer information has been verified"
},
"accounts": {
"type": "array",
"items": {
"$ref": "#/components/schemas/KYCBankAccountDossier"
},
"description": "List of bank accounts of the consumer"
}
}
},
"KYCDossier": {
"type": "object",
"properties": {
"id": {
"type": "string",
"format": "uuid",
"description": "Unique identifier of the KYC session",
"x-faker": "datatype.uuid"
},
"createdAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of the KYC session creation",
"example": "2020-01-01T00:00:00Z",
"x-faker": "date.past"
},
"updatedAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of the last KYC session update",
"example": "2020-01-01T00:00:00Z",
"x-faker": "date.past"
},
"lastAccessAt": {
"type": "string",
"format": "date-time",
"description": "Date and time of the last KYC session access",
"example": "2020-01-01T00:00:00Z",
"x-faker": "date.past"
},
"kind": {
"$ref": "#/components/schemas/KYCFlow"
},
"canLogin": {
"type": "boolean",
"description": "True if the user can login to the KYC session. If true, the user can retrieve data verified in previous sessions and can skip some steps of the KYC flow.",
"default": false
},
"consumer": {
"$ref": "#/components/schemas/KYCConsumerDossier",
"description": "Consumer information"
},
"company": {
"$ref": "#/components/schemas/KYCCompanyDossier",
"description": "Company information"
}
}
},
"KYCFlow": {
"type": "string",
"description": "KYC flow",
"enum": [
"consumer",
"company",
"business"
]
},
"DocumentAttachment": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "Name of the attachment",
"example": "ITAAABBB99T99X999W_00003.xml.p7m",
"x-faker": "system.fileName"
},
"description": {
"type": "string",
"description": "Description of the attachment",
"example": "Electronic invoice signed with P7M format",
"x-faker": "lorem.sentence"
},
"id": {
"type": "string",
"format": "uuid",
"description": "Identifier of the attachment",
"example": "a0eebc99-9c0b-4ef8-bb6d-6bb9bd380a11",
"x-faker": "datatype.uuid"
}
},
"description": "Attachment of the document.",
"required": [
"name",
"id"
]
},
"DocumentItem": {
"type": "object",
"properties": {
"description": {
"type": "string",
"description": "Description of the item",
"example": "Super energy drink",
"x-faker": "lorem.sentence"
},
"quantity": {
"type": "number",
"format": "double",
"example": 8,
"description": "Quantity of the item",
"x-faker": "random.number"
},
"measureUnit": {
"type": "string",
"description": "Measure unit of the item",
"example": "L",
"maxLength": 10,
"x-faker": "commerce.productAdjective"
},
"unitPrice": {
"type": "number",
"format": "double",
"example": 1.5,