-
Notifications
You must be signed in to change notification settings - Fork 0
/
Copy pathopenapi.json
1144 lines (1144 loc) · 40.4 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": "HVP API Documentation",
"description": "Checkout the [Getting Started Tutorial](/docs/tutorials/intro) to get setup with the Allocations API.\n",
"version": "1.0.0"
},
"components": {
"securitySchemes": {
"ApiKeyAuth": { "type": "apiKey", "in": "header", "name": "X-API-KEY" }
},
"schemas": {
"SignaturePacket": {
"type": "object",
"properties": {
"accepted_intent_to_sign": {
"type": "boolean",
"description": "The user accepted an intent to electronically sign the agreement."
},
"accepted_electronic_business": {
"type": "boolean",
"description": "The user accepted to do business electronically."
},
"signer_ip_address": {
"type": "string",
"description": "The IP Address of the signer at the time of signing the agreement."
},
"signer_user_id": {
"type": "string",
"description": "The signer Allocations user ID."
},
"signer_email": {
"type": "string",
"description": "The email address of the signer at the time of signing the agreement."
},
"signature_date": {
"type": "string",
"description": "The date the signer signed the agreement."
}
}
},
"InvestmentAgreement": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The investment agreement's primary key."
},
"id": { "type": "string", "description": "A virtual of _id." },
"title": {
"type": "string",
"description": "The title of the agreement."
},
"investment_id": {
"type": "string",
"description": "The associated investment's id."
},
"signed": {
"type": "boolean",
"description": "Indicates if the agreement has been signed."
},
"type": {
"type": "string",
"enum": ["subscription-agreement", "side-letter"],
"description": "The type of agreement."
},
"md5": {
"type": "string",
"description": "Hash of the stored agreement useful for ensuring the stored file is stored correctly."
},
"s3_bucket": {
"type": "string",
"description": "S3 Bucket where the agreement is stored."
},
"s3_key": {
"type": "string",
"description": "S3 Key where the agreement is stored."
},
"signature_packet": {
"description": "Used to comply with e-signature laws.",
"type": "object",
"properties": {
"accepted_intent_to_sign": {
"type": "boolean",
"description": "The user accepted an intent to electronically sign the agreement."
},
"accepted_electronic_business": {
"type": "boolean",
"description": "The user accepted to do business electronically."
},
"signer_ip_address": {
"type": "string",
"description": "The IP Address of the signer at the time of signing the agreement."
},
"signer_user_id": {
"type": "string",
"description": "The signer Allocations user ID."
},
"signer_email": {
"type": "string",
"description": "The email address of the signer at the time of signing the agreement."
},
"signature_date": {
"type": "string",
"description": "The date the signer signed the agreement."
}
}
}
}
},
"Investment": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The investment's primary key."
},
"id": { "type": "string", "description": "A virtual of _id." },
"deal_id": {
"type": "string",
"description": "The investments associated deal's id."
},
"phase": {
"type": "string;",
"enum": [
"new",
"invited",
"kyc-pending",
"generate-agreements",
"agreements-pending",
"signed",
"wired",
"ach",
"complete",
"declined",
"failed"
],
"description": "The phase the investment is currently in."
},
"investor": {
"type": "object",
"description": "The investor associated with the investment.",
"properties": {
"passport_id": {
"type": "string",
"description": "The Investor Passport associated with the investor."
},
"type": {
"type": "string",
"enum": ["Entity", "Individual"],
"description": "The investor is an Entity or an Individual"
},
"name": {
"type": "string",
"description": "The name of the investor."
},
"signer": {
"type": "string",
"description": "The text to use for signing agreements."
},
"representative": {
"type": "string",
"description": "The name of the representative if the investor is an Entity."
},
"title": {
"type": "string",
"description": "The title of the representative if the investor is an Entity."
},
"email": {
"type": "string",
"description": "The email address of the investor."
}
}
},
"total_committed_amount": {
"type": "number",
"description": "The amount the investor committed to."
},
"side_letter": {
"type": "boolean",
"description": "The investor is issued a side letter changing the default terms of the deal."
},
"carry_fee": {
"type": "number",
"description": "The percentage carry charged by the SPV. Undefined if a custom carry fee is provided"
},
"custom_carry_fee": {
"type": "string",
"description": "Custom carry charged by the SPV. Undefined if carry fee is provided"
},
"management_fee": {
"type": "number",
"description": "The percentage management fee charged by the SPV. Undefined if a custom management fee is provided"
},
"custom_management_fee": {
"type": "string",
"description": "Custom management fee charged by the SPV. Undefined if management fee is provided"
},
"management_fee_frequency": {
"type": "string",
"enum": ["One-Time", "Annually"],
"description": "The frequency the management fee is charged."
},
"custom_fields": {
"type": "object",
"description": "Custom investment submission fields used to populate submission agreements."
},
"metadata": {
"type": "object",
"description": "Extra information to store with the investment."
},
"updated_at": {
"type": "string",
"description": "The last time the investment was updated."
},
"created_at": {
"type": "string",
"description": "The time the investment was created."
}
}
},
"W-9": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Investor's Street Address."
},
"city": {
"type": "string",
"description": "Investor's city of residence."
},
"state": {
"type": "string",
"description": "Investor's state of residence."
},
"postal_code": {
"type": "string",
"description": "Investor's postal code."
},
"tax_id": {
"type": "string",
"description": "Investor's tax id (SSN)."
}
}
},
"W-9-E": {
"type": "object",
"properties": {
"name": { "type": "string | null" },
"smllc_name": { "type": "string | null" },
"ssn": { "type": "string | null" },
"company_type": {
"type": "string",
"enum": [
"C Corporation",
"S Corporation",
"Partnership",
"Single-Member LLC",
"Trust or Estate",
"Limited Liability Company",
"Other"
]
},
"smllc_owner_name": { "type": "string" },
"company_type_name": { "type": "string" },
"taxed_as": {
"type": "string",
"enum": ["C Corporation", "S Corporation", "Partnership"]
},
"address": {
"type": "string",
"description": "Investor's Street Address."
},
"city": {
"type": "string",
"description": "Investor's city of residence."
},
"state": {
"type": "string",
"description": "Investor's state of residence."
},
"postal_code": {
"type": "string",
"description": "Investor's postal code."
},
"tax_id": {
"type": "string",
"description": "Investor's tax id (SSN)."
}
}
},
"W-8-BEN": {
"type": "object",
"properties": {
"address": {
"type": "string",
"description": "Investor's Street Address."
},
"city": {
"type": "string",
"description": "Investor's city of residence."
},
"region": { "type": "string" },
"postal_code": {
"type": "string",
"description": "Investor's postal code."
},
"residence_country": {
"type": "string",
"description": "Investor's country of residence."
},
"mailing_address": { "type": "string" },
"mailing_city": { "type": "string" },
"mailing_region": { "type": "string" },
"mailing_postal_code": { "type": "string" },
"mailing_country": { "type": "string" },
"tax_id": {
"type": "string",
"description": "Investor's tax id (EIN)."
},
"foreign_tax_id": { "type": "string" },
"treaty_country": { "type": "string" },
"treaty_article": { "type": "string" },
"treaty_withholding": { "type": "string" },
"treaty_income": { "type": "string" },
"treaty_conditions": { "type": "string" }
}
},
"W-8-BEN-E": {
"type": "object",
"properties": {
"disregarded_entity": { "type": "string" },
"chapter3_status": {
"type": "string",
"description": "Chapter 3 Selection (one only)",
"enum": [
"Simple trust",
"Central Bank of Issue",
"Grantor trust",
"Tax-exempt organization",
"Private foundation",
"Disregarded entity",
"Corporation",
"Complex trust",
"Estate",
"International organization",
"Partnership",
"Foreign Government - Controlled Entity",
"Foreign Government - Integral Part"
]
},
"chapter4_status": {
"type": "array",
"description": "Chapter 4 Selections (can be multiple)",
"items": {
"type": "string",
"enum": [
"Nonparticipating FFI (including an FFI related to a Reporting IGA FFI other than a deemed-compliant FFI",
"participating FFI",
"or exempt beneficial owner)",
"Participating FFI",
"Reporting Model 1 FFI",
"Reporting Model 2 FFI",
"Registered deemed-compliant FFI (other than a reporting Model 1 FFI",
"sponsored FFI",
"or nonreporting IGA FFI covered in Part XII). See instructions",
"Sponsored FFI. Complete Part IV",
"Certified deemed-compliant nonregistering local bank. Complete Part V",
"Certified deemed-compliant FFI with only low-value accounts. Complete Part VI",
"Certified deemed-compliant sponsored",
"closely held investment vehicle. Complete Part VII",
"Certified deemed-compliant limited life debt investment entity. Complete Part VIII",
"Certain investment entities that do not maintain financial accounts. Complete Part IX",
"Owner-documented FFI. Complete Part X",
"Restricted distributor. Complete Part XI",
"Nonreporting IGA FFI. Complete Part XII",
"Foreign government",
"government of a U.S. possession",
"or foreign central bank of issue. Complete Part XIII",
"International organization. Complete Part XIV",
"Exempt retirement plans. Complete Part XV",
"Entity wholly owned by exempt beneficial owners. Complete Part XVI",
"Territory financial institution. Complete Part XVII",
"Excepted nonfinancial group entity. Complete Part XVIII",
"Excepted nonfinancial start-up company. Complete Part XIX",
"Excepted nonfinancial entity in liquidation or bankruptcy. Complete Part XX",
"501(c) organization. Complete Part XXI",
"Nonprofit organization. Complete Part XXII",
"Publicly traded NFFE or NFFE affiliate of a publicly traded corporation. Complete Part XXIII",
"Excepted territory NFFE. Complete Part XXIV",
"Active NFFE. Complete Part XXV",
"Passive NFFE. Complete Part XXVI",
"Excepted inter-affiliate FFI. Complete Part XXVII",
"Direct reporting NFFE",
"Sponsored direct reporting NFFE. Complete Part XXVIII",
"Account that is not a financial account"
]
}
},
"address": {
"type": "string",
"description": "Investor's Street Address."
},
"city": {
"type": "string",
"description": "Investor's city of residence."
},
"region": { "type": "string" },
"postal_code": {
"type": "string",
"description": "Investor's postal code."
},
"residence_country": {
"type": "string",
"description": "Investor's country of residence."
},
"tax_id": {
"type": "string",
"description": "Investor's tax id (EIN)."
},
"foreign_tax_id": { "type": "string" }
}
},
"InvestorPassport": {
"type": "object",
"properties": {
"_id": {
"type": "string",
"description": "The investor passport's primary key."
},
"id": { "type": "string", "description": "A virtual of _id." },
"phase": {
"type": "string;",
"enum": [
"new",
"onboarding",
"kyc",
"review",
"rejected",
"failed",
"self-accredited"
],
"description": "The phase the investor passport is currently in."
},
"name": {
"type": "string",
"description": "The name of the Entity or Individual."
},
"type": {
"type": "string",
"enum": ["Entity", "Individual"],
"description": "The type of investor passport."
},
"title": {
"type": "string",
"description": "The title of the individual who represents the Entity."
},
"representative": {
"type": "string",
"description": "The name of the individual who represents the Entity."
},
"country": {
"type": "string",
"description": "The country of formation or residence."
},
"accreditation_type": {
"type": "string",
"description": "How the investor is accredited. See https://www.sec.gov/education/capitalraising/building-blocks/accredited-investor",
"enum": [
"NetWorthOver1m",
"SoloOver200k",
"JointOver300k",
"Certification",
"DirectorOfFund",
"KnowledgeableEmployee",
"EachOwnerAccredited",
"AssetsOver5m",
"AUM5m",
"InvestmentAdvisor",
"FinancialEntity"
]
},
"metadata": {
"type": "object",
"description": "Extra data to store with the investor passport."
}
}
}
}
},
"x-tagGroups": [
{
"name": "API",
"tags": [
"Investor Passport",
"Investment",
"Investment Agreement",
"Investor Passport Model"
]
}
],
"servers": [
{
"url": "https://api.allocations.app",
"description": "Production HVP API"
}
],
"paths": {
"/api/v1/investment-agreements/:id": {
"get": {
"deprecated": true,
"summary": "List Investment Agreements",
"description": "Get/filter a list of investment agreements (use [/api/v1/investments/:id/agreements](#tag/Investment/operation/getInvestmentAgreements)).",
"tags": ["Investment Agreement"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{
"in": "path",
"description": "Investment Id",
"required": true,
"name": "id",
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{ "$ref": "#/components/schemas/InvestmentAgreement" },
{
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to agreement document."
}
}
}
]
}
}
}
}
}
}
}
},
"/api/v1/investment-agreements/{id}/sign": {
"post": {
"summary": "Sign Investment Agreement",
"description": "Sign an investment agreement by id. Used to sign subscription agreements and side letters for an investor. You are required to present the signer with [Valid E-Signature](/docs/concepts/valid-e-signature).",
"tags": ["Investment Agreement"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Investment Agreement ID",
"required": true,
"schema": { "type": "string" }
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"accepted_intent_to_sign": {
"type": "boolean",
"description": "The user accepted an intent to electronically sign the agreement."
},
"accepted_electronic_business": {
"type": "boolean",
"description": "The user accepted to do business electronically."
},
"signer_ip_address": {
"type": "string",
"description": "The IP Address of the signer at the time of signing the agreement."
},
"signer_user_id": {
"type": "string",
"description": "The signer Allocations user ID."
},
"signer_email": {
"type": "string",
"description": "The email address of the signer at the time of signing the agreement."
},
"signature_date": {
"type": "string",
"description": "The date the signer signed the agreement."
}
},
"required": [
"accepted_intent_to_sign",
"accepted_electronic_business",
"signer_ip_address",
"signer_user_id",
"signer_email",
"signature_date"
]
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"_id": { "type": "string" },
"acknowledged": { "type": "boolean" }
}
}
}
}
}
}
}
},
"/api/v1/investments": {
"post": {
"summary": "Create Investment",
"description": "Create a new SPV Investment. This this requires an [Investor Passport](/docs/concepts/investor-passport) which represents the Individual or Entity investing in a deal.",
"tags": ["Investment"],
"security": [{ "ApiKeyAuth": [] }],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"deal_id": {
"type": "string",
"description": "The id of the deal that should be associated with the investment."
},
"passport_id": {
"type": "string",
"description": "The investor passport associated with the investor."
},
"investor_email": {
"type": "string",
"description": "The email address of the investor."
},
"total_committed_amount": {
"type": "number",
"description": "The total amount committed by the investor into the deal."
},
"carry_fee_percent": {
"type": "number",
"description": "The carry fee to use if a side_letter is issued."
},
"custom_carry_fee": {
"type": "string",
"description": "The custom carry fee to use if a side_letter is issued."
},
"management_fee_percent": {
"type": "number",
"description": "The management fee to use if a side_letter is issued."
},
"custom_management_fee": {
"type": "number",
"description": "The custom management fee to use if a side_letter is issued."
},
"management_fee_frequency": {
"type": "string",
"enum": ["One-Time", "Annually"],
"description": "The management fee frequency to use if a side_letter is issued."
},
"metadata": {
"type": "object",
"description": "Extra information to store with the investment."
}
},
"required": ["deal_id", "passport_id", "investor_email"]
}
}
}
},
"responses": {
"200": {
"description": "Investment Created",
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Investment" }
}
}
}
}
}
},
"/api/v1/investments/{id}": {
"get": {
"summary": "Get Investment",
"description": "Get a investment by id",
"tags": ["Investment"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{
"name": "id",
"in": "path",
"description": "Investment ID",
"required": true,
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": { "$ref": "#/components/schemas/Investment" }
}
}
}
}
}
},
"/api/v1/investments/:id/agreements": {
"get": {
"operationId": "getInvestmentAgreements",
"summary": "List Investment Agreements",
"description": "Get/filter a list of [Investment agreements](docs/concepts/investment-agreement) (e.g. subscription agreement). Use this to get investment agreements that have been signed or need to be signed to complete an investment.",
"tags": ["Investment"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{
"in": "path",
"description": "Investment Id",
"required": true,
"name": "id",
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": {
"allOf": [
{ "$ref": "#/components/schemas/InvestmentAgreement" },
{
"type": "object",
"properties": {
"link": {
"type": "string",
"description": "Link to agreement document."
}
}
}
]
}
}
}
}
}
}
}
},
"/api/v1/investor-passports": {
"post": {
"summary": "Create Investor Passport",
"description": "Create a new [Investor Passport](/docs/concepts/investor-passport). Investor Passports collect identifying information about an investor in order to KYC/KYB an investor and generate tax returns.",
"tags": ["Investor Passport"],
"security": [{ "ApiKeyAuth": [] }],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"name": {
"type": "string",
"description": "The name of the investor passport. Either the Entity's name or the Individual's name."
},
"type": {
"type": "string",
"enum": ["Entity", "Individual"],
"description": "Whether the passport is for an Entity or an Individual."
},
"title": {
"type": "string",
"description": "The title of the individual signing on behalf of an Entity."
},
"representative": {
"type": "string",
"description": "The name of the individual signing on behalf of the Entity."
},
"country": {
"type": "string",
"description": "The country of formation or residence."
},
"accreditation_type": {
"type": "string",
"description": "How the investor is accredited. See https://www.sec.gov/education/capitalraising/building-blocks/accredited-investor",
"enum": [
"NetWorthOver1m",
"SoloOver200k",
"JointOver300k",
"Certification",
"DirectorOfFund",
"KnowledgeableEmployee",
"EachOwnerAccredited",
"AssetsOver5m",
"AUM5m",
"InvestmentAdvisor",
"FinancialEntity"
]
},
"metadata": {
"type": "object",
"description": "Extra data to store with the investor passport."
}
},
"required": ["name", "type", "country", "accreditation_type"]
}
}
}
},
"responses": {
"200": {
"description": "Returns the created Investor Passport as well as the tax_form_fields required to create the correct tax form for the new investor passport",
"content": {
"application/json": {
"schema": {
"allOf": [
{ "$ref": "#/components/schemas/InvestorPassport" }
],
"properties": {
"tax_form_fields": {
"type": "object",
"oneOf": [
{ "$ref": "#/components/schemas/W-9" },
{ "$ref": "#/components/schemas/W-9-E" },
{ "$ref": "#/components/schemas/W-8-BEN" },
{ "$ref": "#/components/schemas/W-8-BEN-E" }
]
}
}
}
}
}
}
}
},
"get": {
"summary": "List Investor Passports",
"description": "Get/filter a list of [Investor Passports](/docs/concepts/investor-passports).",
"tags": ["Investor Passport"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{ "in": "query", "name": "name", "schema": { "type": "string" } },
{
"in": "query",
"name": "phase",
"schema": {
"type": "string",
"enum": [
"new",
"onboarding",
"kyc",
"review",
"rejected",
"failed",
"self-accredited"
]
}
},
{
"in": "query",
"name": "type",
"schema": { "type": "string", "enum": ["Entity", "Individual"] }
},
{ "in": "query", "name": "title", "schema": { "type": "string" } },
{
"in": "query",
"name": "representative",
"schema": { "type": "string" }
},
{ "in": "query", "name": "country", "schema": { "type": "string" } },
{
"in": "query",
"name": "accreditation_type",
"schema": { "type": "string" }
}
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"type": "array",
"items": { "$ref": "#/components/schemas/InvestorPassport" }
}
}
}
}
}
}
},
"/api/v1/investor-passports/{id}/tax-information": {
"post": {
"summary": "Complete Tax Information",
"description": "Add W8/W9 tax information to an existing investor passport. See more information [here](/docs/concepts/investor-passport#tax-information)\nTax Form Guidelines:\n * Use W-9 template if **investor is an Individual and the investor lives in the United States**\n * Use W-9-E template if **investor is an Entity and the investor lives in the United States**\n * Use W-BEN template if **investor is an Individual and the investor does not live in the United States**\n * Use W-BEN-E template if **investor is an Entity and the investor does not live in the United States**\n",
"parameters": [
{
"name": "id",
"in": "path",
"description": "InvestorPassport ID",
"required": true,
"schema": { "type": "string" }
}
],
"tags": ["Investor Passport"],
"security": [{ "ApiKeyAuth": [] }],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"type": "object",
"properties": {
"tax_form": {
"oneOf": [
{ "$ref": "#/components/schemas/W-9" },
{ "$ref": "#/components/schemas/W-9-E" },
{ "$ref": "#/components/schemas/W-8-BEN" },
{ "$ref": "#/components/schemas/W-8-BEN-E" }
]
},
"signature_packet": {
"type": "object",
"properties": {
"accepted_intent_to_sign": {
"type": "boolean",
"description": "The user accepted an intent to electronically sign the agreement."
},
"accepted_electronic_business": {
"type": "boolean",
"description": "The user accepted to do business electronically."
},
"signer_ip_address": {
"type": "string",
"description": "The IP Address of the signer at the time of signing the agreement."
},
"signer_user_id": {
"type": "string",
"description": "The signer Allocations user ID."
},
"signer_email": {
"type": "string",
"description": "The email address of the signer at the time of signing the agreement."
},
"signature_date": {
"type": "string",
"description": "The date the signer signed the agreement."
}
}
}
}
}
}
}
},
"responses": {
"200": {
"description": "W8/W9 successfully associated and stored",
"content": {
"application/json": {
"schema": {
"properties": {
"_id": { "type": "string" },
"acknowledged": { "type": "boolean" }
}
}
}
}
}
}
}
},
"/api/v1/investor-passports/{id}/upload-link/{type}": {
"post": {
"summary": "Upload Identifying Documents",
"description": "Retrieve a link to upload a Passport Asset associated with an Investor Passport (e.g. Government Issued Id). See more information [here](/docs/concepts/investor-passport#identifying-documents)",
"tags": ["Investor Passport"],
"security": [{ "ApiKeyAuth": [] }],
"parameters": [
{