-
Notifications
You must be signed in to change notification settings - Fork 0
/
openapi.json
19453 lines (19453 loc) · 622 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.0.2",
"info": {
"description": "Moov is a platform that enables developers to integrate all aspects of money movement with ease and speed. The Moov API makes it simple for platforms to send, receive, and store money. Our API is based upon REST principles, returns JSON responses, and uses standard HTTP response codes. To learn more about how Moov works at a high level, read our [concepts](https://docs.moov.io/guides/get-started/glossary/) guide.\n",
"version": "v1.0.0",
"title": "Moov API",
"contact": {
"name": "Moov Developer Support",
"email": "help@moov.io",
"url": "https://moov.io"
},
"license": {
"name": "Unlicensed",
"url": "http://www.apache.org/licenses/LICENSE-2.0.html"
},
"x-logo": {
"url": "https://moov.io/images/logo.png",
"altText": "Moov logo"
}
},
"servers": [
{
"url": "https://api.moov.io",
"description": "Production Environment"
}
],
"tags": [
{
"name": "API authentication",
"description": "For server-to-server communication, use your API key's public key and secret key with Basic authentication. When using Basic authentication, you don't need to send a scope.\n\nSet the Authorization header to `Basic <credentials>` where credentials is the Base64 encoding of public key and private key joined by a single colon `:`.\n"
},
{
"name": "Access token",
"description": "When making requests to Moov from a browser, you can use OAuth with JSON Web Tokens (JWT).\n\nOur authentication flow follows the OAuth 2.0 standard. With this endpoint, you'll [create an access token](/api/authentication/access-tokens/) that you will pass along with API requests or when initializing Moov.js. To generate an authentication token, you’ll need to specify [scopes](https://docs.moov.io/guides/developer-tools/scopes/) that enable the token to use a specific set of API endpoints. <br><br> If a scope is required, it will be listed in the description of the endpoint.\n"
},
{
"name": "Accounts",
"description": "[Accounts](https://docs.moov.io/guides/accounts/) represent a legal entity (either a business or an individual) in Moov. You can create an account for yourself or set up accounts for others, requesting different [capabilities](https://docs.moov.io/guides/accounts/capabilities/) depending on what you need to be able to do with that account. You can retrieve an account to get details on the business or individual account holder, such as an email address or employer identification number (EIN).\n\nBased on the type of account and its requested capabilities, we have certain [verification requirements](https://docs.moov.io/guides/accounts/identity-verification/). To see what capabilities that account has, you can use the [GET capability endpoint](https://docs.moov.io/api/moov-accounts/capabilities/get/).\n\nWhen you sign up for the Moov Dashboard, you will have a **facilitator account** which can be used to facilitate money movement between other accounts. A facilitator account will not show up in your list of accounts and cannot be created via API. To update your facilitator account information, use the settings page of the Moov Dashboard.\n\nYou can disconnect an account within the account's settings in the Moov Dashboard. This action cannot be undone. When an account is disconnected, the account's history and wallet is retained, but transfers cannot be submitted, and no actions can be taken on the account. See the [Dashboard](https://docs.moov.io/guides/dashboard/accounts/#disconnect-accounts) guide for more information. It is not possible to permanently delete an account.\n"
},
{
"name": "Analytics",
"description": "You can retrieve helpful at-a-glance information about your account by getting metrics on categories such as new accounts, transfer counts, and transfer volume over different time periods.\n"
},
{
"name": "Apple Pay",
"description": "Apple Pay offers a fast, easy, and secure way to accept card payments. The use of Apple Pay requires adherence to Apple's [guidelines](https://developer.apple.com/apple-pay/acceptable-use-guidelines-for-websites/) and [server requirements](https://developer.apple.com/documentation/apple_pay_on_the_web/setting_up_your_server). See our step-by-step [Apple Pay](https://docs.moov.io/guides/sources/cards/apple-pay/) guide for more information.\n"
},
{
"name": "Application",
"description": "An application allows an account to connect to other accounts and gain access to their information and move money on their behalf.\n"
},
{
"name": "Avatars",
"description": "You can retrieve an account's profile image. This is especially useful if you'd like to use the profile image for a corresponding account in your own product.\n"
},
{
"name": "Bank accounts",
"description": "To transfer money with Moov, you’ll need to link a bank account to your Moov account, then verify that account. You can link a bank account to a Moov account by providing the bank account number, routing number, and Moov account ID.\n\nWe require micro-deposit verification to reduce the risk of fraud or unauthorized activity. You can verify a bank account by initiating [micro-deposits](https://docs.moov.io/guides/sources/bank-accounts/#micro-deposit-verification), sending two small credit transfers to the bank account you want to confirm. Note that there is no way to initiate a micro-deposit from your bank of choice.\n\nYou can simulate bank account payment methods in test mode. See our [test mode](https://docs.moov.io/guides/get-started/test-mode/#bank-accounts) guide for more information.\n\nAlternatively, you can link and verify a bank account in one step through an instant account verification token from a third party provider like [Plaid](https://docs.moov.io/guides/sources/bank-accounts/verification/plaid/) or [MX](https://docs.moov.io/guides/sources/bank-accounts/verification/mx/). Bank accounts can have the following statuses: `new`, `pending`, `verified`, `verificationFailed`, `errored`. Learn more by reading our guide on [bank accounts](https://docs.moov.io/guides/sources/bank-accounts/).\n"
},
{
"name": "Capabilities",
"description": "Capabilities determine what a Moov account can do. Each capability has specific [requirements](https://docs.moov.io/guides/accounts/capabilities/requirements/), depending on risk and compliance standards associated with different account activities. For example, there are more information requirements for a business that wants to charge other accounts than for an individual who simply wants to receive funds.\n\nWhen you request a capability, we list the information requirements for that capability. Once you submit the required information, we need to verify the data. Because of this, a requested capability may not immediately become active. Note, if an account requests and is approved for `send-funds` or `collect-funds`, the `wallet` capability is automatically enabled as well. For more detailed information on capabilities and capability IDs, read our [capabilities guide](https://docs.moov.io/guides/accounts/capabilities/).\n"
},
{
"name": "Card issuing",
"x-displayName": "Cards",
"description": "A Moov wallet can serve as a funding source for issuing virtual cards. Note that we currently only issue Visa cards. Virtual cards can then be used to spend funds from the wallet.\n\n<em> The `card-issuing` and `wallet` capabilities are required to be enabled before any card issuing functionality is available. Moov is in a private beta with select customers for card issuing.</em>\n"
},
{
"name": "Cards",
"description": "You can link credit or debit cards to Moov accounts. You can use a card as a source for making transfers, which charges the card. To link a card to a Moov account and avoid some of the burden of PCI compliance, use the [card link Moov Drop](https://docs.moov.io/moovjs/drops/card-link). You cannot add a card via the Dashboard. If you're linking a card via API, you must provide Moov with a copy of your PCI attestation of compliance. When testing cards, use the designated [card numbers for test mode](https://docs.moov.io/guides/set-up-your-account/test-mode/#card-acceptance). You must contact Moov before going live in production with cards. Read our guide on [cards](https://docs.moov.io/guides/sources/cards/) for more information."
},
{
"name": "Checkout",
"description": "<b>Coming soon -</b> Hosted checkout.\n"
},
{
"name": "Connections",
"description": "A connection forms a relationship between two accounts, allowing them to transact with each other. When you create an account for someone else, your account automatically has a connection with the account you've just created."
},
{
"name": "Disputes",
"description": "A [dispute](https://docs.moov.io/guides/money-movement/cards/disputes/) is a situation where a cardholder formally questions a transaction on their account with their card issuer. This could be for a number of reasons ranging from billing errors to fraudulent activity or dissatisfactory goods/services. If the dispute is recognized as legitimate, the issuer will reverse the payment (otherwise known as a chargeback).\n\nYou can simulate disputes, including winning or losing a dispute, in test mode. See our [test mode](https://docs.moov.io/guides/get-started/test-mode/#disputes) guide for more information.\n"
},
{
"name": "Email/Password",
"description": "Authentication via using a email and password."
},
{
"name": "End to End Encryption",
"description": "Allows for the passing of secure authentication data through an unverified proxies.\n"
},
{
"name": "Enriched address",
"description": "Search for valid addresses using a partial or full address.\n"
},
{
"name": "Enriched profile",
"description": "By supplying an email address, you can retrieve a profile with enriched data fields. This service is offered in collaboration with Clearbit.\n"
},
{
"name": "Fee Plans",
"description": "Moov offers multiple fee plans. You can view the fee plans available to your account, and assign them to your connected accounts.\n"
},
{
"name": "Files",
"description": "Files can be used for a multitude of different use cases including but not limited to, individual identity verification and business underwriting. You may need to provide documentation to enable capabilities or to keep capabilities enabled for an account. The maximum file size is 10MB. Each account is allowed a maximum of 50 files. Acceptable file types include csv, jpg, pdf, and png. To learn about uploading files in the Moov Dashboard, read our [file upload guide](https://docs.moov.io/guides/dashboard/accounts/#file-upload).\n"
},
{
"name": "Industries",
"description": "Information about industries and their merchant codes.\n"
},
{
"name": "Institutions",
"description": "Lookup ACH and wire participating financial institutions. We recommend using this endpoint when an end-user enters a routing number to confirm their bank or credit union.\n"
},
{
"name": "Money movement",
"description": "Transfer allow you Moov money\n"
},
{
"name": "Moov internal",
"description": "Meant for internal use by Moov",
"x-traitTag": true
},
{
"name": "Multi-factor",
"description": "We require users to multi factor in when using a new device.\n"
},
{
"name": "Onboarding",
"description": "<b>Coming soon -</b> Invite organizations to onboard with Moov. Create an invitation containing a unique link that allows the recipient to provide data necessary to fulfill capability requirements, agree to pricing, and accept Moov's terms.\n\nYou can create and send an onboarding link directly from the Moov Dashboard. See our [documentation](https://docs.moov.io/guides/accounts/hosted-onboarding/) for details.\n"
},
{
"name": "Open ID Connect",
"description": "Details on Moov's open id connect implementation"
},
{
"name": "Payment methods",
"description": "[Payment methods](https://docs.moov.io/guides/money-movement/payment-methods/) represent all of the ways an account can move funds to another Moov account. Payment methods are generated programmatically when a card or bank account is added or the status is updated e.g., `ach-debit-fund` will be added as a payment method once the bank account is verified.\n\n<em>RTP® and Push to Card are not yet generally available on Moov. Contact us for more information.</em>\n"
},
{
"name": "Refunds",
"description": "We strongly suggest using the /reversals endpoint for its functionality and enhanced flexibility when dealing with refunds (the /refunds endpoint is still supported).\n\nA reversal will dynamically orchestrate a cancellation or refund based on the status of settlement process. A cancellation occurs if the transfer has not been settled. A refund occurs if the transfer is in the process of settling, or has already been settled.\n\nA reversal cannot exceed the original transfer amount, and once the reversal process has started, it cannot be canceled.\n"
},
{
"name": "Representatives",
"description": "We think of a representative as an individual who can take major actions on behalf of a business. A representative can be the business owner, or anyone who owns 25% or more of the business. Some examples of representatives are the CEO, CFO, COO, or president. We require all business accounts to have valid information for at least one representative. Moov accounts must have verified business representatives before a business account can send funds, collect money from other accounts, or store funds in a wallet. To learn more, read our guide on [business representatives](https://docs.moov.io/guides/accounts/business-representatives/).\n"
},
{
"name": "Schedules",
"description": "Set up future transfers through scheduling.\n"
},
{
"name": "Signup",
"description": "How to sign a user up via app.moov.io"
},
{
"name": "Transfers",
"description": "A [transfer](https://docs.moov.io/guides/money-movement/) is the movement of money between Moov accounts, from source to destination. You can initiate a transfer to another Moov account as long as there is a linked and verified payment method.\n\nWith Moov, you can also implement transfer groups, allowing you to associate multiple transfers together and run them sequentially. To learn more, read our guide on [transfer groups](https://docs.moov.io/guides/money-movement/transfer-groups/#transfer-statuses).\n\nYou can simulate various RTP, push to card, ACH, and declined transfer scenarios in test mode. See our [test mode](https://docs.moov.io/guides/get-started/test-mode/#transfers) guide for more information.\n"
},
{
"name": "Underwriting",
"description": "[Underwriting](https://docs.moov.io/guides/accounts/underwriting) is a tool Moov uses to understand a business’s profile before allowing them to collect funds on our platform. This profile includes information like a description of the company or the merchant’s business model, the industry they operate in, and transaction volume. Through underwriting, we can understand and prevent unnecessary financial risk for Moov and those transacting on our platform. Note that underwriting can be instant, but in some cases make take around 2 business days before approval.\n"
},
{
"name": "User invites",
"description": "This allows app.moov.io invite new users to an account.\n"
},
{
"name": "Users",
"description": "Users are lightweight objects that handle signing in to our app.moov.io\n"
},
{
"name": "Wallet transactions",
"description": "Wallet transactions provide insight into funds that move in and out of an account’s wallet. For each Moov transfer, we create a corresponding transaction that represents how that initial source impacted a wallet. Read more about [wallet transactions](https://docs.moov.io/guides/wallets/transactions).\n"
},
{
"name": "Wallets",
"description": "A [Moov wallet](https://docs.moov.io/guides/wallet/) can serve as a funding source as you accumulate funds. You can also use the Moov wallet to:\n - Pre-fund transfers for faster payouts\n - Transfer funds between Moov wallets for instantly available funds\n\n <em> If you've requested the `send-funds` or `collect-funds` capability, the `wallet` capability will be automatically requested as well. Read more on the [data requirements for wallets here](https://docs.moov.io/guides/accounts/capabilities/#wallet).</em>\n"
}
],
"x-tagGroups": [
{
"name": "Authentication",
"tags": [
"API authentication",
"Access token",
"Ping",
"End to End Encryption"
]
},
{
"name": "Moov accounts",
"tags": [
"Accounts",
"Representatives",
"Capabilities",
"Files",
"Underwriting",
"Onboarding",
"Fee Plans",
"Branding"
]
},
{
"name": "Sources",
"tags": [
"Bank accounts",
"Cards",
"Payment methods"
]
},
{
"name": "Money movement",
"tags": [
"Transfers",
"Disputes",
"Schedules"
]
},
{
"name": "Wallets",
"tags": [
"Wallets",
"Wallet transactions",
"Sweeps"
]
},
{
"name": "Card issuing",
"tags": [
"Card issuing"
]
},
{
"name": "Analytics",
"tags": [
"Analytics"
]
},
{
"name": "Institution lookup",
"tags": [
"Institutions"
]
},
{
"name": "Enrichment",
"tags": [
"Avatars",
"Enriched address",
"Enriched profile",
"Industries"
]
},
{
"name": "Moov internal",
"tags": [
"Signup",
"Email/Password",
"Multi-factor",
"Session",
"Verification",
"Devices",
"Open ID Connect",
"Connections",
"Users",
"Roles",
"Invites",
"Application",
"Webhooks",
"Events",
"Ping",
"User invites",
"Checkout"
]
}
],
"paths": {
"/signup": {
"post": {
"summary": "Self signup",
"operationId": "selfSignup",
"description": "Allows a user to sign themselves up off the website. They will receive an email allowing them to create an user to signin with.",
"tags": [
"Signup"
],
"requestBody": {
"description": "Values to register with",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Signup"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/password": {
"post": {
"summary": "Signin a user with email & password",
"operationId": "SigninWithPassword",
"description": "Allows a user to signin with a password",
"tags": [
"Email/Password"
],
"requestBody": {
"description": "Values to register with",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Signin"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": "The user successfully signed in"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/password/register": {
"post": {
"summary": "Register user with password",
"operationId": "setupPassword",
"description": "Sets up password authentication",
"tags": [
"Email/Password"
],
"requestBody": {
"description": "Values to register with",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Setup"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/User"
}
}
},
"description": "The user successfully registered"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/password/change-password": {
"post": {
"summary": "Change password",
"operationId": "ChangePassword",
"description": "Allows a user to change their password",
"tags": [
"Email/Password"
],
"requestBody": {
"description": "Current password and new",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ChangePassword"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/password/recover": {
"post": {
"summary": "Recover password",
"operationId": "RecoverPassword",
"description": "Allows a user recover their account via an email flow",
"tags": [
"Email/Password"
],
"requestBody": {
"description": "Email to send recovery instructions to",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Recover"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/password/recover/reset-password": {
"post": {
"summary": "Set password for recovery",
"operationId": "ResetPassword",
"description": "Allows the user to set a password after recovering their account",
"tags": [
"Email/Password"
],
"requestBody": {
"description": "Email to send recovery instructions to",
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ResetPassword"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/oidc/{providerID}": {
"get": {
"summary": "Authenticate with OIDC Provider",
"description": "Initiates the authentication with the Provider specified by `providerID`.\nThis will redirect to the provider who will authenticate the user. Once the provider has authenticated \nthe user it will redirect them back to us on the `/callback` url.\n",
"operationId": "OIDCAuthentication",
"tags": [
"Open ID Connect"
],
"parameters": [
{
"$ref": "#/components/parameters/ProviderID"
}
],
"responses": {
"302": {
"description": "If using the OpenID Connect or OAuth 2.0 provider it issues a redirect to the providers page.\n",
"headers": {
"Location": {
"schema": {
"$ref": "#/components/schemas/URL"
}
}
},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "",
"maxLength": 0,
"pattern": "\\s{0}"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/signin/oidc/{providerID}/callback": {
"get": {
"summary": "Callback from OIDC Provider",
"description": "This is called by the users browser once their OpenID Connect provider has authenticated the user. The \nOIDC provider will send tokens we inspect and use to obtain their information and log them into the system.\n",
"operationId": "OIDCCallback",
"tags": [
"Open ID Connect"
],
"parameters": [
{
"$ref": "#/components/parameters/ProviderID"
}
],
"responses": {
"302": {
"description": "Redirects to where we want to send the user to handle verification of device\n",
"headers": {
"Location": {
"schema": {
"$ref": "#/components/schemas/URL"
}
}
},
"content": {
"text/plain": {
"schema": {
"type": "string",
"example": "",
"maxLength": 0,
"pattern": "\\s{0}"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/verify": {
"post": {
"summary": "Device verification",
"description": "Checks to ensure a device is verified and if not how to go about getting it verified",
"operationId": "isDeviceVerified",
"tags": [
"Verification"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInfo"
}
}
}
},
"responses": {
"200": {
"description": "Devices",
"content": {
"application/json": {
"schema": {
"type": "array",
"maxItems": 300,
"items": {
"$ref": "#/components/schemas/DeviceVerification"
}
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/verify/email": {
"post": {
"summary": "Device verification",
"description": "Checks to ensure a device is verified and if not how to go about getting it verified",
"operationId": "checkVerificationCodeFromEmail",
"tags": [
"Verification"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/VerifyViaEmail"
}
}
}
},
"responses": {
"200": {
"description": "Devices",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceVerification"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/auth/verify/email/send": {
"post": {
"summary": "Send code via email",
"description": "Send device verification code via email to the email address of the user",
"operationId": "sendVerificationCodeViaEmail",
"tags": [
"Verification"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendViaEmail"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/Empty"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/oauth2/token": {
"post": {
"operationId": "CreateOAuth2Token",
"summary": "Create access token",
"description": "Use the `client_id` and `client_secret` to generate an access token.",
"tags": [
"Access token"
],
"security": [
{
"OAuth2Credentials": []
}
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/ClientCredentialsGrantToAccessTokenRequest"
}
},
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/ClientCredentialsGrantToAccessTokenRequest"
}
}
}
},
"responses": {
"200": {
"description": "Successfully exchanged the code to create a token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessTokenResponse"
}
}
}
},
"400": {
"description": "Failure create token",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/AccessTokenErrorResponse"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/oauth2/revoke": {
"post": {
"operationId": "RevokeOAuth2Token",
"summary": "Revoke access token",
"description": "Allows clients to notify the authorization server that a previously obtained refresh or access token is no longer needed",
"tags": [
"Access token"
],
"security": [
{
"OAuth2Credentials": []
}
],
"requestBody": {
"required": true,
"content": {
"application/x-www-form-urlencoded": {
"schema": {
"$ref": "#/components/schemas/RevokeTokenRequest"
}
}
}
},
"responses": {
"204": {
"$ref": "#/components/responses/NoContent"
},
"400": {
"description": "Failed to revoke token"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/session": {
"get": {
"summary": "Get current session information",
"operationId": "getSession",
"description": "Returns session information if still valid",
"tags": [
"Session"
],
"responses": {
"200": {
"description": "session information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session"
}
}
}
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
},
"delete": {
"summary": "Delete this session and logout",
"operationId": "disableSession",
"description": "Logs out of the current session and disables it",
"tags": [
"Session"
],
"responses": {
"204": {
"$ref": "#/components/responses/Empty"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/session-refresh": {
"post": {
"summary": "Refresh Cookie",
"description": "Refresh the cookie to keep a user logged in",
"operationId": "refreshSession",
"tags": [
"Devices"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/DeviceInfo"
}
}
}
},
"responses": {
"200": {
"description": "session information",
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Session"
}
}
}
},
"401": {
"description": "No authentication or it has expired"
},
"404": {
"description": "No session found"
}
}
}
},
"/invites": {
"parameters": [
{
"$ref": "#/components/parameters/XAccountID"
}
],
"get": {
"summary": "List invites",
"description": "List outstanding invites for an account",
"operationId": "listInvites",
"tags": [
"Invites"
],
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"items": {
"$ref": "#/components/schemas/Invite"
},
"maxItems": 300,
"type": "array"
}
}
},
"description": "Invites that are outstanding"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
},
"post": {
"summary": "Send invite",
"description": "Send an email invite to a user",
"operationId": "sendInvite",
"tags": [
"Invites"
],
"requestBody": {
"required": true,
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/SendInvite"
}
}
}
},
"responses": {
"200": {
"content": {
"application/json": {
"schema": {
"$ref": "#/components/schemas/Invite"
}
}
},
"description": "Invite sent"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/invites/{inviteID}": {
"delete": {
"summary": "Disable invite",
"description": "Revoke an invite that was sent and invalidate the token.",
"operationId": "disableInvite",
"tags": [
"Invites"
],
"parameters": [
{
"in": "path",
"name": "inviteID",
"required": true,
"description": "InviteID of the invite to disable",
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"204": {
"description": "Invite was removed"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}
}
},
"/invites/{inviteID}/accept": {
"put": {
"summary": "Accept invite",
"description": "Accept an invite and add user to the account",
"operationId": "acceptInvite",
"tags": [
"Invites"
],
"parameters": [
{
"in": "path",
"name": "inviteID",
"required": true,
"description": "InviteID of the invite to accept",
"schema": {
"$ref": "#/components/schemas/UUID"
}
}
],
"responses": {
"200": {
"description": "Invite was accepted"
},
"429": {
"$ref": "#/components/responses/RateLimited"
},
"default": {
"$ref": "#/components/responses/Empty"
}
}